blob: 3d6fb4ae847b4c6084c4f9745f2effce71ea6d78 [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.
Mauro Carvalho Chehaba02dcdf2020-04-27 23:17:08 +020064 * See 'Documentation/filesystems/mandatory-locking.rst' 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;
Luo Meng16238412020-10-23 14:20:05 +0800545 fl->fl_end = fl->fl_start + (l->l_len - 1);
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500546
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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728}
729
NeilBrownad6bbd82018-11-30 10:04:08 +1100730static void __locks_wake_up_blocks(struct file_lock *blocker)
731{
732 while (!list_empty(&blocker->fl_blocked_requests)) {
733 struct file_lock *waiter;
734
735 waiter = list_first_entry(&blocker->fl_blocked_requests,
736 struct file_lock, fl_blocked_member);
737 __locks_delete_block(waiter);
738 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
739 waiter->fl_lmops->lm_notify(waiter);
740 else
741 wake_up(&waiter->fl_wait);
Linus Torvaldsdcf23ac2020-03-18 07:52:21 -0400742
743 /*
744 * The setting of fl_blocker to NULL marks the "done"
745 * point in deleting a block. Paired with acquire at the top
746 * of locks_delete_block().
747 */
748 smp_store_release(&waiter->fl_blocker, NULL);
NeilBrownad6bbd82018-11-30 10:04:08 +1100749 }
750}
751
NeilBrowncb03f942018-11-30 10:04:08 +1100752/**
Mauro Carvalho Chehab529adfe2020-10-23 18:33:23 +0200753 * locks_delete_block - stop waiting for a file lock
NeilBrowncb03f942018-11-30 10:04:08 +1100754 * @waiter: the lock which was waiting
755 *
756 * lockd/nfsd need to disconnect the lock while working on it.
757 */
758int locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759{
NeilBrowncb03f942018-11-30 10:04:08 +1100760 int status = -ENOENT;
761
Linus Torvaldsdcf23ac2020-03-18 07:52:21 -0400762 /*
763 * If fl_blocker is NULL, it won't be set again as this thread "owns"
764 * the lock and is the only one that might try to claim the lock.
765 *
766 * We use acquire/release to manage fl_blocker so that we can
767 * optimize away taking the blocked_lock_lock in many cases.
768 *
769 * The smp_load_acquire guarantees two things:
770 *
771 * 1/ that fl_blocked_requests can be tested locklessly. If something
772 * was recently added to that list it must have been in a locked region
773 * *before* the locked region when fl_blocker was set to NULL.
774 *
775 * 2/ that no other thread is accessing 'waiter', so it is safe to free
776 * it. __locks_wake_up_blocks is careful not to touch waiter after
777 * fl_blocker is released.
778 *
779 * If a lockless check of fl_blocker shows it to be NULL, we know that
780 * no new locks can be inserted into its fl_blocked_requests list, and
781 * can avoid doing anything further if the list is empty.
782 */
783 if (!smp_load_acquire(&waiter->fl_blocker) &&
784 list_empty(&waiter->fl_blocked_requests))
785 return status;
786
Jeff Layton7b2296a2013-06-21 08:58:20 -0400787 spin_lock(&blocked_lock_lock);
NeilBrowncb03f942018-11-30 10:04:08 +1100788 if (waiter->fl_blocker)
789 status = 0;
NeilBrown5946c432018-11-30 10:04:08 +1100790 __locks_wake_up_blocks(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 __locks_delete_block(waiter);
Linus Torvaldsdcf23ac2020-03-18 07:52:21 -0400792
793 /*
794 * The setting of fl_blocker to NULL marks the "done" point in deleting
795 * a block. Paired with acquire at the top of this function.
796 */
797 smp_store_release(&waiter->fl_blocker, NULL);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400798 spin_unlock(&blocked_lock_lock);
NeilBrowncb03f942018-11-30 10:04:08 +1100799 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800}
NeilBrowncb03f942018-11-30 10:04:08 +1100801EXPORT_SYMBOL(locks_delete_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
803/* Insert waiter into blocker's block list.
804 * We use a circular list so that processes can be easily woken up in
805 * the order they blocked. The documentation doesn't require this but
806 * it seems like the reasonable thing to do.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400807 *
Jeff Layton6109c852015-01-16 15:05:57 -0500808 * Must be called with both the flc_lock and blocked_lock_lock held. The
NeilBrownada5c1d2018-11-30 10:04:08 +1100809 * fl_blocked_requests list itself is protected by the blocked_lock_lock,
810 * but by ensuring that the flc_lock is also held on insertions we can avoid
811 * taking the blocked_lock_lock in some cases when we see that the
812 * fl_blocked_requests list is empty.
NeilBrownfd7732e2018-11-30 10:04:08 +1100813 *
814 * Rather than just adding to the list, we check for conflicts with any existing
815 * waiters, and add beneath any waiter that blocks the new waiter.
816 * Thus wakeups don't happen until needed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400818static void __locks_insert_block(struct file_lock *blocker,
NeilBrownfd7732e2018-11-30 10:04:08 +1100819 struct file_lock *waiter,
820 bool conflict(struct file_lock *,
821 struct file_lock *))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822{
NeilBrownfd7732e2018-11-30 10:04:08 +1100823 struct file_lock *fl;
NeilBrownada5c1d2018-11-30 10:04:08 +1100824 BUG_ON(!list_empty(&waiter->fl_blocked_member));
NeilBrownfd7732e2018-11-30 10:04:08 +1100825
826new_blocker:
827 list_for_each_entry(fl, &blocker->fl_blocked_requests, fl_blocked_member)
828 if (conflict(fl, waiter)) {
829 blocker = fl;
830 goto new_blocker;
831 }
NeilBrownada5c1d2018-11-30 10:04:08 +1100832 waiter->fl_blocker = blocker;
833 list_add_tail(&waiter->fl_blocked_member, &blocker->fl_blocked_requests);
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400834 if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400835 locks_insert_global_blocked(waiter);
NeilBrown5946c432018-11-30 10:04:08 +1100836
837 /* The requests in waiter->fl_blocked are known to conflict with
838 * waiter, but might not conflict with blocker, or the requests
839 * and lock which block it. So they all need to be woken.
840 */
841 __locks_wake_up_blocks(waiter);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400842}
843
Jeff Layton6109c852015-01-16 15:05:57 -0500844/* Must be called with flc_lock held. */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400845static void locks_insert_block(struct file_lock *blocker,
NeilBrownfd7732e2018-11-30 10:04:08 +1100846 struct file_lock *waiter,
847 bool conflict(struct file_lock *,
848 struct file_lock *))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400849{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400850 spin_lock(&blocked_lock_lock);
NeilBrownfd7732e2018-11-30 10:04:08 +1100851 __locks_insert_block(blocker, waiter, conflict);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400852 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853}
854
Jeff Layton1cb36012013-06-21 08:58:12 -0400855/*
856 * Wake up processes blocked waiting for blocker.
857 *
Jeff Layton6109c852015-01-16 15:05:57 -0500858 * Must be called with the inode->flc_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 */
860static void locks_wake_up_blocks(struct file_lock *blocker)
861{
Jeff Layton4e8c7652013-06-21 08:58:16 -0400862 /*
863 * Avoid taking global lock if list is empty. This is safe since new
Jeff Layton6109c852015-01-16 15:05:57 -0500864 * blocked requests are only added to the list under the flc_lock, and
NeilBrownada5c1d2018-11-30 10:04:08 +1100865 * the flc_lock is always held here. Note that removal from the
866 * fl_blocked_requests list does not require the flc_lock, so we must
867 * recheck list_empty() after acquiring the blocked_lock_lock.
Jeff Layton4e8c7652013-06-21 08:58:16 -0400868 */
NeilBrownada5c1d2018-11-30 10:04:08 +1100869 if (list_empty(&blocker->fl_blocked_requests))
Jeff Layton4e8c7652013-06-21 08:58:16 -0400870 return;
871
Jeff Layton7b2296a2013-06-21 08:58:20 -0400872 spin_lock(&blocked_lock_lock);
NeilBrownad6bbd82018-11-30 10:04:08 +1100873 __locks_wake_up_blocks(blocker);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400874 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875}
876
Jeff Layton5263e312015-01-16 15:05:55 -0500877static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500878locks_insert_lock_ctx(struct file_lock *fl, struct list_head *before)
Jeff Layton5263e312015-01-16 15:05:55 -0500879{
Jeff Layton5263e312015-01-16 15:05:55 -0500880 list_add_tail(&fl->fl_list, before);
881 locks_insert_global_locks(fl);
882}
883
Jeff Layton8634b512015-01-16 15:05:55 -0500884static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500885locks_unlink_lock_ctx(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886{
Jeff Layton88974692013-06-21 08:58:14 -0400887 locks_delete_global_locks(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500888 list_del_init(&fl->fl_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 locks_wake_up_blocks(fl);
Jeff Layton24cbe782014-02-03 12:13:06 -0500890}
891
Jeff Layton5263e312015-01-16 15:05:55 -0500892static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500893locks_delete_lock_ctx(struct file_lock *fl, struct list_head *dispose)
Jeff Layton5263e312015-01-16 15:05:55 -0500894{
Jeff Laytone084c1b2015-02-16 14:32:03 -0500895 locks_unlink_lock_ctx(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500896 if (dispose)
897 list_add(&fl->fl_list, dispose);
898 else
899 locks_free_lock(fl);
Jeff Layton5263e312015-01-16 15:05:55 -0500900}
901
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
903 * checks for shared/exclusive status of overlapping locks.
904 */
NeilBrownc0e15902018-11-30 10:04:08 +1100905static bool locks_conflict(struct file_lock *caller_fl,
906 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907{
908 if (sys_fl->fl_type == F_WRLCK)
NeilBrownc0e15902018-11-30 10:04:08 +1100909 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 if (caller_fl->fl_type == F_WRLCK)
NeilBrownc0e15902018-11-30 10:04:08 +1100911 return true;
912 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913}
914
915/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
916 * checking before calling the locks_conflict().
917 */
NeilBrownc0e15902018-11-30 10:04:08 +1100918static bool posix_locks_conflict(struct file_lock *caller_fl,
919 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920{
921 /* POSIX locks owned by the same process do not conflict with
922 * each other.
923 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400924 if (posix_same_owner(caller_fl, sys_fl))
NeilBrownc0e15902018-11-30 10:04:08 +1100925 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926
927 /* Check whether they overlap */
928 if (!locks_overlap(caller_fl, sys_fl))
NeilBrownc0e15902018-11-30 10:04:08 +1100929 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930
NeilBrownc0e15902018-11-30 10:04:08 +1100931 return locks_conflict(caller_fl, sys_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932}
933
934/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
935 * checking before calling the locks_conflict().
936 */
NeilBrownc0e15902018-11-30 10:04:08 +1100937static bool flock_locks_conflict(struct file_lock *caller_fl,
938 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939{
940 /* FLOCK locks referring to the same filp do not conflict with
941 * each other.
942 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400943 if (caller_fl->fl_file == sys_fl->fl_file)
NeilBrownc0e15902018-11-30 10:04:08 +1100944 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
NeilBrownc0e15902018-11-30 10:04:08 +1100946 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947
NeilBrownc0e15902018-11-30 10:04:08 +1100948 return locks_conflict(caller_fl, sys_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949}
950
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400951void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500952posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953{
954 struct file_lock *cfl;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500955 struct file_lock_context *ctx;
Miklos Szeredic568d682016-09-16 12:44:20 +0200956 struct inode *inode = locks_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200958 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500959 if (!ctx || list_empty_careful(&ctx->flc_posix)) {
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400960 fl->fl_type = F_UNLCK;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500961 return;
962 }
963
Jeff Layton6109c852015-01-16 15:05:57 -0500964 spin_lock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500965 list_for_each_entry(cfl, &ctx->flc_posix, fl_list) {
966 if (posix_locks_conflict(fl, cfl)) {
967 locks_copy_conflock(fl, cfl);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500968 goto out;
969 }
970 }
971 fl->fl_type = F_UNLCK;
972out:
Jeff Layton6109c852015-01-16 15:05:57 -0500973 spin_unlock(&ctx->flc_lock);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400974 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976EXPORT_SYMBOL(posix_test_lock);
977
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400978/*
979 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400981 * We attempt to detect deadlocks that are due purely to posix file
982 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400984 * We assume that a task can be waiting for at most one lock at a time.
985 * So for any acquired lock, the process holding that lock may be
986 * waiting on at most one other lock. That lock in turns may be held by
987 * someone waiting for at most one other lock. Given a requested lock
988 * caller_fl which is about to wait for a conflicting lock block_fl, we
989 * follow this chain of waiters to ensure we are not about to create a
990 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400991 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400992 * Since we do this before we ever put a process to sleep on a lock, we
993 * are ensured that there is never a cycle; that is what guarantees that
994 * the while() loop in posix_locks_deadlock() eventually completes.
995 *
996 * Note: the above assumption may not be true when handling lock
997 * requests from a broken NFS client. It may also fail in the presence
998 * of tasks (such as posix threads) sharing the same open file table.
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400999 * To handle those cases, we just bail out after a few iterations.
Jeff Layton57b65322014-02-03 12:13:09 -05001000 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001001 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
Jeff Layton57b65322014-02-03 12:13:09 -05001002 * Because the owner is not even nominally tied to a thread of
1003 * execution, the deadlock detection below can't reasonably work well. Just
1004 * skip it for those.
1005 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001006 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
Jeff Layton57b65322014-02-03 12:13:09 -05001007 * locks that just checks for the case where two tasks are attempting to
1008 * upgrade from read to write locks on the same inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 */
J. Bruce Fields97855b42007-10-30 11:20:02 -04001010
1011#define MAX_DEADLK_ITERATIONS 10
1012
J. Bruce Fieldsb5331842007-10-26 18:05:40 -04001013/* Find a lock that the owner of the given block_fl is blocking on. */
1014static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
1015{
1016 struct file_lock *fl;
1017
Jeff Layton3999e492013-06-21 08:58:19 -04001018 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
NeilBrown5946c432018-11-30 10:04:08 +11001019 if (posix_same_owner(fl, block_fl)) {
1020 while (fl->fl_blocker)
1021 fl = fl->fl_blocker;
1022 return fl;
1023 }
J. Bruce Fieldsb5331842007-10-26 18:05:40 -04001024 }
1025 return NULL;
1026}
1027
Jeff Layton7b2296a2013-06-21 08:58:20 -04001028/* Must be called with the blocked_lock_lock held! */
Adrian Bunkb0904e12006-06-23 02:05:13 -07001029static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 struct file_lock *block_fl)
1031{
J. Bruce Fields97855b42007-10-30 11:20:02 -04001032 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033
Daniel Wagner663d5af2015-04-03 09:04:03 -04001034 lockdep_assert_held(&blocked_lock_lock);
1035
Jeff Layton57b65322014-02-03 12:13:09 -05001036 /*
1037 * This deadlock detector can't reasonably detect deadlocks with
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001038 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
Jeff Layton57b65322014-02-03 12:13:09 -05001039 */
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001040 if (IS_OFDLCK(caller_fl))
Jeff Layton57b65322014-02-03 12:13:09 -05001041 return 0;
1042
J. Bruce Fieldsb5331842007-10-26 18:05:40 -04001043 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
1044 if (i++ > MAX_DEADLK_ITERATIONS)
1045 return 0;
1046 if (posix_same_owner(caller_fl, block_fl))
1047 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 }
1049 return 0;
1050}
1051
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -04001053 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -04001054 *
1055 * Note that if called with an FL_EXISTS argument, the caller may determine
1056 * whether or not a lock was successfully freed by testing the return
1057 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 */
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04001059static int flock_lock_inode(struct inode *inode, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060{
Trond Myklebust993dfa82006-03-31 02:30:55 -08001061 struct file_lock *new_fl = NULL;
Jeff Layton5263e312015-01-16 15:05:55 -05001062 struct file_lock *fl;
1063 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 int error = 0;
Jeff Layton5263e312015-01-16 15:05:55 -05001065 bool found = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -04001066 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067
Jeff Layton5c1c6692015-04-03 09:04:03 -04001068 ctx = locks_get_lock_context(inode, request->fl_type);
1069 if (!ctx) {
1070 if (request->fl_type != F_UNLCK)
1071 return -ENOMEM;
1072 return (request->fl_flags & FL_EXISTS) ? -ENOENT : 0;
1073 }
Jeff Layton5263e312015-01-16 15:05:55 -05001074
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001075 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
1076 new_fl = locks_alloc_lock();
1077 if (!new_fl)
1078 return -ENOMEM;
1079 }
1080
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001081 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001082 spin_lock(&ctx->flc_lock);
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001083 if (request->fl_flags & FL_ACCESS)
1084 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +04001085
Jeff Layton5263e312015-01-16 15:05:55 -05001086 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04001087 if (request->fl_file != fl->fl_file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001089 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 goto out;
Jeff Layton5263e312015-01-16 15:05:55 -05001091 found = true;
Jeff Laytone084c1b2015-02-16 14:32:03 -05001092 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 break;
1094 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095
Trond Myklebustf475ae92006-06-29 16:38:32 -04001096 if (request->fl_type == F_UNLCK) {
1097 if ((request->fl_flags & FL_EXISTS) && !found)
1098 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001099 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001100 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001102find_conflict:
Jeff Layton5263e312015-01-16 15:05:55 -05001103 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Trond Myklebust993dfa82006-03-31 02:30:55 -08001104 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105 continue;
1106 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -07001107 if (!(request->fl_flags & FL_SLEEP))
1108 goto out;
1109 error = FILE_LOCK_DEFERRED;
NeilBrownfd7732e2018-11-30 10:04:08 +11001110 locks_insert_block(fl, request, flock_locks_conflict);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111 goto out;
1112 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001113 if (request->fl_flags & FL_ACCESS)
1114 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001115 locks_copy_lock(new_fl, request);
NeilBrown5946c432018-11-30 10:04:08 +11001116 locks_move_blocks(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001117 locks_insert_lock_ctx(new_fl, &ctx->flc_flock);
Trond Myklebust993dfa82006-03-31 02:30:55 -08001118 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +04001119 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120
1121out:
Jeff Layton6109c852015-01-16 15:05:57 -05001122 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001123 percpu_up_read(&file_rwsem);
Trond Myklebust993dfa82006-03-31 02:30:55 -08001124 if (new_fl)
1125 locks_free_lock(new_fl);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001126 locks_dispose_list(&dispose);
Jeff Laytonc883da32018-07-30 07:54:56 -04001127 trace_flock_lock_inode(inode, request, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 return error;
1129}
1130
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001131static int posix_lock_inode(struct inode *inode, struct file_lock *request,
1132 struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001134 struct file_lock *fl, *tmp;
Miklos Szeredi39005d02006-06-23 02:05:10 -07001135 struct file_lock *new_fl = NULL;
1136 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137 struct file_lock *left = NULL;
1138 struct file_lock *right = NULL;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001139 struct file_lock_context *ctx;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001140 int error;
1141 bool added = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -04001142 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143
Jeff Layton5c1c6692015-04-03 09:04:03 -04001144 ctx = locks_get_lock_context(inode, request->fl_type);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001145 if (!ctx)
Jeff Layton5c1c6692015-04-03 09:04:03 -04001146 return (request->fl_type == F_UNLCK) ? 0 : -ENOMEM;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001147
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148 /*
1149 * We may need two file_lock structures for this operation,
1150 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -07001151 *
1152 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153 */
Miklos Szeredi39005d02006-06-23 02:05:10 -07001154 if (!(request->fl_flags & FL_ACCESS) &&
1155 (request->fl_type != F_UNLCK ||
1156 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
1157 new_fl = locks_alloc_lock();
1158 new_fl2 = locks_alloc_lock();
1159 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001161 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001162 spin_lock(&ctx->flc_lock);
Jeff Layton1cb36012013-06-21 08:58:12 -04001163 /*
1164 * New lock request. Walk all POSIX locks and look for conflicts. If
1165 * there are any, either return error or put the request on the
Jeff Layton48f74182013-06-21 08:58:18 -04001166 * blocker's list of waiters and the global blocked_hash.
Jeff Layton1cb36012013-06-21 08:58:12 -04001167 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 if (request->fl_type != F_UNLCK) {
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001169 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170 if (!posix_locks_conflict(request, fl))
1171 continue;
Andy Adamson5842add2006-03-26 01:37:26 -08001172 if (conflock)
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001173 locks_copy_conflock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 error = -EAGAIN;
1175 if (!(request->fl_flags & FL_SLEEP))
1176 goto out;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001177 /*
1178 * Deadlock detection and insertion into the blocked
1179 * locks list must be done while holding the same lock!
1180 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 error = -EDEADLK;
Jeff Layton7b2296a2013-06-21 08:58:20 -04001182 spin_lock(&blocked_lock_lock);
Jeff Layton945ab8f2019-03-25 08:15:14 -04001183 /*
1184 * Ensure that we don't find any locks blocked on this
1185 * request during deadlock detection.
1186 */
1187 __locks_wake_up_blocks(request);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001188 if (likely(!posix_locks_deadlock(request, fl))) {
1189 error = FILE_LOCK_DEFERRED;
NeilBrownfd7732e2018-11-30 10:04:08 +11001190 __locks_insert_block(fl, request,
1191 posix_locks_conflict);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001192 }
Jeff Layton7b2296a2013-06-21 08:58:20 -04001193 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 goto out;
NeilBrown7bbd1fc2018-11-30 10:04:08 +11001195 }
1196 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197
1198 /* If we're just looking for a conflict, we're done. */
1199 error = 0;
1200 if (request->fl_flags & FL_ACCESS)
1201 goto out;
1202
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001203 /* Find the first old lock with the same owner as the new lock */
1204 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1205 if (posix_same_owner(request, fl))
1206 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 }
1208
Jeff Layton1cb36012013-06-21 08:58:12 -04001209 /* Process locks with this owner. */
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001210 list_for_each_entry_safe_from(fl, tmp, &ctx->flc_posix, fl_list) {
1211 if (!posix_same_owner(request, fl))
1212 break;
1213
1214 /* Detect adjacent or overlapping regions (if same lock type) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -07001216 /* In all comparisons of start vs end, use
1217 * "start - 1" rather than "end + 1". If end
1218 * is OFFSET_MAX, end + 1 will become negative.
1219 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 if (fl->fl_end < request->fl_start - 1)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001221 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 /* If the next lock in the list has entirely bigger
1223 * addresses than the new one, insert the lock here.
1224 */
Olaf Kirch449231d2005-08-25 16:25:35 -07001225 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 break;
1227
1228 /* If we come here, the new and old lock are of the
1229 * same type and adjacent or overlapping. Make one
1230 * lock yielding from the lower start address of both
1231 * locks to the higher end address.
1232 */
1233 if (fl->fl_start > request->fl_start)
1234 fl->fl_start = request->fl_start;
1235 else
1236 request->fl_start = fl->fl_start;
1237 if (fl->fl_end < request->fl_end)
1238 fl->fl_end = request->fl_end;
1239 else
1240 request->fl_end = fl->fl_end;
1241 if (added) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001242 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 continue;
1244 }
1245 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001246 added = true;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001247 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 /* Processing for different lock types is a bit
1249 * more complex.
1250 */
1251 if (fl->fl_end < request->fl_start)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001252 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 if (fl->fl_start > request->fl_end)
1254 break;
1255 if (request->fl_type == F_UNLCK)
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001256 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 if (fl->fl_start < request->fl_start)
1258 left = fl;
1259 /* If the next lock in the list has a higher end
1260 * address than the new one, insert the new one here.
1261 */
1262 if (fl->fl_end > request->fl_end) {
1263 right = fl;
1264 break;
1265 }
1266 if (fl->fl_start >= request->fl_start) {
1267 /* The new lock completely replaces an old
1268 * one (This may happen several times).
1269 */
1270 if (added) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001271 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 continue;
1273 }
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001274 /*
1275 * Replace the old lock with new_fl, and
1276 * remove the old one. It's safe to do the
1277 * insert here since we know that we won't be
1278 * using new_fl later, and that the lock is
1279 * just replacing an existing lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 */
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001281 error = -ENOLCK;
1282 if (!new_fl)
1283 goto out;
1284 locks_copy_lock(new_fl, request);
yangerkun5ef15962020-06-01 17:16:16 +08001285 locks_move_blocks(new_fl, request);
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001286 request = new_fl;
1287 new_fl = NULL;
Jeff Laytone084c1b2015-02-16 14:32:03 -05001288 locks_insert_lock_ctx(request, &fl->fl_list);
1289 locks_delete_lock_ctx(fl, &dispose);
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001290 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 }
1292 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 }
1294
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001295 /*
Jeff Layton1cb36012013-06-21 08:58:12 -04001296 * The above code only modifies existing locks in case of merging or
1297 * replacing. If new lock(s) need to be inserted all modifications are
1298 * done below this, so it's safe yet to bail out.
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001299 */
1300 error = -ENOLCK; /* "no luck" */
1301 if (right && left == right && !new_fl2)
1302 goto out;
1303
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 error = 0;
1305 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -04001306 if (request->fl_type == F_UNLCK) {
1307 if (request->fl_flags & FL_EXISTS)
1308 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001310 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001311
1312 if (!new_fl) {
1313 error = -ENOLCK;
1314 goto out;
1315 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 locks_copy_lock(new_fl, request);
NeilBrown5946c432018-11-30 10:04:08 +11001317 locks_move_blocks(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001318 locks_insert_lock_ctx(new_fl, &fl->fl_list);
Jeff Layton2e2f756f2015-02-17 17:08:23 -05001319 fl = new_fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 new_fl = NULL;
1321 }
1322 if (right) {
1323 if (left == right) {
1324 /* The new lock breaks the old one in two pieces,
1325 * so we have to use the second new lock.
1326 */
1327 left = new_fl2;
1328 new_fl2 = NULL;
1329 locks_copy_lock(left, right);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001330 locks_insert_lock_ctx(left, &fl->fl_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 }
1332 right->fl_start = request->fl_end + 1;
1333 locks_wake_up_blocks(right);
1334 }
1335 if (left) {
1336 left->fl_end = request->fl_start - 1;
1337 locks_wake_up_blocks(left);
1338 }
1339 out:
Jeff Layton6109c852015-01-16 15:05:57 -05001340 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001341 percpu_up_read(&file_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 /*
1343 * Free any unused locks.
1344 */
1345 if (new_fl)
1346 locks_free_lock(new_fl);
1347 if (new_fl2)
1348 locks_free_lock(new_fl2);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001349 locks_dispose_list(&dispose);
Jeff Layton18909102016-01-06 21:26:10 -05001350 trace_posix_lock_inode(inode, request, error);
1351
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 return error;
1353}
1354
1355/**
1356 * posix_lock_file - Apply a POSIX-style lock to a file
1357 * @filp: The file to apply the lock to
1358 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001359 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 *
1361 * Add a POSIX style lock to a file.
1362 * We merge adjacent & overlapping locks whenever possible.
1363 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001364 *
1365 * Note that if called with an FL_EXISTS argument, the caller may determine
1366 * whether or not a lock was successfully freed by testing the return
1367 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 */
Marc Eshel150b3932007-01-18 16:15:35 -05001369int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001370 struct file_lock *conflock)
1371{
Miklos Szeredic568d682016-09-16 12:44:20 +02001372 return posix_lock_inode(locks_inode(filp), fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001373}
Marc Eshel150b3932007-01-18 16:15:35 -05001374EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375
1376/**
Jeff Layton29d01b22015-07-11 06:43:02 -04001377 * posix_lock_inode_wait - Apply a POSIX-style lock to a file
1378 * @inode: inode of file to which lock request should be applied
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 * @fl: The lock to be applied
1380 *
Benjamin Coddington616fb382015-10-22 13:38:15 -04001381 * Apply a POSIX style lock request to an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 */
Benjamin Coddington616fb382015-10-22 13:38:15 -04001383static int posix_lock_inode_wait(struct inode *inode, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384{
1385 int error;
1386 might_sleep ();
1387 for (;;) {
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001388 error = posix_lock_inode(inode, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001389 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 break;
Linus Torvaldsdcf23ac2020-03-18 07:52:21 -04001391 error = wait_event_interruptible(fl->fl_wait,
1392 list_empty(&fl->fl_blocked_member));
NeilBrown16306a62018-11-30 10:04:08 +11001393 if (error)
1394 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 }
NeilBrown16306a62018-11-30 10:04:08 +11001396 locks_delete_block(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 return error;
1398}
Jeff Layton29d01b22015-07-11 06:43:02 -04001399
J. Bruce Fields778fc542011-07-26 18:25:49 -04001400static void lease_clear_pending(struct file_lock *fl, int arg)
1401{
1402 switch (arg) {
1403 case F_UNLCK:
1404 fl->fl_flags &= ~FL_UNLOCK_PENDING;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05001405 fallthrough;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001406 case F_RDLCK:
1407 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1408 }
1409}
1410
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411/* We already had a lease on this file; just change its type */
Jeff Layton7448cc32015-01-16 15:05:57 -05001412int lease_modify(struct file_lock *fl, int arg, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 int error = assign_type(fl, arg);
1415
1416 if (error)
1417 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001418 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001420 if (arg == F_UNLCK) {
1421 struct file *filp = fl->fl_file;
1422
1423 f_delown(filp);
1424 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001425 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1426 if (fl->fl_fasync != NULL) {
1427 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1428 fl->fl_fasync = NULL;
1429 }
Jeff Laytone084c1b2015-02-16 14:32:03 -05001430 locks_delete_lock_ctx(fl, dispose);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001431 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 return 0;
1433}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434EXPORT_SYMBOL(lease_modify);
1435
J. Bruce Fields778fc542011-07-26 18:25:49 -04001436static bool past_time(unsigned long then)
1437{
1438 if (!then)
1439 /* 0 is a special value meaning "this never expires": */
1440 return false;
1441 return time_after(jiffies, then);
1442}
1443
Jeff Laytonc45198e2014-09-01 07:12:07 -04001444static void time_out_leases(struct inode *inode, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445{
Jeff Layton8634b512015-01-16 15:05:55 -05001446 struct file_lock_context *ctx = inode->i_flctx;
1447 struct file_lock *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448
Jeff Layton6109c852015-01-16 15:05:57 -05001449 lockdep_assert_held(&ctx->flc_lock);
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001450
Jeff Layton8634b512015-01-16 15:05:55 -05001451 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001452 trace_time_out_leases(inode, fl);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001453 if (past_time(fl->fl_downgrade_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001454 lease_modify(fl, F_RDLCK, dispose);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001455 if (past_time(fl->fl_break_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001456 lease_modify(fl, F_UNLCK, dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 }
1458}
1459
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001460static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1461{
Ira Weinyd51f5272019-06-05 18:45:34 -07001462 bool rc;
1463
J. Bruce Fields28df3d12017-07-28 16:35:15 -04001464 if (lease->fl_lmops->lm_breaker_owns_lease
1465 && lease->fl_lmops->lm_breaker_owns_lease(lease))
1466 return false;
Ira Weinyd51f5272019-06-05 18:45:34 -07001467 if ((breaker->fl_flags & FL_LAYOUT) != (lease->fl_flags & FL_LAYOUT)) {
1468 rc = false;
1469 goto trace;
1470 }
1471 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE)) {
1472 rc = false;
1473 goto trace;
1474 }
1475
1476 rc = locks_conflict(breaker, lease);
1477trace:
1478 trace_leases_conflict(rc, lease, breaker);
1479 return rc;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001480}
1481
Jeff Layton03d12dd2014-09-01 14:53:41 -04001482static bool
1483any_leases_conflict(struct inode *inode, struct file_lock *breaker)
1484{
Jeff Layton8634b512015-01-16 15:05:55 -05001485 struct file_lock_context *ctx = inode->i_flctx;
Jeff Layton03d12dd2014-09-01 14:53:41 -04001486 struct file_lock *fl;
1487
Jeff Layton6109c852015-01-16 15:05:57 -05001488 lockdep_assert_held(&ctx->flc_lock);
Jeff Layton03d12dd2014-09-01 14:53:41 -04001489
Jeff Layton8634b512015-01-16 15:05:55 -05001490 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Jeff Layton03d12dd2014-09-01 14:53:41 -04001491 if (leases_conflict(fl, breaker))
1492 return true;
1493 }
1494 return false;
1495}
1496
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497/**
1498 * __break_lease - revoke all outstanding leases on file
1499 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001500 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1501 * break all leases
1502 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1503 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 *
david m. richter87250dd2007-05-09 16:10:27 -04001505 * break_lease (inlined for speed) has checked there already is at least
1506 * some kind of lock (maybe a lease) on this file. Leases are broken on
1507 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 * specified %O_NONBLOCK to your open().
1509 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001510int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001512 int error = 0;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001513 struct file_lock_context *ctx;
Yan, Zhenga9011252015-03-27 10:34:20 +08001514 struct file_lock *new_fl, *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 unsigned long break_time;
Al Viro8737c932009-12-24 06:47:55 -05001516 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001517 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518
Al Viro8737c932009-12-24 06:47:55 -05001519 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001520 if (IS_ERR(new_fl))
1521 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001522 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523
Jeff Layton8634b512015-01-16 15:05:55 -05001524 /* typically we will check that ctx is non-NULL before calling */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001525 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001526 if (!ctx) {
1527 WARN_ON_ONCE(1);
Wenwen Wangcfddf9f2019-08-19 18:47:34 -05001528 goto free_lock;
Jeff Layton8634b512015-01-16 15:05:55 -05001529 }
1530
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001531 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001532 spin_lock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533
Jeff Laytonc45198e2014-09-01 07:12:07 -04001534 time_out_leases(inode, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535
Jeff Layton03d12dd2014-09-01 14:53:41 -04001536 if (!any_leases_conflict(inode, new_fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001537 goto out;
1538
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539 break_time = 0;
1540 if (lease_break_time > 0) {
1541 break_time = jiffies + lease_break_time * HZ;
1542 if (break_time == 0)
1543 break_time++; /* so that 0 means no break time */
1544 }
1545
Yan, Zhenga9011252015-03-27 10:34:20 +08001546 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001547 if (!leases_conflict(fl, new_fl))
1548 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001549 if (want_write) {
1550 if (fl->fl_flags & FL_UNLOCK_PENDING)
1551 continue;
1552 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001554 } else {
Jeff Layton8634b512015-01-16 15:05:55 -05001555 if (lease_breaking(fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001556 continue;
1557 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1558 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 }
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001560 if (fl->fl_lmops->lm_break(fl))
Jeff Laytone084c1b2015-02-16 14:32:03 -05001561 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 }
1563
Jeff Layton8634b512015-01-16 15:05:55 -05001564 if (list_empty(&ctx->flc_lease))
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001565 goto out;
1566
Jeff Layton843c6b22014-09-01 14:27:43 -04001567 if (mode & O_NONBLOCK) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001568 trace_break_lease_noblock(inode, new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 error = -EWOULDBLOCK;
1570 goto out;
1571 }
1572
1573restart:
Jeff Layton8634b512015-01-16 15:05:55 -05001574 fl = list_first_entry(&ctx->flc_lease, struct file_lock, fl_list);
1575 break_time = fl->fl_break_time;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001576 if (break_time != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577 break_time -= jiffies;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001578 if (break_time == 0)
1579 break_time++;
NeilBrownfd7732e2018-11-30 10:04:08 +11001580 locks_insert_block(fl, new_fl, leases_conflict);
Jeff Layton62af4f12014-05-09 14:13:05 -04001581 trace_break_lease_block(inode, new_fl);
Jeff Layton6109c852015-01-16 15:05:57 -05001582 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001583 percpu_up_read(&file_rwsem);
Peter Zijlstraaba37662015-06-22 14:16:33 +02001584
Jeff Laytonc45198e2014-09-01 07:12:07 -04001585 locks_dispose_list(&dispose);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001586 error = wait_event_interruptible_timeout(new_fl->fl_wait,
Linus Torvaldsdcf23ac2020-03-18 07:52:21 -04001587 list_empty(&new_fl->fl_blocked_member),
1588 break_time);
Peter Zijlstraaba37662015-06-22 14:16:33 +02001589
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001590 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001591 spin_lock(&ctx->flc_lock);
Jeff Layton62af4f12014-05-09 14:13:05 -04001592 trace_break_lease_unblock(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001593 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 if (error >= 0) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001595 /*
1596 * Wait for the next conflicting lease that has not been
1597 * broken yet
1598 */
Jeff Layton03d12dd2014-09-01 14:53:41 -04001599 if (error == 0)
1600 time_out_leases(inode, &dispose);
1601 if (any_leases_conflict(inode, new_fl))
1602 goto restart;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 error = 0;
1604 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605out:
Jeff Layton6109c852015-01-16 15:05:57 -05001606 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001607 percpu_up_read(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001608 locks_dispose_list(&dispose);
Wenwen Wangcfddf9f2019-08-19 18:47:34 -05001609free_lock:
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001610 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 return error;
1612}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613EXPORT_SYMBOL(__break_lease);
1614
1615/**
Amir Goldstein76c47942018-01-03 17:14:34 +02001616 * lease_get_mtime - update modified time of an inode with exclusive lease
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 * @inode: the inode
Amir Goldstein76c47942018-01-03 17:14:34 +02001618 * @time: pointer to a timespec which contains the last modified time
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619 *
1620 * This is to force NFS clients to flush their caches for files with
1621 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001622 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001624void lease_get_mtime(struct inode *inode, struct timespec64 *time)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625{
Jeff Laytonbfe86022014-08-22 10:18:44 -04001626 bool has_lease = false;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001627 struct file_lock_context *ctx;
Jeff Layton8634b512015-01-16 15:05:55 -05001628 struct file_lock *fl;
Jeff Laytonbfe86022014-08-22 10:18:44 -04001629
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001630 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001631 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Jeff Layton6109c852015-01-16 15:05:57 -05001632 spin_lock(&ctx->flc_lock);
Geliang Tang8ace5df2015-11-18 21:40:33 +08001633 fl = list_first_entry_or_null(&ctx->flc_lease,
1634 struct file_lock, fl_list);
1635 if (fl && (fl->fl_type == F_WRLCK))
1636 has_lease = true;
Jeff Layton6109c852015-01-16 15:05:57 -05001637 spin_unlock(&ctx->flc_lock);
Jeff Laytonbfe86022014-08-22 10:18:44 -04001638 }
1639
1640 if (has_lease)
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001641 *time = current_time(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643EXPORT_SYMBOL(lease_get_mtime);
1644
1645/**
1646 * fcntl_getlease - Enquire what lease is currently active
1647 * @filp: the file
1648 *
1649 * The value returned by this function will be one of
1650 * (if no lease break is pending):
1651 *
1652 * %F_RDLCK to indicate a shared lease is held.
1653 *
1654 * %F_WRLCK to indicate an exclusive lease is held.
1655 *
1656 * %F_UNLCK to indicate no lease is held.
1657 *
1658 * (if a lease break is pending):
1659 *
1660 * %F_RDLCK to indicate an exclusive lease needs to be
1661 * changed to a shared lease (or removed).
1662 *
1663 * %F_UNLCK to indicate the lease needs to be removed.
1664 *
1665 * XXX: sfr & willy disagree over whether F_INPROGRESS
1666 * should be returned to userspace.
1667 */
1668int fcntl_getlease(struct file *filp)
1669{
1670 struct file_lock *fl;
Miklos Szeredic568d682016-09-16 12:44:20 +02001671 struct inode *inode = locks_inode(filp);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001672 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 int type = F_UNLCK;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001674 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001676 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001677 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001678 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001679 spin_lock(&ctx->flc_lock);
Miklos Szeredic568d682016-09-16 12:44:20 +02001680 time_out_leases(inode, &dispose);
Jeff Layton8634b512015-01-16 15:05:55 -05001681 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1682 if (fl->fl_file != filp)
1683 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001684 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 break;
1686 }
Jeff Layton6109c852015-01-16 15:05:57 -05001687 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001688 percpu_up_read(&file_rwsem);
Peter Zijlstra5f430862016-10-08 10:12:28 +02001689
Jeff Layton8634b512015-01-16 15:05:55 -05001690 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 return type;
1693}
1694
Jeff Layton24cbe782014-02-03 12:13:06 -05001695/**
Amir Goldstein387e3742019-06-07 17:24:38 +03001696 * check_conflicting_open - see if the given file points to an inode that has
NeilBrown7bbd1fc2018-11-30 10:04:08 +11001697 * an existing open that would conflict with the
1698 * desired lease.
Amir Goldstein387e3742019-06-07 17:24:38 +03001699 * @filp: file to check
Jeff Layton24cbe782014-02-03 12:13:06 -05001700 * @arg: type of lease that we're trying to acquire
Randy Dunlap7fadc592015-08-09 18:43:17 -07001701 * @flags: current lock flags
Jeff Layton24cbe782014-02-03 12:13:06 -05001702 *
1703 * Check to see if there's an existing open fd on this file that would
1704 * conflict with the lease we're trying to set.
1705 */
1706static int
Amir Goldstein387e3742019-06-07 17:24:38 +03001707check_conflicting_open(struct file *filp, const long arg, int flags)
Jeff Layton24cbe782014-02-03 12:13:06 -05001708{
Amir Goldstein387e3742019-06-07 17:24:38 +03001709 struct inode *inode = locks_inode(filp);
1710 int self_wcount = 0, self_rcount = 0;
Jeff Layton24cbe782014-02-03 12:13:06 -05001711
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001712 if (flags & FL_LAYOUT)
1713 return 0;
J. Bruce Fieldsaba20722021-04-16 14:00:18 -04001714 if (flags & FL_DELEG)
1715 /* We leave these checks to the caller */
1716 return 0;
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001717
Amir Goldstein387e3742019-06-07 17:24:38 +03001718 if (arg == F_RDLCK)
1719 return inode_is_open_for_write(inode) ? -EAGAIN : 0;
1720 else if (arg != F_WRLCK)
1721 return 0;
1722
1723 /*
1724 * Make sure that only read/write count is from lease requestor.
1725 * Note that this will result in denying write leases when i_writecount
1726 * is negative, which is what we want. (We shouldn't grant write leases
1727 * on files open for execution.)
1728 */
1729 if (filp->f_mode & FMODE_WRITE)
1730 self_wcount = 1;
1731 else if (filp->f_mode & FMODE_READ)
1732 self_rcount = 1;
1733
1734 if (atomic_read(&inode->i_writecount) != self_wcount ||
1735 atomic_read(&inode->i_readcount) != self_rcount)
Jeff Layton24cbe782014-02-03 12:13:06 -05001736 return -EAGAIN;
1737
Amir Goldstein387e3742019-06-07 17:24:38 +03001738 return 0;
Jeff Layton24cbe782014-02-03 12:13:06 -05001739}
1740
Jeff Laytone6f5c782014-08-22 10:40:25 -04001741static int
1742generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743{
Jeff Layton8634b512015-01-16 15:05:55 -05001744 struct file_lock *fl, *my_fl = NULL, *lease;
Amir Goldstein387e3742019-06-07 17:24:38 +03001745 struct inode *inode = locks_inode(filp);
Jeff Layton8634b512015-01-16 15:05:55 -05001746 struct file_lock_context *ctx;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001747 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001748 int error;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001749 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750
J. Bruce Fields096657b2010-10-30 17:31:14 -04001751 lease = *flp;
Jeff Layton62af4f12014-05-09 14:13:05 -04001752 trace_generic_add_lease(inode, lease);
1753
Jeff Layton5c1c6692015-04-03 09:04:03 -04001754 /* Note that arg is never F_UNLCK here */
1755 ctx = locks_get_lock_context(inode, arg);
Jeff Layton8634b512015-01-16 15:05:55 -05001756 if (!ctx)
1757 return -ENOMEM;
1758
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001759 /*
1760 * In the delegation case we need mutual exclusion with
1761 * a number of operations that take the i_mutex. We trylock
1762 * because delegations are an optional optimization, and if
1763 * there's some chance of a conflict--we'd rather not
1764 * bother, maybe that's a sign this just isn't a good file to
1765 * hand out a delegation on.
1766 */
Al Viro59551022016-01-22 15:40:57 -05001767 if (is_deleg && !inode_trylock(inode))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001768 return -EAGAIN;
1769
1770 if (is_deleg && arg == F_WRLCK) {
1771 /* Write delegations are not currently supported: */
Al Viro59551022016-01-22 15:40:57 -05001772 inode_unlock(inode);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001773 WARN_ON_ONCE(1);
1774 return -EINVAL;
1775 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001776
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001777 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001778 spin_lock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001779 time_out_leases(inode, &dispose);
Amir Goldstein387e3742019-06-07 17:24:38 +03001780 error = check_conflicting_open(filp, arg, lease->fl_flags);
Jeff Layton24cbe782014-02-03 12:13:06 -05001781 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001782 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001783
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 /*
1785 * At this point, we know that if there is an exclusive
1786 * lease on this file, then we hold it on this filp
1787 * (otherwise our open of this file would have blocked).
1788 * And if we are trying to acquire an exclusive lease,
1789 * then the file is not open by anyone (including us)
1790 * except for this filp.
1791 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001792 error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001793 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001794 if (fl->fl_file == filp &&
1795 fl->fl_owner == lease->fl_owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001796 my_fl = fl;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001797 continue;
1798 }
Jeff Layton8634b512015-01-16 15:05:55 -05001799
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001800 /*
1801 * No exclusive leases if someone else has a lease on
1802 * this file:
1803 */
1804 if (arg == F_WRLCK)
1805 goto out;
1806 /*
1807 * Modifying our existing lease is OK, but no getting a
1808 * new lease if someone else is opening for write:
1809 */
1810 if (fl->fl_flags & FL_UNLOCK_PENDING)
1811 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 }
1813
Jeff Layton8634b512015-01-16 15:05:55 -05001814 if (my_fl != NULL) {
Jeff Layton0164bf02015-03-04 17:34:32 -05001815 lease = my_fl;
1816 error = lease->fl_lmops->lm_change(lease, arg, &dispose);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001817 if (error)
1818 goto out;
1819 goto out_setup;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 }
1821
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 error = -EINVAL;
1823 if (!leases_enable)
1824 goto out;
1825
Jeff Laytone084c1b2015-02-16 14:32:03 -05001826 locks_insert_lock_ctx(lease, &ctx->flc_lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001827 /*
1828 * The check in break_lease() is lockless. It's possible for another
1829 * open to race in after we did the earlier check for a conflicting
1830 * open but before the lease was inserted. Check again for a
1831 * conflicting open and cancel the lease if there is one.
1832 *
1833 * We also add a barrier here to ensure that the insertion of the lock
1834 * precedes these checks.
1835 */
1836 smp_mb();
Amir Goldstein387e3742019-06-07 17:24:38 +03001837 error = check_conflicting_open(filp, arg, lease->fl_flags);
Jeff Layton8634b512015-01-16 15:05:55 -05001838 if (error) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001839 locks_unlink_lock_ctx(lease);
Jeff Layton8634b512015-01-16 15:05:55 -05001840 goto out;
1841 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001842
1843out_setup:
1844 if (lease->fl_lmops->lm_setup)
1845 lease->fl_lmops->lm_setup(lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846out:
Jeff Layton6109c852015-01-16 15:05:57 -05001847 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001848 percpu_up_read(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001849 locks_dispose_list(&dispose);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001850 if (is_deleg)
Al Viro59551022016-01-22 15:40:57 -05001851 inode_unlock(inode);
Jeff Layton8634b512015-01-16 15:05:55 -05001852 if (!error && !my_fl)
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001853 *flp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854 return error;
1855}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001856
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001857static int generic_delete_lease(struct file *filp, void *owner)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001858{
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001859 int error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001860 struct file_lock *fl, *victim = NULL;
Miklos Szeredic568d682016-09-16 12:44:20 +02001861 struct inode *inode = locks_inode(filp);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001862 struct file_lock_context *ctx;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001863 LIST_HEAD(dispose);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001864
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001865 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001866 if (!ctx) {
1867 trace_generic_delete_lease(inode, NULL);
1868 return error;
1869 }
1870
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001871 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001872 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001873 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001874 if (fl->fl_file == filp &&
1875 fl->fl_owner == owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001876 victim = fl;
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001877 break;
Jeff Layton8634b512015-01-16 15:05:55 -05001878 }
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001879 }
Jeff Laytona9b1b452015-03-14 09:45:35 -04001880 trace_generic_delete_lease(inode, victim);
Jeff Layton8634b512015-01-16 15:05:55 -05001881 if (victim)
Jeff Layton7448cc32015-01-16 15:05:57 -05001882 error = fl->fl_lmops->lm_change(victim, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05001883 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001884 percpu_up_read(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001885 locks_dispose_list(&dispose);
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001886 return error;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001887}
1888
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889/**
1890 * generic_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001891 * @filp: file pointer
1892 * @arg: type of lease to obtain
1893 * @flp: input - file_lock to use, output - file_lock inserted
1894 * @priv: private data for lm_setup (may be NULL if lm_setup
1895 * doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 *
1897 * The (input) flp->fl_lmops->lm_break function is required
1898 * by break_lease().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001900int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
1901 void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902{
Miklos Szeredic568d682016-09-16 12:44:20 +02001903 struct inode *inode = locks_inode(filp);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001904 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001906 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001907 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001909 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 error = security_file_lock(filp, arg);
1911 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001912 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001914 switch (arg) {
1915 case F_UNLCK:
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001916 return generic_delete_lease(filp, *priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001917 case F_RDLCK:
1918 case F_WRLCK:
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001919 if (!(*flp)->fl_lmops->lm_break) {
1920 WARN_ON_ONCE(1);
1921 return -ENOLCK;
1922 }
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001923
Jeff Laytone6f5c782014-08-22 10:40:25 -04001924 return generic_add_lease(filp, arg, flp, priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001925 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001926 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001929EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930
Jeff Layton18f66222019-08-18 14:18:45 -04001931#if IS_ENABLED(CONFIG_SRCU)
1932/*
1933 * Kernel subsystems can register to be notified on any attempt to set
1934 * a new lease with the lease_notifier_chain. This is used by (e.g.) nfsd
1935 * to close files that it may have cached when there is an attempt to set a
1936 * conflicting lease.
1937 */
1938static struct srcu_notifier_head lease_notifier_chain;
1939
1940static inline void
1941lease_notifier_chain_init(void)
1942{
1943 srcu_init_notifier_head(&lease_notifier_chain);
1944}
1945
1946static inline void
1947setlease_notifier(long arg, struct file_lock *lease)
1948{
1949 if (arg != F_UNLCK)
1950 srcu_notifier_call_chain(&lease_notifier_chain, arg, lease);
1951}
1952
1953int lease_register_notifier(struct notifier_block *nb)
1954{
1955 return srcu_notifier_chain_register(&lease_notifier_chain, nb);
1956}
1957EXPORT_SYMBOL_GPL(lease_register_notifier);
1958
1959void lease_unregister_notifier(struct notifier_block *nb)
1960{
1961 srcu_notifier_chain_unregister(&lease_notifier_chain, nb);
1962}
1963EXPORT_SYMBOL_GPL(lease_unregister_notifier);
1964
1965#else /* !IS_ENABLED(CONFIG_SRCU) */
1966static inline void
1967lease_notifier_chain_init(void)
1968{
1969}
1970
1971static inline void
1972setlease_notifier(long arg, struct file_lock *lease)
1973{
1974}
1975
1976int lease_register_notifier(struct notifier_block *nb)
1977{
1978 return 0;
1979}
1980EXPORT_SYMBOL_GPL(lease_register_notifier);
1981
1982void lease_unregister_notifier(struct notifier_block *nb)
1983{
1984}
1985EXPORT_SYMBOL_GPL(lease_unregister_notifier);
1986
1987#endif /* IS_ENABLED(CONFIG_SRCU) */
1988
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001989/**
Jeff Laytone51673a2014-08-22 18:13:28 -04001990 * vfs_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001991 * @filp: file pointer
1992 * @arg: type of lease to obtain
1993 * @lease: file_lock to use when adding a lease
1994 * @priv: private info for lm_setup when adding a lease (may be
NeilBrown7bbd1fc2018-11-30 10:04:08 +11001995 * NULL if lm_setup doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996 *
Jeff Laytone51673a2014-08-22 18:13:28 -04001997 * Call this to establish a lease on the file. The "lease" argument is not
1998 * used for F_UNLCK requests and may be NULL. For commands that set or alter
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04001999 * an existing lease, the ``(*lease)->fl_lmops->lm_break`` operation must be
2000 * set; if not, this function will return -ENOLCK (and generate a scary-looking
Jeff Laytone51673a2014-08-22 18:13:28 -04002001 * stack trace).
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002002 *
2003 * The "priv" pointer is passed directly to the lm_setup function as-is. It
2004 * may be NULL if the lm_setup operation doesn't require it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04002006int
2007vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008{
Jeff Layton18f66222019-08-18 14:18:45 -04002009 if (lease)
2010 setlease_notifier(arg, *lease);
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002011 if (filp->f_op->setlease)
Jeff Laytonf82b4b62014-08-22 18:50:48 -04002012 return filp->f_op->setlease(filp, arg, lease, priv);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002013 else
Jeff Laytonf82b4b62014-08-22 18:50:48 -04002014 return generic_setlease(filp, arg, lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04002016EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002018static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019{
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002020 struct file_lock *fl;
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002021 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022 int error;
2023
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02002024 fl = lease_alloc(filp, arg);
2025 if (IS_ERR(fl))
2026 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002028 new = fasync_alloc();
2029 if (!new) {
2030 locks_free_lock(fl);
2031 return -ENOMEM;
2032 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002033 new->fa_fd = fd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002035 error = vfs_setlease(filp, arg, &fl, (void **)&new);
Jeff Layton2dfb9282014-08-11 18:14:12 -04002036 if (fl)
2037 locks_free_lock(fl);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002038 if (new)
2039 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040 return error;
2041}
2042
2043/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002044 * fcntl_setlease - sets a lease on an open file
2045 * @fd: open file descriptor
2046 * @filp: file pointer
2047 * @arg: type of lease to obtain
2048 *
2049 * Call this fcntl to establish a lease on the file.
2050 * Note that you also need to call %F_SETSIG to
2051 * receive a signal when the lease is broken.
2052 */
2053int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
2054{
2055 if (arg == F_UNLCK)
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01002056 return vfs_setlease(filp, F_UNLCK, NULL, (void **)&filp);
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002057 return do_fcntl_add_lease(fd, filp, arg);
2058}
2059
2060/**
Jeff Layton29d01b22015-07-11 06:43:02 -04002061 * flock_lock_inode_wait - Apply a FLOCK-style lock to a file
2062 * @inode: inode of the file to apply to
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063 * @fl: The lock to be applied
2064 *
Jeff Layton29d01b22015-07-11 06:43:02 -04002065 * Apply a FLOCK style lock request to an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 */
Benjamin Coddington616fb382015-10-22 13:38:15 -04002067static int flock_lock_inode_wait(struct inode *inode, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068{
2069 int error;
2070 might_sleep();
2071 for (;;) {
Jeff Layton29d01b22015-07-11 06:43:02 -04002072 error = flock_lock_inode(inode, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07002073 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074 break;
Linus Torvaldsdcf23ac2020-03-18 07:52:21 -04002075 error = wait_event_interruptible(fl->fl_wait,
2076 list_empty(&fl->fl_blocked_member));
NeilBrown16306a62018-11-30 10:04:08 +11002077 if (error)
2078 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079 }
NeilBrown16306a62018-11-30 10:04:08 +11002080 locks_delete_block(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 return error;
2082}
2083
Jeff Layton29d01b22015-07-11 06:43:02 -04002084/**
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04002085 * locks_lock_inode_wait - Apply a lock to an inode
2086 * @inode: inode of the file to apply to
2087 * @fl: The lock to be applied
2088 *
2089 * Apply a POSIX or FLOCK style lock request to an inode.
2090 */
2091int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
2092{
2093 int res = 0;
2094 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
2095 case FL_POSIX:
2096 res = posix_lock_inode_wait(inode, fl);
2097 break;
2098 case FL_FLOCK:
2099 res = flock_lock_inode_wait(inode, fl);
2100 break;
2101 default:
2102 BUG();
2103 }
2104 return res;
2105}
2106EXPORT_SYMBOL(locks_lock_inode_wait);
2107
2108/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 * sys_flock: - flock() system call.
2110 * @fd: the file descriptor to lock.
2111 * @cmd: the type of lock to apply.
2112 *
2113 * Apply a %FL_FLOCK style lock to an open file descriptor.
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04002114 * The @cmd can be one of:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 *
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04002116 * - %LOCK_SH -- a shared lock.
2117 * - %LOCK_EX -- an exclusive lock.
2118 * - %LOCK_UN -- remove an existing lock.
2119 * - %LOCK_MAND -- a 'mandatory' flock.
2120 * This exists to emulate Windows Share Modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 *
2122 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
2123 * processes read and write access respectively.
2124 */
Heiko Carstens002c8972009-01-14 14:14:18 +01002125SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126{
Al Viro2903ff02012-08-28 12:52:22 -04002127 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128 struct file_lock *lock;
2129 int can_sleep, unlock;
2130 int error;
2131
2132 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04002133 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134 goto out;
2135
2136 can_sleep = !(cmd & LOCK_NB);
2137 cmd &= ~LOCK_NB;
2138 unlock = (cmd == LOCK_UN);
2139
Al Viroaeb5d722008-09-02 15:28:45 -04002140 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04002141 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 goto out_putf;
2143
NeilBrownd6367d62018-11-30 10:04:08 +11002144 lock = flock_make_lock(f.file, cmd, NULL);
Jeff Layton6e129d002014-09-04 10:25:06 -04002145 if (IS_ERR(lock)) {
2146 error = PTR_ERR(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 goto out_putf;
Jeff Layton6e129d002014-09-04 10:25:06 -04002148 }
2149
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 if (can_sleep)
2151 lock->fl_flags |= FL_SLEEP;
2152
Al Viro2903ff02012-08-28 12:52:22 -04002153 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 if (error)
2155 goto out_free;
2156
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002157 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04002158 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159 (can_sleep) ? F_SETLKW : F_SETLK,
2160 lock);
2161 else
Benjamin Coddington4f656362015-10-22 13:38:14 -04002162 error = locks_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163
2164 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08002165 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166
2167 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04002168 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 out:
2170 return error;
2171}
2172
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002173/**
2174 * vfs_test_lock - test file byte range lock
2175 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04002176 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002177 *
2178 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
2179 * setting conf->fl_type to something other than F_UNLCK.
2180 */
2181int vfs_test_lock(struct file *filp, struct file_lock *fl)
2182{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002183 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002184 return filp->f_op->lock(filp, F_GETLK, fl);
2185 posix_test_lock(filp, fl);
2186 return 0;
2187}
2188EXPORT_SYMBOL_GPL(vfs_test_lock);
2189
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002190/**
2191 * locks_translate_pid - translate a file_lock's fl_pid number into a namespace
2192 * @fl: The file_lock who's fl_pid should be translated
2193 * @ns: The namespace into which the pid should be translated
2194 *
2195 * Used to tranlate a fl_pid into a namespace virtual pid number
2196 */
2197static pid_t locks_translate_pid(struct file_lock *fl, struct pid_namespace *ns)
2198{
2199 pid_t vnr;
2200 struct pid *pid;
2201
2202 if (IS_OFDLCK(fl))
2203 return -1;
2204 if (IS_REMOTELCK(fl))
2205 return fl->fl_pid;
Konstantin Khorenko826d7bc2018-06-08 17:27:11 +03002206 /*
2207 * If the flock owner process is dead and its pid has been already
2208 * freed, the translation below won't work, but we still want to show
2209 * flock owner pid number in init pidns.
2210 */
2211 if (ns == &init_pid_ns)
2212 return (pid_t)fl->fl_pid;
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002213
2214 rcu_read_lock();
2215 pid = find_pid_ns(fl->fl_pid, &init_pid_ns);
2216 vnr = pid_nr_ns(pid, ns);
2217 rcu_read_unlock();
2218 return vnr;
2219}
2220
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002221static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
2222{
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002223 flock->l_pid = locks_translate_pid(fl, task_active_pid_ns(current));
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002224#if BITS_PER_LONG == 32
2225 /*
2226 * Make sure we can represent the posix lock via
2227 * legacy 32bit flock.
2228 */
2229 if (fl->fl_start > OFFT_OFFSET_MAX)
2230 return -EOVERFLOW;
2231 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
2232 return -EOVERFLOW;
2233#endif
2234 flock->l_start = fl->fl_start;
2235 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2236 fl->fl_end - fl->fl_start + 1;
2237 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04002238 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002239 return 0;
2240}
2241
2242#if BITS_PER_LONG == 32
2243static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
2244{
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002245 flock->l_pid = locks_translate_pid(fl, task_active_pid_ns(current));
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002246 flock->l_start = fl->fl_start;
2247 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2248 fl->fl_end - fl->fl_start + 1;
2249 flock->l_whence = 0;
2250 flock->l_type = fl->fl_type;
2251}
2252#endif
2253
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254/* Report the first existing lock that would conflict with l.
2255 * This implements the F_GETLK command of fcntl().
2256 */
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002257int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258{
Benjamin Coddington52306e82017-07-16 10:28:21 -04002259 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 int error;
2261
Benjamin Coddington52306e82017-07-16 10:28:21 -04002262 fl = locks_alloc_lock();
2263 if (fl == NULL)
2264 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002266 if (flock->l_type != F_RDLCK && flock->l_type != F_WRLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 goto out;
2268
Benjamin Coddington52306e82017-07-16 10:28:21 -04002269 error = flock_to_posix_lock(filp, fl, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270 if (error)
2271 goto out;
2272
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002273 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002274 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002275 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002276 goto out;
2277
Benjamin Coddington52306e82017-07-16 10:28:21 -04002278 fl->fl_flags |= FL_OFDLCK;
2279 fl->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002280 }
2281
Benjamin Coddington52306e82017-07-16 10:28:21 -04002282 error = vfs_test_lock(filp, fl);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002283 if (error)
2284 goto out;
NeilBrown7bbd1fc2018-11-30 10:04:08 +11002285
Benjamin Coddington52306e82017-07-16 10:28:21 -04002286 flock->l_type = fl->fl_type;
2287 if (fl->fl_type != F_UNLCK) {
2288 error = posix_lock_to_flock(flock, fl);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002289 if (error)
Benjamin Coddington52306e82017-07-16 10:28:21 -04002290 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292out:
Benjamin Coddington52306e82017-07-16 10:28:21 -04002293 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294 return error;
2295}
2296
Marc Eshel7723ec92007-01-18 15:08:55 -05002297/**
2298 * vfs_lock_file - file byte range lock
2299 * @filp: The file to apply the lock to
2300 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2301 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05002302 * @conf: Place to return a copy of the conflicting lock, if found.
2303 *
2304 * A caller that doesn't care about the conflicting lock may pass NULL
2305 * as the final argument.
2306 *
2307 * If the filesystem defines a private ->lock() method, then @conf will
2308 * be left unchanged; so a caller that cares should initialize it to
2309 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05002310 *
2311 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2312 * locks, the ->lock() interface may return asynchronously, before the lock has
2313 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002314 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05002315 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2316 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002317 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05002318 * request completes.
2319 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07002320 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2321 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05002322 * nonzero return code and the file system should release the lock. The file
2323 * system is also responsible to keep a corresponding posix lock when it
2324 * grants a lock so the VFS can find out which locks are locally held and do
2325 * the correct lock cleanup when required.
2326 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002327 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05002328 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05002329 */
Marc Eshel150b3932007-01-18 16:15:35 -05002330int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05002331{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002332 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05002333 return filp->f_op->lock(filp, cmd, fl);
2334 else
Marc Eshel150b3932007-01-18 16:15:35 -05002335 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05002336}
2337EXPORT_SYMBOL_GPL(vfs_lock_file);
2338
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002339static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2340 struct file_lock *fl)
2341{
2342 int error;
2343
2344 error = security_file_lock(filp, fl->fl_type);
2345 if (error)
2346 return error;
2347
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002348 for (;;) {
2349 error = vfs_lock_file(filp, cmd, fl, NULL);
2350 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002351 break;
Linus Torvaldsdcf23ac2020-03-18 07:52:21 -04002352 error = wait_event_interruptible(fl->fl_wait,
2353 list_empty(&fl->fl_blocked_member));
NeilBrown16306a62018-11-30 10:04:08 +11002354 if (error)
2355 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002356 }
NeilBrown16306a62018-11-30 10:04:08 +11002357 locks_delete_block(fl);
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002358
2359 return error;
2360}
2361
Benjamin Coddington6ca7d912015-10-15 09:07:07 -04002362/* Ensure that fl->fl_file has compatible f_mode for F_SETLK calls */
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002363static int
2364check_fmode_for_setlk(struct file_lock *fl)
2365{
2366 switch (fl->fl_type) {
2367 case F_RDLCK:
2368 if (!(fl->fl_file->f_mode & FMODE_READ))
2369 return -EBADF;
2370 break;
2371 case F_WRLCK:
2372 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2373 return -EBADF;
2374 }
2375 return 0;
2376}
2377
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378/* Apply the lock described by l to an open file descriptor.
2379 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2380 */
Peter Staubachc2936212005-07-27 11:45:09 -07002381int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002382 struct flock *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383{
2384 struct file_lock *file_lock = locks_alloc_lock();
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002385 struct inode *inode = locks_inode(filp);
Al Viro0b2bac22008-05-06 13:58:34 -04002386 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002387 int error;
2388
2389 if (file_lock == NULL)
2390 return -ENOLCK;
2391
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002392 error = flock_to_posix_lock(filp, file_lock, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393 if (error)
2394 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002395
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002396 error = check_fmode_for_setlk(file_lock);
2397 if (error)
2398 goto out;
2399
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002400 /*
2401 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002402 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002403 */
2404 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002405 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002406 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002407 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002408 goto out;
2409
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002410 cmd = F_SETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002411 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002412 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002413 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002414 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002415 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002416 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002417 goto out;
2418
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002419 cmd = F_SETLKW;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002420 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002421 file_lock->fl_owner = filp;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05002422 fallthrough;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002423 case F_SETLKW:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424 file_lock->fl_flags |= FL_SLEEP;
2425 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002426
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002427 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428
Peter Staubachc2936212005-07-27 11:45:09 -07002429 /*
Jeff Layton0752ba82016-01-08 07:30:43 -05002430 * Attempt to detect a close/fcntl race and recover by releasing the
2431 * lock that was just acquired. There is no need to do that when we're
2432 * unlocking though, or for OFD locks.
Peter Staubachc2936212005-07-27 11:45:09 -07002433 */
Jeff Layton0752ba82016-01-08 07:30:43 -05002434 if (!error && file_lock->fl_type != F_UNLCK &&
2435 !(file_lock->fl_flags & FL_OFDLCK)) {
Eric W. Biederman120ce2b2020-11-20 17:14:25 -06002436 struct files_struct *files = current->files;
Jeff Layton7f3697e2016-01-07 16:38:10 -05002437 /*
2438 * We need that spin_lock here - it prevents reordering between
2439 * update of i_flctx->flc_posix and check for it done in
2440 * close(). rcu_read_lock() wouldn't do.
2441 */
Eric W. Biederman120ce2b2020-11-20 17:14:25 -06002442 spin_lock(&files->file_lock);
2443 f = files_lookup_fd_locked(files, fd);
2444 spin_unlock(&files->file_lock);
Jeff Layton7f3697e2016-01-07 16:38:10 -05002445 if (f != filp) {
2446 file_lock->fl_type = F_UNLCK;
2447 error = do_lock_file_wait(filp, cmd, file_lock);
2448 WARN_ON_ONCE(error);
2449 error = -EBADF;
2450 }
Peter Staubachc2936212005-07-27 11:45:09 -07002451 }
Peter Staubachc2936212005-07-27 11:45:09 -07002452out:
Jeff Layton18909102016-01-06 21:26:10 -05002453 trace_fcntl_setlk(inode, file_lock, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454 locks_free_lock(file_lock);
2455 return error;
2456}
2457
2458#if BITS_PER_LONG == 32
2459/* Report the first existing lock that would conflict with l.
2460 * This implements the F_GETLK command of fcntl().
2461 */
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002462int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463{
Benjamin Coddington52306e82017-07-16 10:28:21 -04002464 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465 int error;
2466
Benjamin Coddington52306e82017-07-16 10:28:21 -04002467 fl = locks_alloc_lock();
2468 if (fl == NULL)
2469 return -ENOMEM;
2470
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002472 if (flock->l_type != F_RDLCK && flock->l_type != F_WRLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002473 goto out;
2474
Benjamin Coddington52306e82017-07-16 10:28:21 -04002475 error = flock64_to_posix_lock(filp, fl, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 if (error)
2477 goto out;
2478
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002479 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002480 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002481 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002482 goto out;
2483
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002484 cmd = F_GETLK64;
Benjamin Coddington52306e82017-07-16 10:28:21 -04002485 fl->fl_flags |= FL_OFDLCK;
2486 fl->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002487 }
2488
Benjamin Coddington52306e82017-07-16 10:28:21 -04002489 error = vfs_test_lock(filp, fl);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002490 if (error)
2491 goto out;
2492
Benjamin Coddington52306e82017-07-16 10:28:21 -04002493 flock->l_type = fl->fl_type;
2494 if (fl->fl_type != F_UNLCK)
2495 posix_lock_to_flock64(flock, fl);
Kinglong Meef3282962014-08-22 10:18:43 -04002496
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497out:
Benjamin Coddington52306e82017-07-16 10:28:21 -04002498 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002499 return error;
2500}
2501
2502/* Apply the lock described by l to an open file descriptor.
2503 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2504 */
Peter Staubachc2936212005-07-27 11:45:09 -07002505int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002506 struct flock64 *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507{
2508 struct file_lock *file_lock = locks_alloc_lock();
Al Viro0b2bac22008-05-06 13:58:34 -04002509 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510 int error;
2511
2512 if (file_lock == NULL)
2513 return -ENOLCK;
2514
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002515 error = flock64_to_posix_lock(filp, file_lock, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002516 if (error)
2517 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002518
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002519 error = check_fmode_for_setlk(file_lock);
2520 if (error)
2521 goto out;
2522
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002523 /*
2524 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002525 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002526 */
2527 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002528 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002529 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002530 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002531 goto out;
2532
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002533 cmd = F_SETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002534 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002535 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002536 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002537 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002538 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002539 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002540 goto out;
2541
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002542 cmd = F_SETLKW64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002543 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002544 file_lock->fl_owner = filp;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05002545 fallthrough;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002546 case F_SETLKW64:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547 file_lock->fl_flags |= FL_SLEEP;
2548 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002549
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002550 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002551
Peter Staubachc2936212005-07-27 11:45:09 -07002552 /*
Jeff Layton0752ba82016-01-08 07:30:43 -05002553 * Attempt to detect a close/fcntl race and recover by releasing the
2554 * lock that was just acquired. There is no need to do that when we're
2555 * unlocking though, or for OFD locks.
Peter Staubachc2936212005-07-27 11:45:09 -07002556 */
Jeff Layton0752ba82016-01-08 07:30:43 -05002557 if (!error && file_lock->fl_type != F_UNLCK &&
2558 !(file_lock->fl_flags & FL_OFDLCK)) {
Eric W. Biederman120ce2b2020-11-20 17:14:25 -06002559 struct files_struct *files = current->files;
Jeff Layton7f3697e2016-01-07 16:38:10 -05002560 /*
2561 * We need that spin_lock here - it prevents reordering between
2562 * update of i_flctx->flc_posix and check for it done in
2563 * close(). rcu_read_lock() wouldn't do.
2564 */
Eric W. Biederman120ce2b2020-11-20 17:14:25 -06002565 spin_lock(&files->file_lock);
2566 f = files_lookup_fd_locked(files, fd);
2567 spin_unlock(&files->file_lock);
Jeff Layton7f3697e2016-01-07 16:38:10 -05002568 if (f != filp) {
2569 file_lock->fl_type = F_UNLCK;
2570 error = do_lock_file_wait(filp, cmd, file_lock);
2571 WARN_ON_ONCE(error);
2572 error = -EBADF;
2573 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002575out:
2576 locks_free_lock(file_lock);
2577 return error;
2578}
2579#endif /* BITS_PER_LONG == 32 */
2580
2581/*
2582 * This function is called when the file is being removed
2583 * from the task's fd array. POSIX locks belonging to this task
2584 * are deleted at this time.
2585 */
2586void locks_remove_posix(struct file *filp, fl_owner_t owner)
2587{
Jeff Layton18909102016-01-06 21:26:10 -05002588 int error;
Miklos Szeredic568d682016-09-16 12:44:20 +02002589 struct inode *inode = locks_inode(filp);
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002590 struct file_lock lock;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002591 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002592
2593 /*
2594 * If there are no locks held on this file, we don't need to call
2595 * posix_lock_file(). Another process could be setting a lock on this
2596 * file at the same time, but we wouldn't remove that lock anyway.
2597 */
Miklos Szeredic568d682016-09-16 12:44:20 +02002598 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05002599 if (!ctx || list_empty(&ctx->flc_posix))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600 return;
2601
NeilBrownd6367d62018-11-30 10:04:08 +11002602 locks_init_lock(&lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002604 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002605 lock.fl_start = 0;
2606 lock.fl_end = OFFSET_MAX;
2607 lock.fl_owner = owner;
2608 lock.fl_pid = current->tgid;
2609 lock.fl_file = filp;
2610 lock.fl_ops = NULL;
2611 lock.fl_lmops = NULL;
2612
Jeff Layton18909102016-01-06 21:26:10 -05002613 error = vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002614
Linus Torvalds1da177e2005-04-16 15:20:36 -07002615 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2616 lock.fl_ops->fl_release_private(&lock);
Miklos Szeredic568d682016-09-16 12:44:20 +02002617 trace_locks_remove_posix(inode, &lock, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002618}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002619EXPORT_SYMBOL(locks_remove_posix);
2620
Jeff Layton3d8e5602015-01-16 15:05:58 -05002621/* The i_flctx must be valid when calling into here */
Jeff Laytondd459bb2015-01-16 15:05:54 -05002622static void
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002623locks_remove_flock(struct file *filp, struct file_lock_context *flctx)
Jeff Laytondd459bb2015-01-16 15:05:54 -05002624{
NeilBrownd6367d62018-11-30 10:04:08 +11002625 struct file_lock fl;
Miklos Szeredic568d682016-09-16 12:44:20 +02002626 struct inode *inode = locks_inode(filp);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002627
Jeff Layton3d8e5602015-01-16 15:05:58 -05002628 if (list_empty(&flctx->flc_flock))
Jeff Laytondd459bb2015-01-16 15:05:54 -05002629 return;
2630
NeilBrownd6367d62018-11-30 10:04:08 +11002631 flock_make_lock(filp, LOCK_UN, &fl);
2632 fl.fl_flags |= FL_CLOSE;
2633
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002634 if (filp->f_op->flock)
Jeff Laytondd459bb2015-01-16 15:05:54 -05002635 filp->f_op->flock(filp, F_SETLKW, &fl);
2636 else
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04002637 flock_lock_inode(inode, &fl);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002638
2639 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2640 fl.fl_ops->fl_release_private(&fl);
2641}
2642
Jeff Layton3d8e5602015-01-16 15:05:58 -05002643/* The i_flctx must be valid when calling into here */
Jeff Layton8634b512015-01-16 15:05:55 -05002644static void
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002645locks_remove_lease(struct file *filp, struct file_lock_context *ctx)
Jeff Layton8634b512015-01-16 15:05:55 -05002646{
Jeff Layton8634b512015-01-16 15:05:55 -05002647 struct file_lock *fl, *tmp;
2648 LIST_HEAD(dispose);
2649
Jeff Layton3d8e5602015-01-16 15:05:58 -05002650 if (list_empty(&ctx->flc_lease))
Jeff Layton8634b512015-01-16 15:05:55 -05002651 return;
2652
Peter Zijlstra02e525b22019-02-21 15:38:40 +01002653 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05002654 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05002655 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list)
Jeff Laytonc4e136c2015-02-16 19:37:42 -05002656 if (filp == fl->fl_file)
2657 lease_modify(fl, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05002658 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01002659 percpu_up_read(&file_rwsem);
Peter Zijlstra5f430862016-10-08 10:12:28 +02002660
Jeff Layton8634b512015-01-16 15:05:55 -05002661 locks_dispose_list(&dispose);
2662}
2663
Linus Torvalds1da177e2005-04-16 15:20:36 -07002664/*
2665 * This function is called on the last close of an open file.
2666 */
Jeff Layton78ed8a12014-02-03 12:13:08 -05002667void locks_remove_file(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002668{
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002669 struct file_lock_context *ctx;
2670
Miklos Szeredic568d682016-09-16 12:44:20 +02002671 ctx = smp_load_acquire(&locks_inode(filp)->i_flctx);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002672 if (!ctx)
Jeff Layton3d8e5602015-01-16 15:05:58 -05002673 return;
2674
Jeff Laytondd459bb2015-01-16 15:05:54 -05002675 /* remove any OFD locks */
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002676 locks_remove_posix(filp, filp);
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002677
Jeff Laytondd459bb2015-01-16 15:05:54 -05002678 /* remove flock locks */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002679 locks_remove_flock(filp, ctx);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002680
Jeff Layton8634b512015-01-16 15:05:55 -05002681 /* remove any leases */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002682 locks_remove_lease(filp, ctx);
Benjamin Coddington39537042017-07-21 13:36:25 -04002683
2684 spin_lock(&ctx->flc_lock);
2685 locks_check_ctx_file_list(filp, &ctx->flc_posix, "POSIX");
2686 locks_check_ctx_file_list(filp, &ctx->flc_flock, "FLOCK");
2687 locks_check_ctx_file_list(filp, &ctx->flc_lease, "LEASE");
2688 spin_unlock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002689}
2690
2691/**
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002692 * vfs_cancel_lock - file byte range unblock lock
2693 * @filp: The file to apply the unblock to
2694 * @fl: The lock to be unblocked
2695 *
2696 * Used by lock managers to cancel blocked requests
2697 */
2698int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2699{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002700 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002701 return filp->f_op->lock(filp, F_CANCELLK, fl);
2702 return 0;
2703}
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002704EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2705
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002706#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002707#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002708#include <linux/seq_file.h>
2709
Jeff Layton7012b022013-06-21 08:58:22 -04002710struct locks_iterator {
2711 int li_cpu;
2712 loff_t li_pos;
2713};
2714
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002715static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Luo Longjunb8da9b12021-02-25 22:58:29 -05002716 loff_t id, char *pfx, int repeat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717{
2718 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002719 unsigned int fl_pid;
Alexey Gladkov9d78ede2020-05-18 20:07:38 +02002720 struct pid_namespace *proc_pidns = proc_pid_ns(file_inode(f->file)->i_sb);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002721
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002722 fl_pid = locks_translate_pid(fl, proc_pidns);
2723 /*
Konstantin Khorenko1cf8e5d2018-06-08 17:27:12 +03002724 * If lock owner is dead (and pid is freed) or not visible in current
2725 * pidns, zero is shown as a pid value. Check lock info from
2726 * init_pid_ns to get saved lock pid value.
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002727 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002728
2729 if (fl->fl_file != NULL)
Miklos Szeredic568d682016-09-16 12:44:20 +02002730 inode = locks_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731
Luo Longjunb8da9b12021-02-25 22:58:29 -05002732 seq_printf(f, "%lld: ", id);
2733
2734 if (repeat)
2735 seq_printf(f, "%*s", repeat - 1 + (int)strlen(pfx), pfx);
2736
Linus Torvalds1da177e2005-04-16 15:20:36 -07002737 if (IS_POSIX(fl)) {
Jeff Laytonc918d422014-02-03 12:13:09 -05002738 if (fl->fl_flags & FL_ACCESS)
Fabian Frederick5315c262014-05-09 14:13:05 -04002739 seq_puts(f, "ACCESS");
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002740 else if (IS_OFDLCK(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002741 seq_puts(f, "OFDLCK");
Jeff Laytonc918d422014-02-03 12:13:09 -05002742 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002743 seq_puts(f, "POSIX ");
Jeff Laytonc918d422014-02-03 12:13:09 -05002744
2745 seq_printf(f, " %s ",
Jeff Laytonf7e33bd2021-08-19 14:56:38 -04002746 (inode == NULL) ? "*NOINODE*" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002747 } else if (IS_FLOCK(fl)) {
2748 if (fl->fl_type & LOCK_MAND) {
Fabian Frederick5315c262014-05-09 14:13:05 -04002749 seq_puts(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002750 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002751 seq_puts(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002752 }
2753 } else if (IS_LEASE(fl)) {
Jeff Layton8144f1f2014-08-11 13:36:54 -04002754 if (fl->fl_flags & FL_DELEG)
2755 seq_puts(f, "DELEG ");
2756 else
2757 seq_puts(f, "LEASE ");
2758
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002759 if (lease_breaking(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002760 seq_puts(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761 else if (fl->fl_file)
Fabian Frederick5315c262014-05-09 14:13:05 -04002762 seq_puts(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002763 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002764 seq_puts(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002765 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002766 seq_puts(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002767 }
2768 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002769 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002770 (fl->fl_type & LOCK_READ)
2771 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2772 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2773 } else {
Pavel Begunkov43e4cb92019-07-24 20:16:31 +03002774 int type = IS_LEASE(fl) ? target_leasetype(fl) : fl->fl_type;
2775
2776 seq_printf(f, "%s ", (type == F_WRLCK) ? "WRITE" :
2777 (type == F_RDLCK) ? "READ" : "UNLCK");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002778 }
2779 if (inode) {
Jeff Layton36488882015-04-03 09:04:04 -04002780 /* userspace relies on this representation of dev_t */
Amir Goldstein98ca4802019-12-22 20:45:28 +02002781 seq_printf(f, "%d %02x:%02x:%lu ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002782 MAJOR(inode->i_sb->s_dev),
2783 MINOR(inode->i_sb->s_dev), inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002784 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002785 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002786 }
2787 if (IS_POSIX(fl)) {
2788 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002789 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002790 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002791 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002792 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002793 seq_puts(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002794 }
2795}
2796
Luo Longjunb8da9b12021-02-25 22:58:29 -05002797static struct file_lock *get_next_blocked_member(struct file_lock *node)
2798{
2799 struct file_lock *tmp;
2800
2801 /* NULL node or root node */
2802 if (node == NULL || node->fl_blocker == NULL)
2803 return NULL;
2804
2805 /* Next member in the linked list could be itself */
2806 tmp = list_next_entry(node, fl_blocked_member);
2807 if (list_entry_is_head(tmp, &node->fl_blocker->fl_blocked_requests, fl_blocked_member)
2808 || tmp == node) {
2809 return NULL;
2810 }
2811
2812 return tmp;
2813}
2814
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002815static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002816{
Jeff Layton7012b022013-06-21 08:58:22 -04002817 struct locks_iterator *iter = f->private;
Luo Longjunb8da9b12021-02-25 22:58:29 -05002818 struct file_lock *cur, *tmp;
Alexey Gladkov9d78ede2020-05-18 20:07:38 +02002819 struct pid_namespace *proc_pidns = proc_pid_ns(file_inode(f->file)->i_sb);
Luo Longjunb8da9b12021-02-25 22:58:29 -05002820 int level = 0;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002821
Luo Longjunb8da9b12021-02-25 22:58:29 -05002822 cur = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002823
Luo Longjunb8da9b12021-02-25 22:58:29 -05002824 if (locks_translate_pid(cur, proc_pidns) == 0)
Nikolay Borisovd67fd442016-08-17 16:18:46 -04002825 return 0;
2826
Luo Longjunb8da9b12021-02-25 22:58:29 -05002827 /* View this crossed linked list as a binary tree, the first member of fl_blocked_requests
2828 * is the left child of current node, the next silibing in fl_blocked_member is the
2829 * right child, we can alse get the parent of current node from fl_blocker, so this
2830 * question becomes traversal of a binary tree
2831 */
2832 while (cur != NULL) {
2833 if (level)
2834 lock_get_status(f, cur, iter->li_pos, "-> ", level);
2835 else
2836 lock_get_status(f, cur, iter->li_pos, "", level);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002837
Luo Longjunb8da9b12021-02-25 22:58:29 -05002838 if (!list_empty(&cur->fl_blocked_requests)) {
2839 /* Turn left */
2840 cur = list_first_entry_or_null(&cur->fl_blocked_requests,
2841 struct file_lock, fl_blocked_member);
2842 level++;
2843 } else {
2844 /* Turn right */
2845 tmp = get_next_blocked_member(cur);
2846 /* Fall back to parent node */
2847 while (tmp == NULL && cur->fl_blocker != NULL) {
2848 cur = cur->fl_blocker;
2849 level--;
2850 tmp = get_next_blocked_member(cur);
2851 }
2852 cur = tmp;
2853 }
2854 }
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002855
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002856 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002857}
2858
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002859static void __show_fd_locks(struct seq_file *f,
2860 struct list_head *head, int *id,
2861 struct file *filp, struct files_struct *files)
2862{
2863 struct file_lock *fl;
2864
2865 list_for_each_entry(fl, head, fl_list) {
2866
2867 if (filp != fl->fl_file)
2868 continue;
2869 if (fl->fl_owner != files &&
2870 fl->fl_owner != filp)
2871 continue;
2872
2873 (*id)++;
2874 seq_puts(f, "lock:\t");
Luo Longjunb8da9b12021-02-25 22:58:29 -05002875 lock_get_status(f, fl, *id, "", 0);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002876 }
2877}
2878
2879void show_fd_locks(struct seq_file *f,
2880 struct file *filp, struct files_struct *files)
2881{
Miklos Szeredic568d682016-09-16 12:44:20 +02002882 struct inode *inode = locks_inode(filp);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002883 struct file_lock_context *ctx;
2884 int id = 0;
2885
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002886 ctx = smp_load_acquire(&inode->i_flctx);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002887 if (!ctx)
2888 return;
2889
2890 spin_lock(&ctx->flc_lock);
2891 __show_fd_locks(f, &ctx->flc_flock, &id, filp, files);
2892 __show_fd_locks(f, &ctx->flc_posix, &id, filp, files);
2893 __show_fd_locks(f, &ctx->flc_lease, &id, filp, files);
2894 spin_unlock(&ctx->flc_lock);
2895}
2896
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002897static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002898 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002899{
Jeff Layton7012b022013-06-21 08:58:22 -04002900 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002901
Jeff Layton7012b022013-06-21 08:58:22 -04002902 iter->li_pos = *pos + 1;
Peter Zijlstraaba37662015-06-22 14:16:33 +02002903 percpu_down_write(&file_rwsem);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002904 spin_lock(&blocked_lock_lock);
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002905 return seq_hlist_start_percpu(&file_lock_list.hlist, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002906}
2907
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002908static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2909{
Jeff Layton7012b022013-06-21 08:58:22 -04002910 struct locks_iterator *iter = f->private;
2911
2912 ++iter->li_pos;
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002913 return seq_hlist_next_percpu(v, &file_lock_list.hlist, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002914}
2915
2916static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002917 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002918{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002919 spin_unlock(&blocked_lock_lock);
Peter Zijlstraaba37662015-06-22 14:16:33 +02002920 percpu_up_write(&file_rwsem);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002921}
2922
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002923static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002924 .start = locks_start,
2925 .next = locks_next,
2926 .stop = locks_stop,
2927 .show = locks_show,
2928};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002929
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002930static int __init proc_locks_init(void)
2931{
Christoph Hellwig44414d82018-04-24 17:05:17 +02002932 proc_create_seq_private("locks", 0, NULL, &locks_seq_operations,
2933 sizeof(struct locks_iterator), NULL);
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002934 return 0;
2935}
Paul Gortmaker91899222015-12-17 14:11:03 -05002936fs_initcall(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002937#endif
2938
Linus Torvalds1da177e2005-04-16 15:20:36 -07002939static int __init filelock_init(void)
2940{
Jeff Layton7012b022013-06-21 08:58:22 -04002941 int i;
2942
Jeff Layton4a075e32015-01-16 15:05:54 -05002943 flctx_cache = kmem_cache_create("file_lock_ctx",
Linus Torvalds37547072021-09-07 11:21:48 -07002944 sizeof(struct file_lock_context), 0, SLAB_PANIC, NULL);
Jeff Layton4a075e32015-01-16 15:05:54 -05002945
Linus Torvalds1da177e2005-04-16 15:20:36 -07002946 filelock_cache = kmem_cache_create("file_lock_cache",
Linus Torvalds37547072021-09-07 11:21:48 -07002947 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
Miklos Szerediee19cc42011-07-07 13:06:09 +02002948
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002949 for_each_possible_cpu(i) {
2950 struct file_lock_list_struct *fll = per_cpu_ptr(&file_lock_list, i);
2951
2952 spin_lock_init(&fll->lock);
2953 INIT_HLIST_HEAD(&fll->hlist);
2954 }
Jeff Layton7012b022013-06-21 08:58:22 -04002955
Jeff Layton18f66222019-08-18 14:18:45 -04002956 lease_notifier_chain_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002957 return 0;
2958}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002959core_initcall(filelock_init);