blob: 6970f55daf54341f307a5052eb44b9e2d039ead8 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/fs/locks.c
4 *
5 * Provide support for fcntl()'s F_GETLK, F_SETLK, and F_SETLKW calls.
6 * Doug Evans (dje@spiff.uucp), August 07, 1992
7 *
8 * Deadlock detection added.
9 * FIXME: one thing isn't handled yet:
10 * - mandatory locks (requires lots of changes elsewhere)
11 * Kelly Carmichael (kelly@[142.24.8.65]), September 17, 1994.
12 *
13 * Miscellaneous edits, and a total rewrite of posix_lock_file() code.
14 * Kai Petzke (wpp@marie.physik.tu-berlin.de), 1994
NeilBrown7bbd1fc2018-11-30 10:04:08 +110015 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 * Converted file_lock_table to a linked list from an array, which eliminates
17 * the limits on how many active file locks are open.
18 * Chad Page (pageone@netcom.com), November 27, 1994
NeilBrown7bbd1fc2018-11-30 10:04:08 +110019 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070020 * Removed dependency on file descriptors. dup()'ed file descriptors now
21 * get the same locks as the original file descriptors, and a close() on
22 * any file descriptor removes ALL the locks on the file for the current
23 * process. Since locks still depend on the process id, locks are inherited
24 * after an exec() but not after a fork(). This agrees with POSIX, and both
25 * BSD and SVR4 practice.
26 * Andy Walker (andy@lysaker.kvaerner.no), February 14, 1995
27 *
28 * Scrapped free list which is redundant now that we allocate locks
29 * dynamically with kmalloc()/kfree().
30 * Andy Walker (andy@lysaker.kvaerner.no), February 21, 1995
31 *
32 * Implemented two lock personalities - FL_FLOCK and FL_POSIX.
33 *
34 * FL_POSIX locks are created with calls to fcntl() and lockf() through the
35 * fcntl() system call. They have the semantics described above.
36 *
37 * FL_FLOCK locks are created with calls to flock(), through the flock()
38 * system call, which is new. Old C libraries implement flock() via fcntl()
39 * and will continue to use the old, broken implementation.
40 *
41 * FL_FLOCK locks follow the 4.4 BSD flock() semantics. They are associated
42 * with a file pointer (filp). As a result they can be shared by a parent
43 * process and its children after a fork(). They are removed when the last
44 * file descriptor referring to the file pointer is closed (unless explicitly
NeilBrown7bbd1fc2018-11-30 10:04:08 +110045 * unlocked).
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 *
47 * FL_FLOCK locks never deadlock, an existing lock is always removed before
48 * upgrading from shared to exclusive (or vice versa). When this happens
49 * any processes blocked by the current lock are woken up and allowed to
50 * run before the new lock is applied.
51 * Andy Walker (andy@lysaker.kvaerner.no), June 09, 1995
52 *
53 * Removed some race conditions in flock_lock_file(), marked other possible
NeilBrown7bbd1fc2018-11-30 10:04:08 +110054 * races. Just grep for FIXME to see them.
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 * Dmitry Gorodchanin (pgmdsg@ibi.com), February 09, 1996.
56 *
57 * Addressed Dmitry's concerns. Deadlock checking no longer recursive.
58 * Lock allocation changed to GFP_ATOMIC as we can't afford to sleep
59 * once we've checked for blocking and deadlocking.
60 * Andy Walker (andy@lysaker.kvaerner.no), April 03, 1996.
61 *
62 * Initial implementation of mandatory locks. SunOS turned out to be
63 * a rotten model, so I implemented the "obvious" semantics.
Paul Bolle395cf962011-08-15 02:02:26 +020064 * See 'Documentation/filesystems/mandatory-locking.txt' for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 * Andy Walker (andy@lysaker.kvaerner.no), April 06, 1996.
66 *
67 * Don't allow mandatory locks on mmap()'ed files. Added simple functions to
68 * check if a file has mandatory locks, used by mmap(), open() and creat() to
69 * see if system call should be rejected. Ref. HP-UX/SunOS/Solaris Reference
70 * Manual, Section 2.
71 * Andy Walker (andy@lysaker.kvaerner.no), April 09, 1996.
72 *
73 * Tidied up block list handling. Added '/proc/locks' interface.
74 * Andy Walker (andy@lysaker.kvaerner.no), April 24, 1996.
75 *
76 * Fixed deadlock condition for pathological code that mixes calls to
77 * flock() and fcntl().
78 * Andy Walker (andy@lysaker.kvaerner.no), April 29, 1996.
79 *
80 * Allow only one type of locking scheme (FL_POSIX or FL_FLOCK) to be in use
81 * for a given file at a time. Changed the CONFIG_LOCK_MANDATORY scheme to
82 * guarantee sensible behaviour in the case where file system modules might
83 * be compiled with different options than the kernel itself.
84 * Andy Walker (andy@lysaker.kvaerner.no), May 15, 1996.
85 *
86 * Added a couple of missing wake_up() calls. Thanks to Thomas Meckel
87 * (Thomas.Meckel@mni.fh-giessen.de) for spotting this.
88 * Andy Walker (andy@lysaker.kvaerner.no), May 15, 1996.
89 *
90 * Changed FL_POSIX locks to use the block list in the same way as FL_FLOCK
91 * locks. Changed process synchronisation to avoid dereferencing locks that
92 * have already been freed.
93 * Andy Walker (andy@lysaker.kvaerner.no), Sep 21, 1996.
94 *
95 * Made the block list a circular list to minimise searching in the list.
96 * Andy Walker (andy@lysaker.kvaerner.no), Sep 25, 1996.
97 *
98 * Made mandatory locking a mount option. Default is not to allow mandatory
99 * locking.
100 * Andy Walker (andy@lysaker.kvaerner.no), Oct 04, 1996.
101 *
102 * Some adaptations for NFS support.
103 * Olaf Kirch (okir@monad.swb.de), Dec 1996,
104 *
105 * Fixed /proc/locks interface so that we can't overrun the buffer we are handed.
106 * Andy Walker (andy@lysaker.kvaerner.no), May 12, 1997.
107 *
108 * Use slab allocator instead of kmalloc/kfree.
109 * Use generic list implementation from <linux/list.h>.
110 * Sped up posix_locks_deadlock by only considering blocked locks.
111 * Matthew Wilcox <willy@debian.org>, March, 2000.
112 *
113 * Leases and LOCK_MAND
114 * Matthew Wilcox <willy@debian.org>, June, 2000.
115 * Stephen Rothwell <sfr@canb.auug.org.au>, June, 2000.
NeilBrownfd7732e2018-11-30 10:04:08 +1100116 *
117 * Locking conflicts and dependencies:
118 * If multiple threads attempt to lock the same byte (or flock the same file)
119 * only one can be granted the lock, and other must wait their turn.
120 * The first lock has been "applied" or "granted", the others are "waiting"
121 * and are "blocked" by the "applied" lock..
122 *
123 * Waiting and applied locks are all kept in trees whose properties are:
124 *
125 * - the root of a tree may be an applied or waiting lock.
126 * - every other node in the tree is a waiting lock that
127 * conflicts with every ancestor of that node.
128 *
129 * Every such tree begins life as a waiting singleton which obviously
130 * satisfies the above properties.
131 *
132 * The only ways we modify trees preserve these properties:
133 *
134 * 1. We may add a new leaf node, but only after first verifying that it
135 * conflicts with all of its ancestors.
136 * 2. We may remove the root of a tree, creating a new singleton
137 * tree from the root and N new trees rooted in the immediate
138 * children.
139 * 3. If the root of a tree is not currently an applied lock, we may
140 * apply it (if possible).
141 * 4. We may upgrade the root of the tree (either extend its range,
142 * or upgrade its entire range from read to write).
143 *
144 * When an applied lock is modified in a way that reduces or downgrades any
145 * part of its range, we remove all its children (2 above). This particularly
146 * happens when a lock is unlocked.
147 *
148 * For each of those child trees we "wake up" the thread which is
149 * waiting for the lock so it can continue handling as follows: if the
150 * root of the tree applies, we do so (3). If it doesn't, it must
151 * conflict with some applied lock. We remove (wake up) all of its children
152 * (2), and add it is a new leaf to the tree rooted in the applied
153 * lock (1). We then repeat the process recursively with those
154 * children.
155 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 */
157
158#include <linux/capability.h>
159#include <linux/file.h>
Al Viro9f3acc32008-04-24 07:44:08 -0400160#include <linux/fdtable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161#include <linux/fs.h>
162#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163#include <linux/security.h>
164#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165#include <linux/syscalls.h>
166#include <linux/time.h>
Dipankar Sarma4fb3a532005-09-16 19:28:13 -0700167#include <linux/rcupdate.h>
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000168#include <linux/pid_namespace.h>
Jeff Layton48f74182013-06-21 08:58:18 -0400169#include <linux/hashtable.h>
Jeff Layton7012b022013-06-21 08:58:22 -0400170#include <linux/percpu.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
Jeff Layton62af4f12014-05-09 14:13:05 -0400172#define CREATE_TRACE_POINTS
173#include <trace/events/filelock.h>
174
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -0800175#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177#define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
178#define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
Christoph Hellwig11afe9f2015-01-21 19:17:03 +0100179#define IS_LEASE(fl) (fl->fl_flags & (FL_LEASE|FL_DELEG|FL_LAYOUT))
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400180#define IS_OFDLCK(fl) (fl->fl_flags & FL_OFDLCK)
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -0400181#define IS_REMOTELCK(fl) (fl->fl_pid <= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400183static bool lease_breaking(struct file_lock *fl)
184{
J. Bruce Fields778fc542011-07-26 18:25:49 -0400185 return fl->fl_flags & (FL_UNLOCK_PENDING | FL_DOWNGRADE_PENDING);
186}
187
188static int target_leasetype(struct file_lock *fl)
189{
190 if (fl->fl_flags & FL_UNLOCK_PENDING)
191 return F_UNLCK;
192 if (fl->fl_flags & FL_DOWNGRADE_PENDING)
193 return F_RDLCK;
194 return fl->fl_type;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400195}
196
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197int leases_enable = 1;
198int lease_break_time = 45;
199
Jeff Layton1c8c6012013-06-21 08:58:15 -0400200/*
Jeff Layton7012b022013-06-21 08:58:22 -0400201 * The global file_lock_list is only used for displaying /proc/locks, so we
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200202 * keep a list on each CPU, with each list protected by its own spinlock.
203 * Global serialization is done using file_rwsem.
204 *
205 * Note that alterations to the list also require that the relevant flc_lock is
206 * held.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400207 */
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200208struct file_lock_list_struct {
209 spinlock_t lock;
210 struct hlist_head hlist;
211};
212static DEFINE_PER_CPU(struct file_lock_list_struct, file_lock_list);
Peter Zijlstraaba37662015-06-22 14:16:33 +0200213DEFINE_STATIC_PERCPU_RWSEM(file_rwsem);
Jeff Layton88974692013-06-21 08:58:14 -0400214
Jeff Laytoneb82dd32019-08-18 14:18:53 -0400215
Jeff Layton1c8c6012013-06-21 08:58:15 -0400216/*
Jeff Layton48f74182013-06-21 08:58:18 -0400217 * The blocked_hash is used to find POSIX lock loops for deadlock detection.
Jeff Layton7b2296a2013-06-21 08:58:20 -0400218 * It is protected by blocked_lock_lock.
Jeff Layton48f74182013-06-21 08:58:18 -0400219 *
220 * We hash locks by lockowner in order to optimize searching for the lock a
221 * particular lockowner is waiting on.
222 *
223 * FIXME: make this value scale via some heuristic? We generally will want more
224 * buckets when we have more lockowners holding locks, but that's a little
225 * difficult to determine without knowing what the workload will look like.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400226 */
Jeff Layton48f74182013-06-21 08:58:18 -0400227#define BLOCKED_HASH_BITS 7
228static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
Jeff Layton88974692013-06-21 08:58:14 -0400229
Jeff Layton1c8c6012013-06-21 08:58:15 -0400230/*
Jeff Layton7b2296a2013-06-21 08:58:20 -0400231 * This lock protects the blocked_hash. Generally, if you're accessing it, you
232 * want to be holding this lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400233 *
NeilBrownada5c1d2018-11-30 10:04:08 +1100234 * In addition, it also protects the fl->fl_blocked_requests list, and the
235 * fl->fl_blocker pointer for file_lock structures that are acting as lock
236 * requests (in contrast to those that are acting as records of acquired locks).
Jeff Layton1c8c6012013-06-21 08:58:15 -0400237 *
238 * Note that when we acquire this lock in order to change the above fields,
Jeff Layton6109c852015-01-16 15:05:57 -0500239 * we often hold the flc_lock as well. In certain cases, when reading the fields
Jeff Layton1c8c6012013-06-21 08:58:15 -0400240 * protected by this lock, we can skip acquiring it iff we already hold the
Jeff Layton6109c852015-01-16 15:05:57 -0500241 * flc_lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400242 */
Jeff Layton7b2296a2013-06-21 08:58:20 -0400243static DEFINE_SPINLOCK(blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
Jeff Layton4a075e32015-01-16 15:05:54 -0500245static struct kmem_cache *flctx_cache __read_mostly;
Christoph Lametere18b8902006-12-06 20:33:20 -0800246static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Jeff Layton4a075e32015-01-16 15:05:54 -0500248static struct file_lock_context *
Jeff Layton5c1c6692015-04-03 09:04:03 -0400249locks_get_lock_context(struct inode *inode, int type)
Jeff Layton4a075e32015-01-16 15:05:54 -0500250{
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200251 struct file_lock_context *ctx;
Jeff Layton4a075e32015-01-16 15:05:54 -0500252
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200253 /* paired with cmpxchg() below */
254 ctx = smp_load_acquire(&inode->i_flctx);
255 if (likely(ctx) || type == F_UNLCK)
Jeff Layton4a075e32015-01-16 15:05:54 -0500256 goto out;
257
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200258 ctx = kmem_cache_alloc(flctx_cache, GFP_KERNEL);
259 if (!ctx)
Jeff Layton4a075e32015-01-16 15:05:54 -0500260 goto out;
261
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200262 spin_lock_init(&ctx->flc_lock);
263 INIT_LIST_HEAD(&ctx->flc_flock);
264 INIT_LIST_HEAD(&ctx->flc_posix);
265 INIT_LIST_HEAD(&ctx->flc_lease);
Jeff Layton4a075e32015-01-16 15:05:54 -0500266
267 /*
268 * Assign the pointer if it's not already assigned. If it is, then
269 * free the context we just allocated.
270 */
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200271 if (cmpxchg(&inode->i_flctx, NULL, ctx)) {
272 kmem_cache_free(flctx_cache, ctx);
273 ctx = smp_load_acquire(&inode->i_flctx);
274 }
Jeff Layton4a075e32015-01-16 15:05:54 -0500275out:
Jeff Layton18909102016-01-06 21:26:10 -0500276 trace_locks_get_lock_context(inode, type, ctx);
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200277 return ctx;
Jeff Layton4a075e32015-01-16 15:05:54 -0500278}
279
Jeff Laytone24dada2016-01-06 21:28:41 -0500280static void
281locks_dump_ctx_list(struct list_head *list, char *list_type)
282{
283 struct file_lock *fl;
284
285 list_for_each_entry(fl, list, fl_list) {
286 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);
287 }
288}
289
290static void
291locks_check_ctx_lists(struct inode *inode)
292{
293 struct file_lock_context *ctx = inode->i_flctx;
294
295 if (unlikely(!list_empty(&ctx->flc_flock) ||
296 !list_empty(&ctx->flc_posix) ||
297 !list_empty(&ctx->flc_lease))) {
298 pr_warn("Leaked locks on dev=0x%x:0x%x ino=0x%lx:\n",
299 MAJOR(inode->i_sb->s_dev), MINOR(inode->i_sb->s_dev),
300 inode->i_ino);
301 locks_dump_ctx_list(&ctx->flc_flock, "FLOCK");
302 locks_dump_ctx_list(&ctx->flc_posix, "POSIX");
303 locks_dump_ctx_list(&ctx->flc_lease, "LEASE");
304 }
305}
306
Benjamin Coddington39537042017-07-21 13:36:25 -0400307static void
308locks_check_ctx_file_list(struct file *filp, struct list_head *list,
309 char *list_type)
310{
311 struct file_lock *fl;
312 struct inode *inode = locks_inode(filp);
313
314 list_for_each_entry(fl, list, fl_list)
315 if (fl->fl_file == filp)
316 pr_warn("Leaked %s lock on dev=0x%x:0x%x ino=0x%lx "
317 " fl_owner=%p fl_flags=0x%x fl_type=0x%x fl_pid=%u\n",
318 list_type, MAJOR(inode->i_sb->s_dev),
319 MINOR(inode->i_sb->s_dev), inode->i_ino,
320 fl->fl_owner, fl->fl_flags, fl->fl_type, fl->fl_pid);
321}
322
Jeff Layton4a075e32015-01-16 15:05:54 -0500323void
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500324locks_free_lock_context(struct inode *inode)
Jeff Layton4a075e32015-01-16 15:05:54 -0500325{
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500326 struct file_lock_context *ctx = inode->i_flctx;
327
Jeff Laytone24dada2016-01-06 21:28:41 -0500328 if (unlikely(ctx)) {
329 locks_check_ctx_lists(inode);
Jeff Layton4a075e32015-01-16 15:05:54 -0500330 kmem_cache_free(flctx_cache, ctx);
331 }
332}
333
Miklos Szerediee19cc42011-07-07 13:06:09 +0200334static void locks_init_lock_heads(struct file_lock *fl)
Miklos Szeredia51cb912011-07-06 12:33:55 +0200335{
Jeff Layton139ca042013-06-21 08:58:17 -0400336 INIT_HLIST_NODE(&fl->fl_link);
Jeff Layton6dee60f2015-01-16 15:05:54 -0500337 INIT_LIST_HEAD(&fl->fl_list);
NeilBrownada5c1d2018-11-30 10:04:08 +1100338 INIT_LIST_HEAD(&fl->fl_blocked_requests);
339 INIT_LIST_HEAD(&fl->fl_blocked_member);
Miklos Szerediee19cc42011-07-07 13:06:09 +0200340 init_waitqueue_head(&fl->fl_wait);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200341}
342
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200344struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200346 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200347
348 if (fl)
Miklos Szerediee19cc42011-07-07 13:06:09 +0200349 locks_init_lock_heads(fl);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200350
351 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200353EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500355void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500356{
NeilBrown59264592019-04-24 12:00:08 +1000357 BUG_ON(waitqueue_active(&fl->fl_wait));
358 BUG_ON(!list_empty(&fl->fl_list));
359 BUG_ON(!list_empty(&fl->fl_blocked_requests));
360 BUG_ON(!list_empty(&fl->fl_blocked_member));
361 BUG_ON(!hlist_unhashed(&fl->fl_link));
362
Trond Myklebust47831f32006-03-20 13:44:05 -0500363 if (fl->fl_ops) {
364 if (fl->fl_ops->fl_release_private)
365 fl->fl_ops->fl_release_private(fl);
366 fl->fl_ops = NULL;
367 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500368
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400369 if (fl->fl_lmops) {
Jeff Laytoncae80b32015-04-03 09:04:04 -0400370 if (fl->fl_lmops->lm_put_owner) {
371 fl->fl_lmops->lm_put_owner(fl->fl_owner);
372 fl->fl_owner = NULL;
373 }
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400374 fl->fl_lmops = NULL;
375 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500376}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500377EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500378
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379/* Free a lock which is not in use. */
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400380void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381{
Trond Myklebust47831f32006-03-20 13:44:05 -0500382 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 kmem_cache_free(filelock_cache, fl);
384}
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400385EXPORT_SYMBOL(locks_free_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
Jeff Laytoned9814d2014-08-11 14:20:31 -0400387static void
388locks_dispose_list(struct list_head *dispose)
389{
390 struct file_lock *fl;
391
392 while (!list_empty(dispose)) {
Jeff Layton6dee60f2015-01-16 15:05:54 -0500393 fl = list_first_entry(dispose, struct file_lock, fl_list);
394 list_del_init(&fl->fl_list);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400395 locks_free_lock(fl);
396 }
397}
398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399void locks_init_lock(struct file_lock *fl)
400{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200401 memset(fl, 0, sizeof(struct file_lock));
402 locks_init_lock_heads(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404EXPORT_SYMBOL(locks_init_lock);
405
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406/*
407 * Initialize a new lock from an existing file_lock structure.
408 */
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400409void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410{
411 new->fl_owner = fl->fl_owner;
412 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500413 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 new->fl_flags = fl->fl_flags;
415 new->fl_type = fl->fl_type;
416 new->fl_start = fl->fl_start;
417 new->fl_end = fl->fl_end;
Kinglong Meef3282962014-08-22 10:18:43 -0400418 new->fl_lmops = fl->fl_lmops;
Trond Myklebust09969052006-03-20 13:44:38 -0500419 new->fl_ops = NULL;
Kinglong Meef3282962014-08-22 10:18:43 -0400420
421 if (fl->fl_lmops) {
422 if (fl->fl_lmops->lm_get_owner)
Jeff Laytoncae80b32015-04-03 09:04:04 -0400423 fl->fl_lmops->lm_get_owner(fl->fl_owner);
Kinglong Meef3282962014-08-22 10:18:43 -0400424 }
Trond Myklebust09969052006-03-20 13:44:38 -0500425}
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400426EXPORT_SYMBOL(locks_copy_conflock);
Trond Myklebust09969052006-03-20 13:44:38 -0500427
428void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
429{
Jeff Layton566709b2014-08-11 14:09:35 -0400430 /* "new" must be a freshly-initialized lock */
431 WARN_ON_ONCE(new->fl_ops);
Trond Myklebust09969052006-03-20 13:44:38 -0500432
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400433 locks_copy_conflock(new, fl);
Kinglong Meef3282962014-08-22 10:18:43 -0400434
Trond Myklebust09969052006-03-20 13:44:38 -0500435 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 new->fl_ops = fl->fl_ops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500437
Kinglong Meef3282962014-08-22 10:18:43 -0400438 if (fl->fl_ops) {
439 if (fl->fl_ops->fl_copy_lock)
440 fl->fl_ops->fl_copy_lock(new, fl);
441 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443EXPORT_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);
NeilBrownbf77ae42019-01-03 11:04:08 +1100458 list_for_each_entry(f, &new->fl_blocked_requests, fl_blocked_member)
NeilBrown5946c432018-11-30 10:04:08 +1100459 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);
NeilBrown7bbd1fc2018-11-30 10:04:08 +1100485
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;
NeilBrown7bbd1fc2018-11-30 10:04:08 +1100500
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{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 return fl1->fl_owner == fl2->fl_owner;
663}
664
Jeff Layton6109c852015-01-16 15:05:57 -0500665/* Must be called with the flc_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500666static void locks_insert_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400667{
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200668 struct file_lock_list_struct *fll = this_cpu_ptr(&file_lock_list);
669
Peter Zijlstraaba37662015-06-22 14:16:33 +0200670 percpu_rwsem_assert_held(&file_rwsem);
671
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200672 spin_lock(&fll->lock);
Jeff Layton7012b022013-06-21 08:58:22 -0400673 fl->fl_link_cpu = smp_processor_id();
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200674 hlist_add_head(&fl->fl_link, &fll->hlist);
675 spin_unlock(&fll->lock);
Jeff Layton88974692013-06-21 08:58:14 -0400676}
677
Jeff Layton6109c852015-01-16 15:05:57 -0500678/* Must be called with the flc_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500679static void locks_delete_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400680{
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200681 struct file_lock_list_struct *fll;
682
Peter Zijlstraaba37662015-06-22 14:16:33 +0200683 percpu_rwsem_assert_held(&file_rwsem);
684
Jeff Layton7012b022013-06-21 08:58:22 -0400685 /*
686 * Avoid taking lock if already unhashed. This is safe since this check
Jeff Layton6109c852015-01-16 15:05:57 -0500687 * is done while holding the flc_lock, and new insertions into the list
Jeff Layton7012b022013-06-21 08:58:22 -0400688 * also require that it be held.
689 */
690 if (hlist_unhashed(&fl->fl_link))
691 return;
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200692
693 fll = per_cpu_ptr(&file_lock_list, fl->fl_link_cpu);
694 spin_lock(&fll->lock);
Jeff Layton139ca042013-06-21 08:58:17 -0400695 hlist_del_init(&fl->fl_link);
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200696 spin_unlock(&fll->lock);
Jeff Layton88974692013-06-21 08:58:14 -0400697}
698
Jeff Layton3999e492013-06-21 08:58:19 -0400699static unsigned long
700posix_owner_key(struct file_lock *fl)
701{
Jeff Layton3999e492013-06-21 08:58:19 -0400702 return (unsigned long)fl->fl_owner;
703}
704
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500705static void locks_insert_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400706{
Daniel Wagner663d5af2015-04-03 09:04:03 -0400707 lockdep_assert_held(&blocked_lock_lock);
708
Jeff Layton3999e492013-06-21 08:58:19 -0400709 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
Jeff Layton88974692013-06-21 08:58:14 -0400710}
711
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500712static void locks_delete_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400713{
Daniel Wagner663d5af2015-04-03 09:04:03 -0400714 lockdep_assert_held(&blocked_lock_lock);
715
Jeff Layton48f74182013-06-21 08:58:18 -0400716 hash_del(&waiter->fl_link);
Jeff Layton88974692013-06-21 08:58:14 -0400717}
718
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719/* Remove waiter from blocker's block list.
720 * When blocker ends up pointing to itself then the list is empty.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400721 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400722 * Must be called with blocked_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 */
Matt Mackall33443c42006-01-08 01:05:22 -0800724static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725{
Jeff Layton88974692013-06-21 08:58:14 -0400726 locks_delete_global_blocked(waiter);
NeilBrownada5c1d2018-11-30 10:04:08 +1100727 list_del_init(&waiter->fl_blocked_member);
728 waiter->fl_blocker = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729}
730
NeilBrownad6bbd82018-11-30 10:04:08 +1100731static void __locks_wake_up_blocks(struct file_lock *blocker)
732{
733 while (!list_empty(&blocker->fl_blocked_requests)) {
734 struct file_lock *waiter;
735
736 waiter = list_first_entry(&blocker->fl_blocked_requests,
737 struct file_lock, fl_blocked_member);
738 __locks_delete_block(waiter);
739 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
740 waiter->fl_lmops->lm_notify(waiter);
741 else
742 wake_up(&waiter->fl_wait);
743 }
744}
745
NeilBrowncb03f942018-11-30 10:04:08 +1100746/**
747 * locks_delete_lock - stop waiting for a file lock
748 * @waiter: the lock which was waiting
749 *
750 * lockd/nfsd need to disconnect the lock while working on it.
751 */
752int locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753{
NeilBrowncb03f942018-11-30 10:04:08 +1100754 int status = -ENOENT;
755
NeilBrown16306a62018-11-30 10:04:08 +1100756 /*
757 * If fl_blocker is NULL, it won't be set again as this thread
758 * "owns" the lock and is the only one that might try to claim
759 * the lock. So it is safe to test fl_blocker locklessly.
760 * Also if fl_blocker is NULL, this waiter is not listed on
761 * fl_blocked_requests for some lock, so no other request can
762 * be added to the list of fl_blocked_requests for this
763 * request. So if fl_blocker is NULL, it is safe to
764 * locklessly check if fl_blocked_requests is empty. If both
765 * of these checks succeed, there is no need to take the lock.
766 */
767 if (waiter->fl_blocker == NULL &&
768 list_empty(&waiter->fl_blocked_requests))
NeilBrowncb03f942018-11-30 10:04:08 +1100769 return status;
Jeff Layton7b2296a2013-06-21 08:58:20 -0400770 spin_lock(&blocked_lock_lock);
NeilBrowncb03f942018-11-30 10:04:08 +1100771 if (waiter->fl_blocker)
772 status = 0;
NeilBrown5946c432018-11-30 10:04:08 +1100773 __locks_wake_up_blocks(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 __locks_delete_block(waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400775 spin_unlock(&blocked_lock_lock);
NeilBrowncb03f942018-11-30 10:04:08 +1100776 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777}
NeilBrowncb03f942018-11-30 10:04:08 +1100778EXPORT_SYMBOL(locks_delete_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779
780/* Insert waiter into blocker's block list.
781 * We use a circular list so that processes can be easily woken up in
782 * the order they blocked. The documentation doesn't require this but
783 * it seems like the reasonable thing to do.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400784 *
Jeff Layton6109c852015-01-16 15:05:57 -0500785 * Must be called with both the flc_lock and blocked_lock_lock held. The
NeilBrownada5c1d2018-11-30 10:04:08 +1100786 * fl_blocked_requests list itself is protected by the blocked_lock_lock,
787 * but by ensuring that the flc_lock is also held on insertions we can avoid
788 * taking the blocked_lock_lock in some cases when we see that the
789 * fl_blocked_requests list is empty.
NeilBrownfd7732e2018-11-30 10:04:08 +1100790 *
791 * Rather than just adding to the list, we check for conflicts with any existing
792 * waiters, and add beneath any waiter that blocks the new waiter.
793 * Thus wakeups don't happen until needed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400795static void __locks_insert_block(struct file_lock *blocker,
NeilBrownfd7732e2018-11-30 10:04:08 +1100796 struct file_lock *waiter,
797 bool conflict(struct file_lock *,
798 struct file_lock *))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799{
NeilBrownfd7732e2018-11-30 10:04:08 +1100800 struct file_lock *fl;
NeilBrownada5c1d2018-11-30 10:04:08 +1100801 BUG_ON(!list_empty(&waiter->fl_blocked_member));
NeilBrownfd7732e2018-11-30 10:04:08 +1100802
803new_blocker:
804 list_for_each_entry(fl, &blocker->fl_blocked_requests, fl_blocked_member)
805 if (conflict(fl, waiter)) {
806 blocker = fl;
807 goto new_blocker;
808 }
NeilBrownada5c1d2018-11-30 10:04:08 +1100809 waiter->fl_blocker = blocker;
810 list_add_tail(&waiter->fl_blocked_member, &blocker->fl_blocked_requests);
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400811 if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400812 locks_insert_global_blocked(waiter);
NeilBrown5946c432018-11-30 10:04:08 +1100813
814 /* The requests in waiter->fl_blocked are known to conflict with
815 * waiter, but might not conflict with blocker, or the requests
816 * and lock which block it. So they all need to be woken.
817 */
818 __locks_wake_up_blocks(waiter);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400819}
820
Jeff Layton6109c852015-01-16 15:05:57 -0500821/* Must be called with flc_lock held. */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400822static void locks_insert_block(struct file_lock *blocker,
NeilBrownfd7732e2018-11-30 10:04:08 +1100823 struct file_lock *waiter,
824 bool conflict(struct file_lock *,
825 struct file_lock *))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400826{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400827 spin_lock(&blocked_lock_lock);
NeilBrownfd7732e2018-11-30 10:04:08 +1100828 __locks_insert_block(blocker, waiter, conflict);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400829 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830}
831
Jeff Layton1cb36012013-06-21 08:58:12 -0400832/*
833 * Wake up processes blocked waiting for blocker.
834 *
Jeff Layton6109c852015-01-16 15:05:57 -0500835 * Must be called with the inode->flc_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 */
837static void locks_wake_up_blocks(struct file_lock *blocker)
838{
Jeff Layton4e8c7652013-06-21 08:58:16 -0400839 /*
840 * Avoid taking global lock if list is empty. This is safe since new
Jeff Layton6109c852015-01-16 15:05:57 -0500841 * blocked requests are only added to the list under the flc_lock, and
NeilBrownada5c1d2018-11-30 10:04:08 +1100842 * the flc_lock is always held here. Note that removal from the
843 * fl_blocked_requests list does not require the flc_lock, so we must
844 * recheck list_empty() after acquiring the blocked_lock_lock.
Jeff Layton4e8c7652013-06-21 08:58:16 -0400845 */
NeilBrownada5c1d2018-11-30 10:04:08 +1100846 if (list_empty(&blocker->fl_blocked_requests))
Jeff Layton4e8c7652013-06-21 08:58:16 -0400847 return;
848
Jeff Layton7b2296a2013-06-21 08:58:20 -0400849 spin_lock(&blocked_lock_lock);
NeilBrownad6bbd82018-11-30 10:04:08 +1100850 __locks_wake_up_blocks(blocker);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400851 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852}
853
Jeff Layton5263e312015-01-16 15:05:55 -0500854static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500855locks_insert_lock_ctx(struct file_lock *fl, struct list_head *before)
Jeff Layton5263e312015-01-16 15:05:55 -0500856{
Jeff Layton5263e312015-01-16 15:05:55 -0500857 list_add_tail(&fl->fl_list, before);
858 locks_insert_global_locks(fl);
859}
860
Jeff Layton8634b512015-01-16 15:05:55 -0500861static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500862locks_unlink_lock_ctx(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863{
Jeff Layton88974692013-06-21 08:58:14 -0400864 locks_delete_global_locks(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500865 list_del_init(&fl->fl_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 locks_wake_up_blocks(fl);
Jeff Layton24cbe782014-02-03 12:13:06 -0500867}
868
Jeff Layton5263e312015-01-16 15:05:55 -0500869static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500870locks_delete_lock_ctx(struct file_lock *fl, struct list_head *dispose)
Jeff Layton5263e312015-01-16 15:05:55 -0500871{
Jeff Laytone084c1b2015-02-16 14:32:03 -0500872 locks_unlink_lock_ctx(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500873 if (dispose)
874 list_add(&fl->fl_list, dispose);
875 else
876 locks_free_lock(fl);
Jeff Layton5263e312015-01-16 15:05:55 -0500877}
878
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
880 * checks for shared/exclusive status of overlapping locks.
881 */
NeilBrownc0e15902018-11-30 10:04:08 +1100882static bool locks_conflict(struct file_lock *caller_fl,
883 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884{
885 if (sys_fl->fl_type == F_WRLCK)
NeilBrownc0e15902018-11-30 10:04:08 +1100886 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 if (caller_fl->fl_type == F_WRLCK)
NeilBrownc0e15902018-11-30 10:04:08 +1100888 return true;
889 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890}
891
892/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
893 * checking before calling the locks_conflict().
894 */
NeilBrownc0e15902018-11-30 10:04:08 +1100895static bool posix_locks_conflict(struct file_lock *caller_fl,
896 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897{
898 /* POSIX locks owned by the same process do not conflict with
899 * each other.
900 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400901 if (posix_same_owner(caller_fl, sys_fl))
NeilBrownc0e15902018-11-30 10:04:08 +1100902 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903
904 /* Check whether they overlap */
905 if (!locks_overlap(caller_fl, sys_fl))
NeilBrownc0e15902018-11-30 10:04:08 +1100906 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907
NeilBrownc0e15902018-11-30 10:04:08 +1100908 return locks_conflict(caller_fl, sys_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909}
910
911/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
912 * checking before calling the locks_conflict().
913 */
NeilBrownc0e15902018-11-30 10:04:08 +1100914static bool flock_locks_conflict(struct file_lock *caller_fl,
915 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916{
917 /* FLOCK locks referring to the same filp do not conflict with
918 * each other.
919 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400920 if (caller_fl->fl_file == sys_fl->fl_file)
NeilBrownc0e15902018-11-30 10:04:08 +1100921 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
NeilBrownc0e15902018-11-30 10:04:08 +1100923 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924
NeilBrownc0e15902018-11-30 10:04:08 +1100925 return locks_conflict(caller_fl, sys_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926}
927
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400928void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500929posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930{
931 struct file_lock *cfl;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500932 struct file_lock_context *ctx;
Miklos Szeredic568d682016-09-16 12:44:20 +0200933 struct inode *inode = locks_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200935 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500936 if (!ctx || list_empty_careful(&ctx->flc_posix)) {
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400937 fl->fl_type = F_UNLCK;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500938 return;
939 }
940
Jeff Layton6109c852015-01-16 15:05:57 -0500941 spin_lock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500942 list_for_each_entry(cfl, &ctx->flc_posix, fl_list) {
943 if (posix_locks_conflict(fl, cfl)) {
944 locks_copy_conflock(fl, cfl);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500945 goto out;
946 }
947 }
948 fl->fl_type = F_UNLCK;
949out:
Jeff Layton6109c852015-01-16 15:05:57 -0500950 spin_unlock(&ctx->flc_lock);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400951 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953EXPORT_SYMBOL(posix_test_lock);
954
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400955/*
956 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400958 * We attempt to detect deadlocks that are due purely to posix file
959 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400961 * We assume that a task can be waiting for at most one lock at a time.
962 * So for any acquired lock, the process holding that lock may be
963 * waiting on at most one other lock. That lock in turns may be held by
964 * someone waiting for at most one other lock. Given a requested lock
965 * caller_fl which is about to wait for a conflicting lock block_fl, we
966 * follow this chain of waiters to ensure we are not about to create a
967 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400968 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400969 * Since we do this before we ever put a process to sleep on a lock, we
970 * are ensured that there is never a cycle; that is what guarantees that
971 * the while() loop in posix_locks_deadlock() eventually completes.
972 *
973 * Note: the above assumption may not be true when handling lock
974 * requests from a broken NFS client. It may also fail in the presence
975 * of tasks (such as posix threads) sharing the same open file table.
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400976 * To handle those cases, we just bail out after a few iterations.
Jeff Layton57b65322014-02-03 12:13:09 -0500977 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400978 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
Jeff Layton57b65322014-02-03 12:13:09 -0500979 * Because the owner is not even nominally tied to a thread of
980 * execution, the deadlock detection below can't reasonably work well. Just
981 * skip it for those.
982 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400983 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
Jeff Layton57b65322014-02-03 12:13:09 -0500984 * locks that just checks for the case where two tasks are attempting to
985 * upgrade from read to write locks on the same inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400987
988#define MAX_DEADLK_ITERATIONS 10
989
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400990/* Find a lock that the owner of the given block_fl is blocking on. */
991static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
992{
993 struct file_lock *fl;
994
Jeff Layton3999e492013-06-21 08:58:19 -0400995 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
NeilBrown5946c432018-11-30 10:04:08 +1100996 if (posix_same_owner(fl, block_fl)) {
997 while (fl->fl_blocker)
998 fl = fl->fl_blocker;
999 return fl;
1000 }
J. Bruce Fieldsb5331842007-10-26 18:05:40 -04001001 }
1002 return NULL;
1003}
1004
Jeff Layton7b2296a2013-06-21 08:58:20 -04001005/* Must be called with the blocked_lock_lock held! */
Adrian Bunkb0904e12006-06-23 02:05:13 -07001006static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 struct file_lock *block_fl)
1008{
J. Bruce Fields97855b42007-10-30 11:20:02 -04001009 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010
Daniel Wagner663d5af2015-04-03 09:04:03 -04001011 lockdep_assert_held(&blocked_lock_lock);
1012
Jeff Layton57b65322014-02-03 12:13:09 -05001013 /*
1014 * This deadlock detector can't reasonably detect deadlocks with
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001015 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
Jeff Layton57b65322014-02-03 12:13:09 -05001016 */
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001017 if (IS_OFDLCK(caller_fl))
Jeff Layton57b65322014-02-03 12:13:09 -05001018 return 0;
1019
J. Bruce Fieldsb5331842007-10-26 18:05:40 -04001020 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
1021 if (i++ > MAX_DEADLK_ITERATIONS)
1022 return 0;
1023 if (posix_same_owner(caller_fl, block_fl))
1024 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 }
1026 return 0;
1027}
1028
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -04001030 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -04001031 *
1032 * Note that if called with an FL_EXISTS argument, the caller may determine
1033 * whether or not a lock was successfully freed by testing the return
1034 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 */
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04001036static int flock_lock_inode(struct inode *inode, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037{
Trond Myklebust993dfa82006-03-31 02:30:55 -08001038 struct file_lock *new_fl = NULL;
Jeff Layton5263e312015-01-16 15:05:55 -05001039 struct file_lock *fl;
1040 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 int error = 0;
Jeff Layton5263e312015-01-16 15:05:55 -05001042 bool found = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -04001043 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044
Jeff Layton5c1c6692015-04-03 09:04:03 -04001045 ctx = locks_get_lock_context(inode, request->fl_type);
1046 if (!ctx) {
1047 if (request->fl_type != F_UNLCK)
1048 return -ENOMEM;
1049 return (request->fl_flags & FL_EXISTS) ? -ENOENT : 0;
1050 }
Jeff Layton5263e312015-01-16 15:05:55 -05001051
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001052 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
1053 new_fl = locks_alloc_lock();
1054 if (!new_fl)
1055 return -ENOMEM;
1056 }
1057
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001058 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001059 spin_lock(&ctx->flc_lock);
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001060 if (request->fl_flags & FL_ACCESS)
1061 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +04001062
Jeff Layton5263e312015-01-16 15:05:55 -05001063 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04001064 if (request->fl_file != fl->fl_file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001066 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 goto out;
Jeff Layton5263e312015-01-16 15:05:55 -05001068 found = true;
Jeff Laytone084c1b2015-02-16 14:32:03 -05001069 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 break;
1071 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072
Trond Myklebustf475ae92006-06-29 16:38:32 -04001073 if (request->fl_type == F_UNLCK) {
1074 if ((request->fl_flags & FL_EXISTS) && !found)
1075 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001076 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001077 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001079find_conflict:
Jeff Layton5263e312015-01-16 15:05:55 -05001080 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Trond Myklebust993dfa82006-03-31 02:30:55 -08001081 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 continue;
1083 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -07001084 if (!(request->fl_flags & FL_SLEEP))
1085 goto out;
1086 error = FILE_LOCK_DEFERRED;
NeilBrownfd7732e2018-11-30 10:04:08 +11001087 locks_insert_block(fl, request, flock_locks_conflict);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 goto out;
1089 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001090 if (request->fl_flags & FL_ACCESS)
1091 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001092 locks_copy_lock(new_fl, request);
NeilBrown5946c432018-11-30 10:04:08 +11001093 locks_move_blocks(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001094 locks_insert_lock_ctx(new_fl, &ctx->flc_flock);
Trond Myklebust993dfa82006-03-31 02:30:55 -08001095 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +04001096 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097
1098out:
Jeff Layton6109c852015-01-16 15:05:57 -05001099 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001100 percpu_up_read(&file_rwsem);
Trond Myklebust993dfa82006-03-31 02:30:55 -08001101 if (new_fl)
1102 locks_free_lock(new_fl);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001103 locks_dispose_list(&dispose);
Jeff Laytonc883da32018-07-30 07:54:56 -04001104 trace_flock_lock_inode(inode, request, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105 return error;
1106}
1107
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001108static int posix_lock_inode(struct inode *inode, struct file_lock *request,
1109 struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001111 struct file_lock *fl, *tmp;
Miklos Szeredi39005d02006-06-23 02:05:10 -07001112 struct file_lock *new_fl = NULL;
1113 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 struct file_lock *left = NULL;
1115 struct file_lock *right = NULL;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001116 struct file_lock_context *ctx;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001117 int error;
1118 bool added = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -04001119 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120
Jeff Layton5c1c6692015-04-03 09:04:03 -04001121 ctx = locks_get_lock_context(inode, request->fl_type);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001122 if (!ctx)
Jeff Layton5c1c6692015-04-03 09:04:03 -04001123 return (request->fl_type == F_UNLCK) ? 0 : -ENOMEM;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001124
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 /*
1126 * We may need two file_lock structures for this operation,
1127 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -07001128 *
1129 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 */
Miklos Szeredi39005d02006-06-23 02:05:10 -07001131 if (!(request->fl_flags & FL_ACCESS) &&
1132 (request->fl_type != F_UNLCK ||
1133 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
1134 new_fl = locks_alloc_lock();
1135 new_fl2 = locks_alloc_lock();
1136 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001138 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001139 spin_lock(&ctx->flc_lock);
Jeff Layton1cb36012013-06-21 08:58:12 -04001140 /*
1141 * New lock request. Walk all POSIX locks and look for conflicts. If
1142 * there are any, either return error or put the request on the
Jeff Layton48f74182013-06-21 08:58:18 -04001143 * blocker's list of waiters and the global blocked_hash.
Jeff Layton1cb36012013-06-21 08:58:12 -04001144 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 if (request->fl_type != F_UNLCK) {
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001146 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 if (!posix_locks_conflict(request, fl))
1148 continue;
Andy Adamson5842add2006-03-26 01:37:26 -08001149 if (conflock)
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001150 locks_copy_conflock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 error = -EAGAIN;
1152 if (!(request->fl_flags & FL_SLEEP))
1153 goto out;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001154 /*
1155 * Deadlock detection and insertion into the blocked
1156 * locks list must be done while holding the same lock!
1157 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 error = -EDEADLK;
Jeff Layton7b2296a2013-06-21 08:58:20 -04001159 spin_lock(&blocked_lock_lock);
Jeff Layton945ab8f2019-03-25 08:15:14 -04001160 /*
1161 * Ensure that we don't find any locks blocked on this
1162 * request during deadlock detection.
1163 */
1164 __locks_wake_up_blocks(request);
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;
NeilBrown7bbd1fc2018-11-30 10:04:08 +11001172 }
1173 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174
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 Zijlstra02e525b22019-02-21 15:38:40 +01001317 percpu_up_read(&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}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468EXPORT_SYMBOL(locks_mandatory_area);
Jeff Layton9e8925b2015-11-16 09:49:34 -05001469#endif /* CONFIG_MANDATORY_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470
J. Bruce Fields778fc542011-07-26 18:25:49 -04001471static void lease_clear_pending(struct file_lock *fl, int arg)
1472{
1473 switch (arg) {
1474 case F_UNLCK:
1475 fl->fl_flags &= ~FL_UNLOCK_PENDING;
Gustavo A. R. Silva0a4c9262019-01-23 02:48:28 -06001476 /* fall through */
J. Bruce Fields778fc542011-07-26 18:25:49 -04001477 case F_RDLCK:
1478 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1479 }
1480}
1481
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482/* We already had a lease on this file; just change its type */
Jeff Layton7448cc32015-01-16 15:05:57 -05001483int lease_modify(struct file_lock *fl, int arg, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485 int error = assign_type(fl, arg);
1486
1487 if (error)
1488 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001489 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001491 if (arg == F_UNLCK) {
1492 struct file *filp = fl->fl_file;
1493
1494 f_delown(filp);
1495 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001496 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1497 if (fl->fl_fasync != NULL) {
1498 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1499 fl->fl_fasync = NULL;
1500 }
Jeff Laytone084c1b2015-02-16 14:32:03 -05001501 locks_delete_lock_ctx(fl, dispose);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001502 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 return 0;
1504}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505EXPORT_SYMBOL(lease_modify);
1506
J. Bruce Fields778fc542011-07-26 18:25:49 -04001507static bool past_time(unsigned long then)
1508{
1509 if (!then)
1510 /* 0 is a special value meaning "this never expires": */
1511 return false;
1512 return time_after(jiffies, then);
1513}
1514
Jeff Laytonc45198e2014-09-01 07:12:07 -04001515static void time_out_leases(struct inode *inode, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516{
Jeff Layton8634b512015-01-16 15:05:55 -05001517 struct file_lock_context *ctx = inode->i_flctx;
1518 struct file_lock *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519
Jeff Layton6109c852015-01-16 15:05:57 -05001520 lockdep_assert_held(&ctx->flc_lock);
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001521
Jeff Layton8634b512015-01-16 15:05:55 -05001522 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001523 trace_time_out_leases(inode, fl);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001524 if (past_time(fl->fl_downgrade_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001525 lease_modify(fl, F_RDLCK, dispose);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001526 if (past_time(fl->fl_break_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001527 lease_modify(fl, F_UNLCK, dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 }
1529}
1530
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001531static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1532{
Ira Weinyd51f5272019-06-05 18:45:34 -07001533 bool rc;
1534
1535 if ((breaker->fl_flags & FL_LAYOUT) != (lease->fl_flags & FL_LAYOUT)) {
1536 rc = false;
1537 goto trace;
1538 }
1539 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE)) {
1540 rc = false;
1541 goto trace;
1542 }
1543
1544 rc = locks_conflict(breaker, lease);
1545trace:
1546 trace_leases_conflict(rc, lease, breaker);
1547 return rc;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001548}
1549
Jeff Layton03d12dd2014-09-01 14:53:41 -04001550static bool
1551any_leases_conflict(struct inode *inode, struct file_lock *breaker)
1552{
Jeff Layton8634b512015-01-16 15:05:55 -05001553 struct file_lock_context *ctx = inode->i_flctx;
Jeff Layton03d12dd2014-09-01 14:53:41 -04001554 struct file_lock *fl;
1555
Jeff Layton6109c852015-01-16 15:05:57 -05001556 lockdep_assert_held(&ctx->flc_lock);
Jeff Layton03d12dd2014-09-01 14:53:41 -04001557
Jeff Layton8634b512015-01-16 15:05:55 -05001558 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Jeff Layton03d12dd2014-09-01 14:53:41 -04001559 if (leases_conflict(fl, breaker))
1560 return true;
1561 }
1562 return false;
1563}
1564
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565/**
1566 * __break_lease - revoke all outstanding leases on file
1567 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001568 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1569 * break all leases
1570 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1571 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 *
david m. richter87250dd2007-05-09 16:10:27 -04001573 * break_lease (inlined for speed) has checked there already is at least
1574 * some kind of lock (maybe a lease) on this file. Leases are broken on
1575 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 * specified %O_NONBLOCK to your open().
1577 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001578int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001580 int error = 0;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001581 struct file_lock_context *ctx;
Yan, Zhenga9011252015-03-27 10:34:20 +08001582 struct file_lock *new_fl, *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583 unsigned long break_time;
Al Viro8737c932009-12-24 06:47:55 -05001584 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001585 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586
Al Viro8737c932009-12-24 06:47:55 -05001587 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001588 if (IS_ERR(new_fl))
1589 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001590 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591
Jeff Layton8634b512015-01-16 15:05:55 -05001592 /* typically we will check that ctx is non-NULL before calling */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001593 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001594 if (!ctx) {
1595 WARN_ON_ONCE(1);
Wenwen Wangcfddf9f2019-08-19 18:47:34 -05001596 goto free_lock;
Jeff Layton8634b512015-01-16 15:05:55 -05001597 }
1598
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001599 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001600 spin_lock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601
Jeff Laytonc45198e2014-09-01 07:12:07 -04001602 time_out_leases(inode, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603
Jeff Layton03d12dd2014-09-01 14:53:41 -04001604 if (!any_leases_conflict(inode, new_fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001605 goto out;
1606
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 break_time = 0;
1608 if (lease_break_time > 0) {
1609 break_time = jiffies + lease_break_time * HZ;
1610 if (break_time == 0)
1611 break_time++; /* so that 0 means no break time */
1612 }
1613
Yan, Zhenga9011252015-03-27 10:34:20 +08001614 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001615 if (!leases_conflict(fl, new_fl))
1616 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001617 if (want_write) {
1618 if (fl->fl_flags & FL_UNLOCK_PENDING)
1619 continue;
1620 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001622 } else {
Jeff Layton8634b512015-01-16 15:05:55 -05001623 if (lease_breaking(fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001624 continue;
1625 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1626 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 }
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001628 if (fl->fl_lmops->lm_break(fl))
Jeff Laytone084c1b2015-02-16 14:32:03 -05001629 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 }
1631
Jeff Layton8634b512015-01-16 15:05:55 -05001632 if (list_empty(&ctx->flc_lease))
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001633 goto out;
1634
Jeff Layton843c6b22014-09-01 14:27:43 -04001635 if (mode & O_NONBLOCK) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001636 trace_break_lease_noblock(inode, new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 error = -EWOULDBLOCK;
1638 goto out;
1639 }
1640
1641restart:
Jeff Layton8634b512015-01-16 15:05:55 -05001642 fl = list_first_entry(&ctx->flc_lease, struct file_lock, fl_list);
1643 break_time = fl->fl_break_time;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001644 if (break_time != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 break_time -= jiffies;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001646 if (break_time == 0)
1647 break_time++;
NeilBrownfd7732e2018-11-30 10:04:08 +11001648 locks_insert_block(fl, new_fl, leases_conflict);
Jeff Layton62af4f12014-05-09 14:13:05 -04001649 trace_break_lease_block(inode, new_fl);
Jeff Layton6109c852015-01-16 15:05:57 -05001650 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001651 percpu_up_read(&file_rwsem);
Peter Zijlstraaba37662015-06-22 14:16:33 +02001652
Jeff Laytonc45198e2014-09-01 07:12:07 -04001653 locks_dispose_list(&dispose);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001654 error = wait_event_interruptible_timeout(new_fl->fl_wait,
NeilBrownada5c1d2018-11-30 10:04:08 +11001655 !new_fl->fl_blocker, break_time);
Peter Zijlstraaba37662015-06-22 14:16:33 +02001656
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001657 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001658 spin_lock(&ctx->flc_lock);
Jeff Layton62af4f12014-05-09 14:13:05 -04001659 trace_break_lease_unblock(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001660 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 if (error >= 0) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001662 /*
1663 * Wait for the next conflicting lease that has not been
1664 * broken yet
1665 */
Jeff Layton03d12dd2014-09-01 14:53:41 -04001666 if (error == 0)
1667 time_out_leases(inode, &dispose);
1668 if (any_leases_conflict(inode, new_fl))
1669 goto restart;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 error = 0;
1671 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672out:
Jeff Layton6109c852015-01-16 15:05:57 -05001673 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001674 percpu_up_read(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001675 locks_dispose_list(&dispose);
Wenwen Wangcfddf9f2019-08-19 18:47:34 -05001676free_lock:
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001677 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 return error;
1679}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680EXPORT_SYMBOL(__break_lease);
1681
1682/**
Amir Goldstein76c47942018-01-03 17:14:34 +02001683 * lease_get_mtime - update modified time of an inode with exclusive lease
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684 * @inode: the inode
Amir Goldstein76c47942018-01-03 17:14:34 +02001685 * @time: pointer to a timespec which contains the last modified time
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 *
1687 * This is to force NFS clients to flush their caches for files with
1688 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001689 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001691void lease_get_mtime(struct inode *inode, struct timespec64 *time)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692{
Jeff Laytonbfe86022014-08-22 10:18:44 -04001693 bool has_lease = false;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001694 struct file_lock_context *ctx;
Jeff Layton8634b512015-01-16 15:05:55 -05001695 struct file_lock *fl;
Jeff Laytonbfe86022014-08-22 10:18:44 -04001696
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001697 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001698 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Jeff Layton6109c852015-01-16 15:05:57 -05001699 spin_lock(&ctx->flc_lock);
Geliang Tang8ace5df2015-11-18 21:40:33 +08001700 fl = list_first_entry_or_null(&ctx->flc_lease,
1701 struct file_lock, fl_list);
1702 if (fl && (fl->fl_type == F_WRLCK))
1703 has_lease = true;
Jeff Layton6109c852015-01-16 15:05:57 -05001704 spin_unlock(&ctx->flc_lock);
Jeff Laytonbfe86022014-08-22 10:18:44 -04001705 }
1706
1707 if (has_lease)
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001708 *time = current_time(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710EXPORT_SYMBOL(lease_get_mtime);
1711
1712/**
1713 * fcntl_getlease - Enquire what lease is currently active
1714 * @filp: the file
1715 *
1716 * The value returned by this function will be one of
1717 * (if no lease break is pending):
1718 *
1719 * %F_RDLCK to indicate a shared lease is held.
1720 *
1721 * %F_WRLCK to indicate an exclusive lease is held.
1722 *
1723 * %F_UNLCK to indicate no lease is held.
1724 *
1725 * (if a lease break is pending):
1726 *
1727 * %F_RDLCK to indicate an exclusive lease needs to be
1728 * changed to a shared lease (or removed).
1729 *
1730 * %F_UNLCK to indicate the lease needs to be removed.
1731 *
1732 * XXX: sfr & willy disagree over whether F_INPROGRESS
1733 * should be returned to userspace.
1734 */
1735int fcntl_getlease(struct file *filp)
1736{
1737 struct file_lock *fl;
Miklos Szeredic568d682016-09-16 12:44:20 +02001738 struct inode *inode = locks_inode(filp);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001739 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 int type = F_UNLCK;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001741 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001743 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001744 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001745 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001746 spin_lock(&ctx->flc_lock);
Miklos Szeredic568d682016-09-16 12:44:20 +02001747 time_out_leases(inode, &dispose);
Jeff Layton8634b512015-01-16 15:05:55 -05001748 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1749 if (fl->fl_file != filp)
1750 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001751 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752 break;
1753 }
Jeff Layton6109c852015-01-16 15:05:57 -05001754 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001755 percpu_up_read(&file_rwsem);
Peter Zijlstra5f430862016-10-08 10:12:28 +02001756
Jeff Layton8634b512015-01-16 15:05:55 -05001757 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 return type;
1760}
1761
Jeff Layton24cbe782014-02-03 12:13:06 -05001762/**
Amir Goldstein387e3742019-06-07 17:24:38 +03001763 * check_conflicting_open - see if the given file points to an inode that has
NeilBrown7bbd1fc2018-11-30 10:04:08 +11001764 * an existing open that would conflict with the
1765 * desired lease.
Amir Goldstein387e3742019-06-07 17:24:38 +03001766 * @filp: file to check
Jeff Layton24cbe782014-02-03 12:13:06 -05001767 * @arg: type of lease that we're trying to acquire
Randy Dunlap7fadc592015-08-09 18:43:17 -07001768 * @flags: current lock flags
Jeff Layton24cbe782014-02-03 12:13:06 -05001769 *
1770 * Check to see if there's an existing open fd on this file that would
1771 * conflict with the lease we're trying to set.
1772 */
1773static int
Amir Goldstein387e3742019-06-07 17:24:38 +03001774check_conflicting_open(struct file *filp, const long arg, int flags)
Jeff Layton24cbe782014-02-03 12:13:06 -05001775{
Amir Goldstein387e3742019-06-07 17:24:38 +03001776 struct inode *inode = locks_inode(filp);
1777 int self_wcount = 0, self_rcount = 0;
Jeff Layton24cbe782014-02-03 12:13:06 -05001778
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001779 if (flags & FL_LAYOUT)
1780 return 0;
1781
Amir Goldstein387e3742019-06-07 17:24:38 +03001782 if (arg == F_RDLCK)
1783 return inode_is_open_for_write(inode) ? -EAGAIN : 0;
1784 else if (arg != F_WRLCK)
1785 return 0;
1786
1787 /*
1788 * Make sure that only read/write count is from lease requestor.
1789 * Note that this will result in denying write leases when i_writecount
1790 * is negative, which is what we want. (We shouldn't grant write leases
1791 * on files open for execution.)
1792 */
1793 if (filp->f_mode & FMODE_WRITE)
1794 self_wcount = 1;
1795 else if (filp->f_mode & FMODE_READ)
1796 self_rcount = 1;
1797
1798 if (atomic_read(&inode->i_writecount) != self_wcount ||
1799 atomic_read(&inode->i_readcount) != self_rcount)
Jeff Layton24cbe782014-02-03 12:13:06 -05001800 return -EAGAIN;
1801
Amir Goldstein387e3742019-06-07 17:24:38 +03001802 return 0;
Jeff Layton24cbe782014-02-03 12:13:06 -05001803}
1804
Jeff Laytone6f5c782014-08-22 10:40:25 -04001805static int
1806generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807{
Jeff Layton8634b512015-01-16 15:05:55 -05001808 struct file_lock *fl, *my_fl = NULL, *lease;
Amir Goldstein387e3742019-06-07 17:24:38 +03001809 struct inode *inode = locks_inode(filp);
Jeff Layton8634b512015-01-16 15:05:55 -05001810 struct file_lock_context *ctx;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001811 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001812 int error;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001813 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814
J. Bruce Fields096657b2010-10-30 17:31:14 -04001815 lease = *flp;
Jeff Layton62af4f12014-05-09 14:13:05 -04001816 trace_generic_add_lease(inode, lease);
1817
Jeff Layton5c1c6692015-04-03 09:04:03 -04001818 /* Note that arg is never F_UNLCK here */
1819 ctx = locks_get_lock_context(inode, arg);
Jeff Layton8634b512015-01-16 15:05:55 -05001820 if (!ctx)
1821 return -ENOMEM;
1822
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001823 /*
1824 * In the delegation case we need mutual exclusion with
1825 * a number of operations that take the i_mutex. We trylock
1826 * because delegations are an optional optimization, and if
1827 * there's some chance of a conflict--we'd rather not
1828 * bother, maybe that's a sign this just isn't a good file to
1829 * hand out a delegation on.
1830 */
Al Viro59551022016-01-22 15:40:57 -05001831 if (is_deleg && !inode_trylock(inode))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001832 return -EAGAIN;
1833
1834 if (is_deleg && arg == F_WRLCK) {
1835 /* Write delegations are not currently supported: */
Al Viro59551022016-01-22 15:40:57 -05001836 inode_unlock(inode);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001837 WARN_ON_ONCE(1);
1838 return -EINVAL;
1839 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001840
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001841 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001842 spin_lock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001843 time_out_leases(inode, &dispose);
Amir Goldstein387e3742019-06-07 17:24:38 +03001844 error = check_conflicting_open(filp, arg, lease->fl_flags);
Jeff Layton24cbe782014-02-03 12:13:06 -05001845 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001846 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001847
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848 /*
1849 * At this point, we know that if there is an exclusive
1850 * lease on this file, then we hold it on this filp
1851 * (otherwise our open of this file would have blocked).
1852 * And if we are trying to acquire an exclusive lease,
1853 * then the file is not open by anyone (including us)
1854 * except for this filp.
1855 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001856 error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001857 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001858 if (fl->fl_file == filp &&
1859 fl->fl_owner == lease->fl_owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001860 my_fl = fl;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001861 continue;
1862 }
Jeff Layton8634b512015-01-16 15:05:55 -05001863
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001864 /*
1865 * No exclusive leases if someone else has a lease on
1866 * this file:
1867 */
1868 if (arg == F_WRLCK)
1869 goto out;
1870 /*
1871 * Modifying our existing lease is OK, but no getting a
1872 * new lease if someone else is opening for write:
1873 */
1874 if (fl->fl_flags & FL_UNLOCK_PENDING)
1875 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 }
1877
Jeff Layton8634b512015-01-16 15:05:55 -05001878 if (my_fl != NULL) {
Jeff Layton0164bf02015-03-04 17:34:32 -05001879 lease = my_fl;
1880 error = lease->fl_lmops->lm_change(lease, arg, &dispose);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001881 if (error)
1882 goto out;
1883 goto out_setup;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884 }
1885
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886 error = -EINVAL;
1887 if (!leases_enable)
1888 goto out;
1889
Jeff Laytone084c1b2015-02-16 14:32:03 -05001890 locks_insert_lock_ctx(lease, &ctx->flc_lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001891 /*
1892 * The check in break_lease() is lockless. It's possible for another
1893 * open to race in after we did the earlier check for a conflicting
1894 * open but before the lease was inserted. Check again for a
1895 * conflicting open and cancel the lease if there is one.
1896 *
1897 * We also add a barrier here to ensure that the insertion of the lock
1898 * precedes these checks.
1899 */
1900 smp_mb();
Amir Goldstein387e3742019-06-07 17:24:38 +03001901 error = check_conflicting_open(filp, arg, lease->fl_flags);
Jeff Layton8634b512015-01-16 15:05:55 -05001902 if (error) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001903 locks_unlink_lock_ctx(lease);
Jeff Layton8634b512015-01-16 15:05:55 -05001904 goto out;
1905 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001906
1907out_setup:
1908 if (lease->fl_lmops->lm_setup)
1909 lease->fl_lmops->lm_setup(lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910out:
Jeff Layton6109c852015-01-16 15:05:57 -05001911 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001912 percpu_up_read(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001913 locks_dispose_list(&dispose);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001914 if (is_deleg)
Al Viro59551022016-01-22 15:40:57 -05001915 inode_unlock(inode);
Jeff Layton8634b512015-01-16 15:05:55 -05001916 if (!error && !my_fl)
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001917 *flp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918 return error;
1919}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001920
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001921static int generic_delete_lease(struct file *filp, void *owner)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001922{
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001923 int error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001924 struct file_lock *fl, *victim = NULL;
Miklos Szeredic568d682016-09-16 12:44:20 +02001925 struct inode *inode = locks_inode(filp);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001926 struct file_lock_context *ctx;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001927 LIST_HEAD(dispose);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001928
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001929 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001930 if (!ctx) {
1931 trace_generic_delete_lease(inode, NULL);
1932 return error;
1933 }
1934
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001935 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001936 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001937 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001938 if (fl->fl_file == filp &&
1939 fl->fl_owner == owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001940 victim = fl;
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001941 break;
Jeff Layton8634b512015-01-16 15:05:55 -05001942 }
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001943 }
Jeff Laytona9b1b452015-03-14 09:45:35 -04001944 trace_generic_delete_lease(inode, victim);
Jeff Layton8634b512015-01-16 15:05:55 -05001945 if (victim)
Jeff Layton7448cc32015-01-16 15:05:57 -05001946 error = fl->fl_lmops->lm_change(victim, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05001947 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001948 percpu_up_read(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001949 locks_dispose_list(&dispose);
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001950 return error;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001951}
1952
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953/**
1954 * generic_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001955 * @filp: file pointer
1956 * @arg: type of lease to obtain
1957 * @flp: input - file_lock to use, output - file_lock inserted
1958 * @priv: private data for lm_setup (may be NULL if lm_setup
1959 * doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960 *
1961 * The (input) flp->fl_lmops->lm_break function is required
1962 * by break_lease().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001964int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
1965 void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966{
Miklos Szeredic568d682016-09-16 12:44:20 +02001967 struct inode *inode = locks_inode(filp);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001968 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001970 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001971 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001973 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 error = security_file_lock(filp, arg);
1975 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001976 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001978 switch (arg) {
1979 case F_UNLCK:
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001980 return generic_delete_lease(filp, *priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001981 case F_RDLCK:
1982 case F_WRLCK:
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001983 if (!(*flp)->fl_lmops->lm_break) {
1984 WARN_ON_ONCE(1);
1985 return -ENOLCK;
1986 }
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001987
Jeff Laytone6f5c782014-08-22 10:40:25 -04001988 return generic_add_lease(filp, arg, flp, priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001989 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001990 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001993EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994
Jeff Layton18f66222019-08-18 14:18:45 -04001995#if IS_ENABLED(CONFIG_SRCU)
1996/*
1997 * Kernel subsystems can register to be notified on any attempt to set
1998 * a new lease with the lease_notifier_chain. This is used by (e.g.) nfsd
1999 * to close files that it may have cached when there is an attempt to set a
2000 * conflicting lease.
2001 */
2002static struct srcu_notifier_head lease_notifier_chain;
2003
2004static inline void
2005lease_notifier_chain_init(void)
2006{
2007 srcu_init_notifier_head(&lease_notifier_chain);
2008}
2009
2010static inline void
2011setlease_notifier(long arg, struct file_lock *lease)
2012{
2013 if (arg != F_UNLCK)
2014 srcu_notifier_call_chain(&lease_notifier_chain, arg, lease);
2015}
2016
2017int lease_register_notifier(struct notifier_block *nb)
2018{
2019 return srcu_notifier_chain_register(&lease_notifier_chain, nb);
2020}
2021EXPORT_SYMBOL_GPL(lease_register_notifier);
2022
2023void lease_unregister_notifier(struct notifier_block *nb)
2024{
2025 srcu_notifier_chain_unregister(&lease_notifier_chain, nb);
2026}
2027EXPORT_SYMBOL_GPL(lease_unregister_notifier);
2028
2029#else /* !IS_ENABLED(CONFIG_SRCU) */
2030static inline void
2031lease_notifier_chain_init(void)
2032{
2033}
2034
2035static inline void
2036setlease_notifier(long arg, struct file_lock *lease)
2037{
2038}
2039
2040int lease_register_notifier(struct notifier_block *nb)
2041{
2042 return 0;
2043}
2044EXPORT_SYMBOL_GPL(lease_register_notifier);
2045
2046void lease_unregister_notifier(struct notifier_block *nb)
2047{
2048}
2049EXPORT_SYMBOL_GPL(lease_unregister_notifier);
2050
2051#endif /* IS_ENABLED(CONFIG_SRCU) */
2052
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002053/**
Jeff Laytone51673a2014-08-22 18:13:28 -04002054 * vfs_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002055 * @filp: file pointer
2056 * @arg: type of lease to obtain
2057 * @lease: file_lock to use when adding a lease
2058 * @priv: private info for lm_setup when adding a lease (may be
NeilBrown7bbd1fc2018-11-30 10:04:08 +11002059 * NULL if lm_setup doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 *
Jeff Laytone51673a2014-08-22 18:13:28 -04002061 * Call this to establish a lease on the file. The "lease" argument is not
2062 * used for F_UNLCK requests and may be NULL. For commands that set or alter
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04002063 * an existing lease, the ``(*lease)->fl_lmops->lm_break`` operation must be
2064 * set; if not, this function will return -ENOLCK (and generate a scary-looking
Jeff Laytone51673a2014-08-22 18:13:28 -04002065 * stack trace).
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002066 *
2067 * The "priv" pointer is passed directly to the lm_setup function as-is. It
2068 * may be NULL if the lm_setup operation doesn't require it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04002070int
2071vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072{
Jeff Layton18f66222019-08-18 14:18:45 -04002073 if (lease)
2074 setlease_notifier(arg, *lease);
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002075 if (filp->f_op->setlease)
Jeff Laytonf82b4b62014-08-22 18:50:48 -04002076 return filp->f_op->setlease(filp, arg, lease, priv);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002077 else
Jeff Laytonf82b4b62014-08-22 18:50:48 -04002078 return generic_setlease(filp, arg, lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04002080EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002082static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083{
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002084 struct file_lock *fl;
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002085 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 int error;
2087
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02002088 fl = lease_alloc(filp, arg);
2089 if (IS_ERR(fl))
2090 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002092 new = fasync_alloc();
2093 if (!new) {
2094 locks_free_lock(fl);
2095 return -ENOMEM;
2096 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002097 new->fa_fd = fd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002099 error = vfs_setlease(filp, arg, &fl, (void **)&new);
Jeff Layton2dfb9282014-08-11 18:14:12 -04002100 if (fl)
2101 locks_free_lock(fl);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002102 if (new)
2103 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 return error;
2105}
2106
2107/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002108 * fcntl_setlease - sets a lease on an open file
2109 * @fd: open file descriptor
2110 * @filp: file pointer
2111 * @arg: type of lease to obtain
2112 *
2113 * Call this fcntl to establish a lease on the file.
2114 * Note that you also need to call %F_SETSIG to
2115 * receive a signal when the lease is broken.
2116 */
2117int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
2118{
2119 if (arg == F_UNLCK)
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01002120 return vfs_setlease(filp, F_UNLCK, NULL, (void **)&filp);
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002121 return do_fcntl_add_lease(fd, filp, arg);
2122}
2123
2124/**
Jeff Layton29d01b22015-07-11 06:43:02 -04002125 * flock_lock_inode_wait - Apply a FLOCK-style lock to a file
2126 * @inode: inode of the file to apply to
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127 * @fl: The lock to be applied
2128 *
Jeff Layton29d01b22015-07-11 06:43:02 -04002129 * Apply a FLOCK style lock request to an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 */
Benjamin Coddington616fb382015-10-22 13:38:15 -04002131static int flock_lock_inode_wait(struct inode *inode, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132{
2133 int error;
2134 might_sleep();
2135 for (;;) {
Jeff Layton29d01b22015-07-11 06:43:02 -04002136 error = flock_lock_inode(inode, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07002137 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11002139 error = wait_event_interruptible(fl->fl_wait, !fl->fl_blocker);
NeilBrown16306a62018-11-30 10:04:08 +11002140 if (error)
2141 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 }
NeilBrown16306a62018-11-30 10:04:08 +11002143 locks_delete_block(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 return error;
2145}
2146
Jeff Layton29d01b22015-07-11 06:43:02 -04002147/**
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04002148 * locks_lock_inode_wait - Apply a lock to an inode
2149 * @inode: inode of the file to apply to
2150 * @fl: The lock to be applied
2151 *
2152 * Apply a POSIX or FLOCK style lock request to an inode.
2153 */
2154int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
2155{
2156 int res = 0;
2157 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
2158 case FL_POSIX:
2159 res = posix_lock_inode_wait(inode, fl);
2160 break;
2161 case FL_FLOCK:
2162 res = flock_lock_inode_wait(inode, fl);
2163 break;
2164 default:
2165 BUG();
2166 }
2167 return res;
2168}
2169EXPORT_SYMBOL(locks_lock_inode_wait);
2170
2171/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 * sys_flock: - flock() system call.
2173 * @fd: the file descriptor to lock.
2174 * @cmd: the type of lock to apply.
2175 *
2176 * Apply a %FL_FLOCK style lock to an open file descriptor.
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04002177 * The @cmd can be one of:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178 *
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04002179 * - %LOCK_SH -- a shared lock.
2180 * - %LOCK_EX -- an exclusive lock.
2181 * - %LOCK_UN -- remove an existing lock.
2182 * - %LOCK_MAND -- a 'mandatory' flock.
2183 * This exists to emulate Windows Share Modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 *
2185 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
2186 * processes read and write access respectively.
2187 */
Heiko Carstens002c8972009-01-14 14:14:18 +01002188SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189{
Al Viro2903ff02012-08-28 12:52:22 -04002190 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 struct file_lock *lock;
2192 int can_sleep, unlock;
2193 int error;
2194
2195 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04002196 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197 goto out;
2198
2199 can_sleep = !(cmd & LOCK_NB);
2200 cmd &= ~LOCK_NB;
2201 unlock = (cmd == LOCK_UN);
2202
Al Viroaeb5d722008-09-02 15:28:45 -04002203 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04002204 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205 goto out_putf;
2206
NeilBrownd6367d62018-11-30 10:04:08 +11002207 lock = flock_make_lock(f.file, cmd, NULL);
Jeff Layton6e129d002014-09-04 10:25:06 -04002208 if (IS_ERR(lock)) {
2209 error = PTR_ERR(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 goto out_putf;
Jeff Layton6e129d002014-09-04 10:25:06 -04002211 }
2212
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213 if (can_sleep)
2214 lock->fl_flags |= FL_SLEEP;
2215
Al Viro2903ff02012-08-28 12:52:22 -04002216 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 if (error)
2218 goto out_free;
2219
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002220 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04002221 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222 (can_sleep) ? F_SETLKW : F_SETLK,
2223 lock);
2224 else
Benjamin Coddington4f656362015-10-22 13:38:14 -04002225 error = locks_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226
2227 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08002228 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229
2230 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04002231 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232 out:
2233 return error;
2234}
2235
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002236/**
2237 * vfs_test_lock - test file byte range lock
2238 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04002239 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002240 *
2241 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
2242 * setting conf->fl_type to something other than F_UNLCK.
2243 */
2244int vfs_test_lock(struct file *filp, struct file_lock *fl)
2245{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002246 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002247 return filp->f_op->lock(filp, F_GETLK, fl);
2248 posix_test_lock(filp, fl);
2249 return 0;
2250}
2251EXPORT_SYMBOL_GPL(vfs_test_lock);
2252
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002253/**
2254 * locks_translate_pid - translate a file_lock's fl_pid number into a namespace
2255 * @fl: The file_lock who's fl_pid should be translated
2256 * @ns: The namespace into which the pid should be translated
2257 *
2258 * Used to tranlate a fl_pid into a namespace virtual pid number
2259 */
2260static pid_t locks_translate_pid(struct file_lock *fl, struct pid_namespace *ns)
2261{
2262 pid_t vnr;
2263 struct pid *pid;
2264
2265 if (IS_OFDLCK(fl))
2266 return -1;
2267 if (IS_REMOTELCK(fl))
2268 return fl->fl_pid;
Konstantin Khorenko826d7bc2018-06-08 17:27:11 +03002269 /*
2270 * If the flock owner process is dead and its pid has been already
2271 * freed, the translation below won't work, but we still want to show
2272 * flock owner pid number in init pidns.
2273 */
2274 if (ns == &init_pid_ns)
2275 return (pid_t)fl->fl_pid;
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002276
2277 rcu_read_lock();
2278 pid = find_pid_ns(fl->fl_pid, &init_pid_ns);
2279 vnr = pid_nr_ns(pid, ns);
2280 rcu_read_unlock();
2281 return vnr;
2282}
2283
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002284static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
2285{
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002286 flock->l_pid = locks_translate_pid(fl, task_active_pid_ns(current));
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002287#if BITS_PER_LONG == 32
2288 /*
2289 * Make sure we can represent the posix lock via
2290 * legacy 32bit flock.
2291 */
2292 if (fl->fl_start > OFFT_OFFSET_MAX)
2293 return -EOVERFLOW;
2294 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
2295 return -EOVERFLOW;
2296#endif
2297 flock->l_start = fl->fl_start;
2298 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2299 fl->fl_end - fl->fl_start + 1;
2300 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04002301 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002302 return 0;
2303}
2304
2305#if BITS_PER_LONG == 32
2306static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
2307{
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002308 flock->l_pid = locks_translate_pid(fl, task_active_pid_ns(current));
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002309 flock->l_start = fl->fl_start;
2310 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2311 fl->fl_end - fl->fl_start + 1;
2312 flock->l_whence = 0;
2313 flock->l_type = fl->fl_type;
2314}
2315#endif
2316
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317/* Report the first existing lock that would conflict with l.
2318 * This implements the F_GETLK command of fcntl().
2319 */
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002320int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321{
Benjamin Coddington52306e82017-07-16 10:28:21 -04002322 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323 int error;
2324
Benjamin Coddington52306e82017-07-16 10:28:21 -04002325 fl = locks_alloc_lock();
2326 if (fl == NULL)
2327 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002329 if (flock->l_type != F_RDLCK && flock->l_type != F_WRLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330 goto out;
2331
Benjamin Coddington52306e82017-07-16 10:28:21 -04002332 error = flock_to_posix_lock(filp, fl, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 if (error)
2334 goto out;
2335
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002336 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002337 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002338 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002339 goto out;
2340
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002341 cmd = F_GETLK;
Benjamin Coddington52306e82017-07-16 10:28:21 -04002342 fl->fl_flags |= FL_OFDLCK;
2343 fl->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002344 }
2345
Benjamin Coddington52306e82017-07-16 10:28:21 -04002346 error = vfs_test_lock(filp, fl);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002347 if (error)
2348 goto out;
NeilBrown7bbd1fc2018-11-30 10:04:08 +11002349
Benjamin Coddington52306e82017-07-16 10:28:21 -04002350 flock->l_type = fl->fl_type;
2351 if (fl->fl_type != F_UNLCK) {
2352 error = posix_lock_to_flock(flock, fl);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002353 if (error)
Benjamin Coddington52306e82017-07-16 10:28:21 -04002354 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356out:
Benjamin Coddington52306e82017-07-16 10:28:21 -04002357 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358 return error;
2359}
2360
Marc Eshel7723ec92007-01-18 15:08:55 -05002361/**
2362 * vfs_lock_file - file byte range lock
2363 * @filp: The file to apply the lock to
2364 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2365 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05002366 * @conf: Place to return a copy of the conflicting lock, if found.
2367 *
2368 * A caller that doesn't care about the conflicting lock may pass NULL
2369 * as the final argument.
2370 *
2371 * If the filesystem defines a private ->lock() method, then @conf will
2372 * be left unchanged; so a caller that cares should initialize it to
2373 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05002374 *
2375 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2376 * locks, the ->lock() interface may return asynchronously, before the lock has
2377 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002378 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05002379 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2380 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002381 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05002382 * request completes.
2383 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07002384 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2385 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05002386 * nonzero return code and the file system should release the lock. The file
2387 * system is also responsible to keep a corresponding posix lock when it
2388 * grants a lock so the VFS can find out which locks are locally held and do
2389 * the correct lock cleanup when required.
2390 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002391 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05002392 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05002393 */
Marc Eshel150b3932007-01-18 16:15:35 -05002394int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05002395{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002396 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05002397 return filp->f_op->lock(filp, cmd, fl);
2398 else
Marc Eshel150b3932007-01-18 16:15:35 -05002399 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05002400}
2401EXPORT_SYMBOL_GPL(vfs_lock_file);
2402
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002403static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2404 struct file_lock *fl)
2405{
2406 int error;
2407
2408 error = security_file_lock(filp, fl->fl_type);
2409 if (error)
2410 return error;
2411
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002412 for (;;) {
2413 error = vfs_lock_file(filp, cmd, fl, NULL);
2414 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002415 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11002416 error = wait_event_interruptible(fl->fl_wait, !fl->fl_blocker);
NeilBrown16306a62018-11-30 10:04:08 +11002417 if (error)
2418 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002419 }
NeilBrown16306a62018-11-30 10:04:08 +11002420 locks_delete_block(fl);
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002421
2422 return error;
2423}
2424
Benjamin Coddington6ca7d912015-10-15 09:07:07 -04002425/* Ensure that fl->fl_file has compatible f_mode for F_SETLK calls */
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002426static int
2427check_fmode_for_setlk(struct file_lock *fl)
2428{
2429 switch (fl->fl_type) {
2430 case F_RDLCK:
2431 if (!(fl->fl_file->f_mode & FMODE_READ))
2432 return -EBADF;
2433 break;
2434 case F_WRLCK:
2435 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2436 return -EBADF;
2437 }
2438 return 0;
2439}
2440
Linus Torvalds1da177e2005-04-16 15:20:36 -07002441/* Apply the lock described by l to an open file descriptor.
2442 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2443 */
Peter Staubachc2936212005-07-27 11:45:09 -07002444int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002445 struct flock *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446{
2447 struct file_lock *file_lock = locks_alloc_lock();
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002448 struct inode *inode = locks_inode(filp);
Al Viro0b2bac22008-05-06 13:58:34 -04002449 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450 int error;
2451
2452 if (file_lock == NULL)
2453 return -ENOLCK;
2454
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 /* Don't allow mandatory locks on files that may be memory mapped
2456 * and shared.
2457 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002458 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459 error = -EAGAIN;
2460 goto out;
2461 }
2462
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002463 error = flock_to_posix_lock(filp, file_lock, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464 if (error)
2465 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002466
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002467 error = check_fmode_for_setlk(file_lock);
2468 if (error)
2469 goto out;
2470
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002471 /*
2472 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002473 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002474 */
2475 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002476 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002477 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002478 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002479 goto out;
2480
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002481 cmd = F_SETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002482 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002483 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002484 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002485 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002486 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002487 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002488 goto out;
2489
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002490 cmd = F_SETLKW;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002491 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002492 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002493 /* Fallthrough */
2494 case F_SETLKW:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002495 file_lock->fl_flags |= FL_SLEEP;
2496 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002497
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002498 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002499
Peter Staubachc2936212005-07-27 11:45:09 -07002500 /*
Jeff Layton0752ba82016-01-08 07:30:43 -05002501 * Attempt to detect a close/fcntl race and recover by releasing the
2502 * lock that was just acquired. There is no need to do that when we're
2503 * unlocking though, or for OFD locks.
Peter Staubachc2936212005-07-27 11:45:09 -07002504 */
Jeff Layton0752ba82016-01-08 07:30:43 -05002505 if (!error && file_lock->fl_type != F_UNLCK &&
2506 !(file_lock->fl_flags & FL_OFDLCK)) {
Jeff Layton7f3697e2016-01-07 16:38:10 -05002507 /*
2508 * We need that spin_lock here - it prevents reordering between
2509 * update of i_flctx->flc_posix and check for it done in
2510 * close(). rcu_read_lock() wouldn't do.
2511 */
2512 spin_lock(&current->files->file_lock);
2513 f = fcheck(fd);
2514 spin_unlock(&current->files->file_lock);
2515 if (f != filp) {
2516 file_lock->fl_type = F_UNLCK;
2517 error = do_lock_file_wait(filp, cmd, file_lock);
2518 WARN_ON_ONCE(error);
2519 error = -EBADF;
2520 }
Peter Staubachc2936212005-07-27 11:45:09 -07002521 }
Peter Staubachc2936212005-07-27 11:45:09 -07002522out:
Jeff Layton18909102016-01-06 21:26:10 -05002523 trace_fcntl_setlk(inode, file_lock, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002524 locks_free_lock(file_lock);
2525 return error;
2526}
2527
2528#if BITS_PER_LONG == 32
2529/* Report the first existing lock that would conflict with l.
2530 * This implements the F_GETLK command of fcntl().
2531 */
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002532int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533{
Benjamin Coddington52306e82017-07-16 10:28:21 -04002534 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002535 int error;
2536
Benjamin Coddington52306e82017-07-16 10:28:21 -04002537 fl = locks_alloc_lock();
2538 if (fl == NULL)
2539 return -ENOMEM;
2540
Linus Torvalds1da177e2005-04-16 15:20:36 -07002541 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002542 if (flock->l_type != F_RDLCK && flock->l_type != F_WRLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543 goto out;
2544
Benjamin Coddington52306e82017-07-16 10:28:21 -04002545 error = flock64_to_posix_lock(filp, fl, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002546 if (error)
2547 goto out;
2548
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002549 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002550 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002551 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002552 goto out;
2553
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002554 cmd = F_GETLK64;
Benjamin Coddington52306e82017-07-16 10:28:21 -04002555 fl->fl_flags |= FL_OFDLCK;
2556 fl->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002557 }
2558
Benjamin Coddington52306e82017-07-16 10:28:21 -04002559 error = vfs_test_lock(filp, fl);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002560 if (error)
2561 goto out;
2562
Benjamin Coddington52306e82017-07-16 10:28:21 -04002563 flock->l_type = fl->fl_type;
2564 if (fl->fl_type != F_UNLCK)
2565 posix_lock_to_flock64(flock, fl);
Kinglong Meef3282962014-08-22 10:18:43 -04002566
Linus Torvalds1da177e2005-04-16 15:20:36 -07002567out:
Benjamin Coddington52306e82017-07-16 10:28:21 -04002568 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569 return error;
2570}
2571
2572/* Apply the lock described by l to an open file descriptor.
2573 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2574 */
Peter Staubachc2936212005-07-27 11:45:09 -07002575int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002576 struct flock64 *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002577{
2578 struct file_lock *file_lock = locks_alloc_lock();
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002579 struct inode *inode = locks_inode(filp);
Al Viro0b2bac22008-05-06 13:58:34 -04002580 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002581 int error;
2582
2583 if (file_lock == NULL)
2584 return -ENOLCK;
2585
Linus Torvalds1da177e2005-04-16 15:20:36 -07002586 /* Don't allow mandatory locks on files that may be memory mapped
2587 * and shared.
2588 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002589 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002590 error = -EAGAIN;
2591 goto out;
2592 }
2593
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002594 error = flock64_to_posix_lock(filp, file_lock, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595 if (error)
2596 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002597
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002598 error = check_fmode_for_setlk(file_lock);
2599 if (error)
2600 goto out;
2601
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002602 /*
2603 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002604 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002605 */
2606 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002607 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002608 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002609 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002610 goto out;
2611
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002612 cmd = F_SETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002613 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002614 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002615 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002616 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002617 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002618 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002619 goto out;
2620
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002621 cmd = F_SETLKW64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002622 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002623 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002624 /* Fallthrough */
2625 case F_SETLKW64:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626 file_lock->fl_flags |= FL_SLEEP;
2627 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002628
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002629 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002630
Peter Staubachc2936212005-07-27 11:45:09 -07002631 /*
Jeff Layton0752ba82016-01-08 07:30:43 -05002632 * Attempt to detect a close/fcntl race and recover by releasing the
2633 * lock that was just acquired. There is no need to do that when we're
2634 * unlocking though, or for OFD locks.
Peter Staubachc2936212005-07-27 11:45:09 -07002635 */
Jeff Layton0752ba82016-01-08 07:30:43 -05002636 if (!error && file_lock->fl_type != F_UNLCK &&
2637 !(file_lock->fl_flags & FL_OFDLCK)) {
Jeff Layton7f3697e2016-01-07 16:38:10 -05002638 /*
2639 * We need that spin_lock here - it prevents reordering between
2640 * update of i_flctx->flc_posix and check for it done in
2641 * close(). rcu_read_lock() wouldn't do.
2642 */
2643 spin_lock(&current->files->file_lock);
2644 f = fcheck(fd);
2645 spin_unlock(&current->files->file_lock);
2646 if (f != filp) {
2647 file_lock->fl_type = F_UNLCK;
2648 error = do_lock_file_wait(filp, cmd, file_lock);
2649 WARN_ON_ONCE(error);
2650 error = -EBADF;
2651 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002652 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002653out:
2654 locks_free_lock(file_lock);
2655 return error;
2656}
2657#endif /* BITS_PER_LONG == 32 */
2658
2659/*
2660 * This function is called when the file is being removed
2661 * from the task's fd array. POSIX locks belonging to this task
2662 * are deleted at this time.
2663 */
2664void locks_remove_posix(struct file *filp, fl_owner_t owner)
2665{
Jeff Layton18909102016-01-06 21:26:10 -05002666 int error;
Miklos Szeredic568d682016-09-16 12:44:20 +02002667 struct inode *inode = locks_inode(filp);
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002668 struct file_lock lock;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002669 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002670
2671 /*
2672 * If there are no locks held on this file, we don't need to call
2673 * posix_lock_file(). Another process could be setting a lock on this
2674 * file at the same time, but we wouldn't remove that lock anyway.
2675 */
Miklos Szeredic568d682016-09-16 12:44:20 +02002676 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05002677 if (!ctx || list_empty(&ctx->flc_posix))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002678 return;
2679
NeilBrownd6367d62018-11-30 10:04:08 +11002680 locks_init_lock(&lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002682 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683 lock.fl_start = 0;
2684 lock.fl_end = OFFSET_MAX;
2685 lock.fl_owner = owner;
2686 lock.fl_pid = current->tgid;
2687 lock.fl_file = filp;
2688 lock.fl_ops = NULL;
2689 lock.fl_lmops = NULL;
2690
Jeff Layton18909102016-01-06 21:26:10 -05002691 error = vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002692
Linus Torvalds1da177e2005-04-16 15:20:36 -07002693 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2694 lock.fl_ops->fl_release_private(&lock);
Miklos Szeredic568d682016-09-16 12:44:20 +02002695 trace_locks_remove_posix(inode, &lock, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002696}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002697EXPORT_SYMBOL(locks_remove_posix);
2698
Jeff Layton3d8e5602015-01-16 15:05:58 -05002699/* The i_flctx must be valid when calling into here */
Jeff Laytondd459bb2015-01-16 15:05:54 -05002700static void
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002701locks_remove_flock(struct file *filp, struct file_lock_context *flctx)
Jeff Laytondd459bb2015-01-16 15:05:54 -05002702{
NeilBrownd6367d62018-11-30 10:04:08 +11002703 struct file_lock fl;
Miklos Szeredic568d682016-09-16 12:44:20 +02002704 struct inode *inode = locks_inode(filp);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002705
Jeff Layton3d8e5602015-01-16 15:05:58 -05002706 if (list_empty(&flctx->flc_flock))
Jeff Laytondd459bb2015-01-16 15:05:54 -05002707 return;
2708
NeilBrownd6367d62018-11-30 10:04:08 +11002709 flock_make_lock(filp, LOCK_UN, &fl);
2710 fl.fl_flags |= FL_CLOSE;
2711
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002712 if (filp->f_op->flock)
Jeff Laytondd459bb2015-01-16 15:05:54 -05002713 filp->f_op->flock(filp, F_SETLKW, &fl);
2714 else
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04002715 flock_lock_inode(inode, &fl);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002716
2717 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2718 fl.fl_ops->fl_release_private(&fl);
2719}
2720
Jeff Layton3d8e5602015-01-16 15:05:58 -05002721/* The i_flctx must be valid when calling into here */
Jeff Layton8634b512015-01-16 15:05:55 -05002722static void
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002723locks_remove_lease(struct file *filp, struct file_lock_context *ctx)
Jeff Layton8634b512015-01-16 15:05:55 -05002724{
Jeff Layton8634b512015-01-16 15:05:55 -05002725 struct file_lock *fl, *tmp;
2726 LIST_HEAD(dispose);
2727
Jeff Layton3d8e5602015-01-16 15:05:58 -05002728 if (list_empty(&ctx->flc_lease))
Jeff Layton8634b512015-01-16 15:05:55 -05002729 return;
2730
Peter Zijlstra02e525b22019-02-21 15:38:40 +01002731 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05002732 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05002733 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list)
Jeff Laytonc4e136c2015-02-16 19:37:42 -05002734 if (filp == fl->fl_file)
2735 lease_modify(fl, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05002736 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01002737 percpu_up_read(&file_rwsem);
Peter Zijlstra5f430862016-10-08 10:12:28 +02002738
Jeff Layton8634b512015-01-16 15:05:55 -05002739 locks_dispose_list(&dispose);
2740}
2741
Linus Torvalds1da177e2005-04-16 15:20:36 -07002742/*
2743 * This function is called on the last close of an open file.
2744 */
Jeff Layton78ed8a12014-02-03 12:13:08 -05002745void locks_remove_file(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746{
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002747 struct file_lock_context *ctx;
2748
Miklos Szeredic568d682016-09-16 12:44:20 +02002749 ctx = smp_load_acquire(&locks_inode(filp)->i_flctx);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002750 if (!ctx)
Jeff Layton3d8e5602015-01-16 15:05:58 -05002751 return;
2752
Jeff Laytondd459bb2015-01-16 15:05:54 -05002753 /* remove any OFD locks */
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002754 locks_remove_posix(filp, filp);
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002755
Jeff Laytondd459bb2015-01-16 15:05:54 -05002756 /* remove flock locks */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002757 locks_remove_flock(filp, ctx);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002758
Jeff Layton8634b512015-01-16 15:05:55 -05002759 /* remove any leases */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002760 locks_remove_lease(filp, ctx);
Benjamin Coddington39537042017-07-21 13:36:25 -04002761
2762 spin_lock(&ctx->flc_lock);
2763 locks_check_ctx_file_list(filp, &ctx->flc_posix, "POSIX");
2764 locks_check_ctx_file_list(filp, &ctx->flc_flock, "FLOCK");
2765 locks_check_ctx_file_list(filp, &ctx->flc_lease, "LEASE");
2766 spin_unlock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002767}
2768
2769/**
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002770 * vfs_cancel_lock - file byte range unblock lock
2771 * @filp: The file to apply the unblock to
2772 * @fl: The lock to be unblocked
2773 *
2774 * Used by lock managers to cancel blocked requests
2775 */
2776int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2777{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002778 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002779 return filp->f_op->lock(filp, F_CANCELLK, fl);
2780 return 0;
2781}
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002782EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2783
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002784#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002785#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002786#include <linux/seq_file.h>
2787
Jeff Layton7012b022013-06-21 08:58:22 -04002788struct locks_iterator {
2789 int li_cpu;
2790 loff_t li_pos;
2791};
2792
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002793static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002794 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795{
2796 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002797 unsigned int fl_pid;
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002798 struct pid_namespace *proc_pidns = file_inode(f->file)->i_sb->s_fs_info;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002799
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002800 fl_pid = locks_translate_pid(fl, proc_pidns);
2801 /*
Konstantin Khorenko1cf8e5d2018-06-08 17:27:12 +03002802 * If lock owner is dead (and pid is freed) or not visible in current
2803 * pidns, zero is shown as a pid value. Check lock info from
2804 * init_pid_ns to get saved lock pid value.
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002805 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806
2807 if (fl->fl_file != NULL)
Miklos Szeredic568d682016-09-16 12:44:20 +02002808 inode = locks_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809
Jerome Marchand99dc8292010-10-26 14:22:33 -07002810 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002811 if (IS_POSIX(fl)) {
Jeff Laytonc918d422014-02-03 12:13:09 -05002812 if (fl->fl_flags & FL_ACCESS)
Fabian Frederick5315c262014-05-09 14:13:05 -04002813 seq_puts(f, "ACCESS");
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002814 else if (IS_OFDLCK(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002815 seq_puts(f, "OFDLCK");
Jeff Laytonc918d422014-02-03 12:13:09 -05002816 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002817 seq_puts(f, "POSIX ");
Jeff Laytonc918d422014-02-03 12:13:09 -05002818
2819 seq_printf(f, " %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002820 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002821 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002822 } else if (IS_FLOCK(fl)) {
2823 if (fl->fl_type & LOCK_MAND) {
Fabian Frederick5315c262014-05-09 14:13:05 -04002824 seq_puts(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002825 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002826 seq_puts(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002827 }
2828 } else if (IS_LEASE(fl)) {
Jeff Layton8144f1f2014-08-11 13:36:54 -04002829 if (fl->fl_flags & FL_DELEG)
2830 seq_puts(f, "DELEG ");
2831 else
2832 seq_puts(f, "LEASE ");
2833
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002834 if (lease_breaking(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002835 seq_puts(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002836 else if (fl->fl_file)
Fabian Frederick5315c262014-05-09 14:13:05 -04002837 seq_puts(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002838 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002839 seq_puts(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002840 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002841 seq_puts(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002842 }
2843 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002844 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002845 (fl->fl_type & LOCK_READ)
2846 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2847 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2848 } else {
Pavel Begunkov43e4cb92019-07-24 20:16:31 +03002849 int type = IS_LEASE(fl) ? target_leasetype(fl) : fl->fl_type;
2850
2851 seq_printf(f, "%s ", (type == F_WRLCK) ? "WRITE" :
2852 (type == F_RDLCK) ? "READ" : "UNLCK");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002853 }
2854 if (inode) {
Jeff Layton36488882015-04-03 09:04:04 -04002855 /* userspace relies on this representation of dev_t */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002856 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002857 MAJOR(inode->i_sb->s_dev),
2858 MINOR(inode->i_sb->s_dev), inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002859 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002860 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002861 }
2862 if (IS_POSIX(fl)) {
2863 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002864 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002865 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002866 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002867 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002868 seq_puts(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002869 }
2870}
2871
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002872static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002873{
Jeff Layton7012b022013-06-21 08:58:22 -04002874 struct locks_iterator *iter = f->private;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002875 struct file_lock *fl, *bfl;
Nikolay Borisovd67fd442016-08-17 16:18:46 -04002876 struct pid_namespace *proc_pidns = file_inode(f->file)->i_sb->s_fs_info;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002877
Jeff Layton139ca042013-06-21 08:58:17 -04002878 fl = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002879
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002880 if (locks_translate_pid(fl, proc_pidns) == 0)
Nikolay Borisovd67fd442016-08-17 16:18:46 -04002881 return 0;
2882
Jeff Layton7012b022013-06-21 08:58:22 -04002883 lock_get_status(f, fl, iter->li_pos, "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002884
NeilBrownada5c1d2018-11-30 10:04:08 +11002885 list_for_each_entry(bfl, &fl->fl_blocked_requests, fl_blocked_member)
Jeff Layton7012b022013-06-21 08:58:22 -04002886 lock_get_status(f, bfl, iter->li_pos, " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002887
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002888 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002889}
2890
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002891static void __show_fd_locks(struct seq_file *f,
2892 struct list_head *head, int *id,
2893 struct file *filp, struct files_struct *files)
2894{
2895 struct file_lock *fl;
2896
2897 list_for_each_entry(fl, head, fl_list) {
2898
2899 if (filp != fl->fl_file)
2900 continue;
2901 if (fl->fl_owner != files &&
2902 fl->fl_owner != filp)
2903 continue;
2904
2905 (*id)++;
2906 seq_puts(f, "lock:\t");
2907 lock_get_status(f, fl, *id, "");
2908 }
2909}
2910
2911void show_fd_locks(struct seq_file *f,
2912 struct file *filp, struct files_struct *files)
2913{
Miklos Szeredic568d682016-09-16 12:44:20 +02002914 struct inode *inode = locks_inode(filp);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002915 struct file_lock_context *ctx;
2916 int id = 0;
2917
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002918 ctx = smp_load_acquire(&inode->i_flctx);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002919 if (!ctx)
2920 return;
2921
2922 spin_lock(&ctx->flc_lock);
2923 __show_fd_locks(f, &ctx->flc_flock, &id, filp, files);
2924 __show_fd_locks(f, &ctx->flc_posix, &id, filp, files);
2925 __show_fd_locks(f, &ctx->flc_lease, &id, filp, files);
2926 spin_unlock(&ctx->flc_lock);
2927}
2928
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002929static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002930 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002931{
Jeff Layton7012b022013-06-21 08:58:22 -04002932 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002933
Jeff Layton7012b022013-06-21 08:58:22 -04002934 iter->li_pos = *pos + 1;
Peter Zijlstraaba37662015-06-22 14:16:33 +02002935 percpu_down_write(&file_rwsem);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002936 spin_lock(&blocked_lock_lock);
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002937 return seq_hlist_start_percpu(&file_lock_list.hlist, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002938}
2939
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002940static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2941{
Jeff Layton7012b022013-06-21 08:58:22 -04002942 struct locks_iterator *iter = f->private;
2943
2944 ++iter->li_pos;
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002945 return seq_hlist_next_percpu(v, &file_lock_list.hlist, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002946}
2947
2948static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002949 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002950{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002951 spin_unlock(&blocked_lock_lock);
Peter Zijlstraaba37662015-06-22 14:16:33 +02002952 percpu_up_write(&file_rwsem);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002953}
2954
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002955static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002956 .start = locks_start,
2957 .next = locks_next,
2958 .stop = locks_stop,
2959 .show = locks_show,
2960};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002961
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002962static int __init proc_locks_init(void)
2963{
Christoph Hellwig44414d82018-04-24 17:05:17 +02002964 proc_create_seq_private("locks", 0, NULL, &locks_seq_operations,
2965 sizeof(struct locks_iterator), NULL);
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002966 return 0;
2967}
Paul Gortmaker91899222015-12-17 14:11:03 -05002968fs_initcall(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002969#endif
2970
Linus Torvalds1da177e2005-04-16 15:20:36 -07002971static int __init filelock_init(void)
2972{
Jeff Layton7012b022013-06-21 08:58:22 -04002973 int i;
2974
Jeff Layton4a075e32015-01-16 15:05:54 -05002975 flctx_cache = kmem_cache_create("file_lock_ctx",
2976 sizeof(struct file_lock_context), 0, SLAB_PANIC, NULL);
2977
Linus Torvalds1da177e2005-04-16 15:20:36 -07002978 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002979 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2980
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002981 for_each_possible_cpu(i) {
2982 struct file_lock_list_struct *fll = per_cpu_ptr(&file_lock_list, i);
2983
2984 spin_lock_init(&fll->lock);
2985 INIT_HLIST_HEAD(&fll->hlist);
2986 }
Jeff Layton7012b022013-06-21 08:58:22 -04002987
Jeff Layton18f66222019-08-18 14:18:45 -04002988 lease_notifier_chain_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002989 return 0;
2990}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002991core_initcall(filelock_init);