blob: a364ebc5cec3b1b974da670c72e9af0a42e07c2a [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/fs/locks.c
4 *
5 * Provide support for fcntl()'s F_GETLK, F_SETLK, and F_SETLKW calls.
6 * Doug Evans (dje@spiff.uucp), August 07, 1992
7 *
8 * Deadlock detection added.
9 * FIXME: one thing isn't handled yet:
10 * - mandatory locks (requires lots of changes elsewhere)
11 * Kelly Carmichael (kelly@[142.24.8.65]), September 17, 1994.
12 *
13 * Miscellaneous edits, and a total rewrite of posix_lock_file() code.
14 * Kai Petzke (wpp@marie.physik.tu-berlin.de), 1994
NeilBrown7bbd1fc2018-11-30 10:04:08 +110015 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 * Converted file_lock_table to a linked list from an array, which eliminates
17 * the limits on how many active file locks are open.
18 * Chad Page (pageone@netcom.com), November 27, 1994
NeilBrown7bbd1fc2018-11-30 10:04:08 +110019 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070020 * Removed dependency on file descriptors. dup()'ed file descriptors now
21 * get the same locks as the original file descriptors, and a close() on
22 * any file descriptor removes ALL the locks on the file for the current
23 * process. Since locks still depend on the process id, locks are inherited
24 * after an exec() but not after a fork(). This agrees with POSIX, and both
25 * BSD and SVR4 practice.
26 * Andy Walker (andy@lysaker.kvaerner.no), February 14, 1995
27 *
28 * Scrapped free list which is redundant now that we allocate locks
29 * dynamically with kmalloc()/kfree().
30 * Andy Walker (andy@lysaker.kvaerner.no), February 21, 1995
31 *
32 * Implemented two lock personalities - FL_FLOCK and FL_POSIX.
33 *
34 * FL_POSIX locks are created with calls to fcntl() and lockf() through the
35 * fcntl() system call. They have the semantics described above.
36 *
37 * FL_FLOCK locks are created with calls to flock(), through the flock()
38 * system call, which is new. Old C libraries implement flock() via fcntl()
39 * and will continue to use the old, broken implementation.
40 *
41 * FL_FLOCK locks follow the 4.4 BSD flock() semantics. They are associated
42 * with a file pointer (filp). As a result they can be shared by a parent
43 * process and its children after a fork(). They are removed when the last
44 * file descriptor referring to the file pointer is closed (unless explicitly
NeilBrown7bbd1fc2018-11-30 10:04:08 +110045 * unlocked).
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 *
47 * FL_FLOCK locks never deadlock, an existing lock is always removed before
48 * upgrading from shared to exclusive (or vice versa). When this happens
49 * any processes blocked by the current lock are woken up and allowed to
50 * run before the new lock is applied.
51 * Andy Walker (andy@lysaker.kvaerner.no), June 09, 1995
52 *
53 * Removed some race conditions in flock_lock_file(), marked other possible
NeilBrown7bbd1fc2018-11-30 10:04:08 +110054 * races. Just grep for FIXME to see them.
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 * Dmitry Gorodchanin (pgmdsg@ibi.com), February 09, 1996.
56 *
57 * Addressed Dmitry's concerns. Deadlock checking no longer recursive.
58 * Lock allocation changed to GFP_ATOMIC as we can't afford to sleep
59 * once we've checked for blocking and deadlocking.
60 * Andy Walker (andy@lysaker.kvaerner.no), April 03, 1996.
61 *
62 * Initial implementation of mandatory locks. SunOS turned out to be
63 * a rotten model, so I implemented the "obvious" semantics.
Paul Bolle395cf962011-08-15 02:02:26 +020064 * See 'Documentation/filesystems/mandatory-locking.txt' for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 * Andy Walker (andy@lysaker.kvaerner.no), April 06, 1996.
66 *
67 * Don't allow mandatory locks on mmap()'ed files. Added simple functions to
68 * check if a file has mandatory locks, used by mmap(), open() and creat() to
69 * see if system call should be rejected. Ref. HP-UX/SunOS/Solaris Reference
70 * Manual, Section 2.
71 * Andy Walker (andy@lysaker.kvaerner.no), April 09, 1996.
72 *
73 * Tidied up block list handling. Added '/proc/locks' interface.
74 * Andy Walker (andy@lysaker.kvaerner.no), April 24, 1996.
75 *
76 * Fixed deadlock condition for pathological code that mixes calls to
77 * flock() and fcntl().
78 * Andy Walker (andy@lysaker.kvaerner.no), April 29, 1996.
79 *
80 * Allow only one type of locking scheme (FL_POSIX or FL_FLOCK) to be in use
81 * for a given file at a time. Changed the CONFIG_LOCK_MANDATORY scheme to
82 * guarantee sensible behaviour in the case where file system modules might
83 * be compiled with different options than the kernel itself.
84 * Andy Walker (andy@lysaker.kvaerner.no), May 15, 1996.
85 *
86 * Added a couple of missing wake_up() calls. Thanks to Thomas Meckel
87 * (Thomas.Meckel@mni.fh-giessen.de) for spotting this.
88 * Andy Walker (andy@lysaker.kvaerner.no), May 15, 1996.
89 *
90 * Changed FL_POSIX locks to use the block list in the same way as FL_FLOCK
91 * locks. Changed process synchronisation to avoid dereferencing locks that
92 * have already been freed.
93 * Andy Walker (andy@lysaker.kvaerner.no), Sep 21, 1996.
94 *
95 * Made the block list a circular list to minimise searching in the list.
96 * Andy Walker (andy@lysaker.kvaerner.no), Sep 25, 1996.
97 *
98 * Made mandatory locking a mount option. Default is not to allow mandatory
99 * locking.
100 * Andy Walker (andy@lysaker.kvaerner.no), Oct 04, 1996.
101 *
102 * Some adaptations for NFS support.
103 * Olaf Kirch (okir@monad.swb.de), Dec 1996,
104 *
105 * Fixed /proc/locks interface so that we can't overrun the buffer we are handed.
106 * Andy Walker (andy@lysaker.kvaerner.no), May 12, 1997.
107 *
108 * Use slab allocator instead of kmalloc/kfree.
109 * Use generic list implementation from <linux/list.h>.
110 * Sped up posix_locks_deadlock by only considering blocked locks.
111 * Matthew Wilcox <willy@debian.org>, March, 2000.
112 *
113 * Leases and LOCK_MAND
114 * Matthew Wilcox <willy@debian.org>, June, 2000.
115 * Stephen Rothwell <sfr@canb.auug.org.au>, June, 2000.
NeilBrownfd7732e2018-11-30 10:04:08 +1100116 *
117 * Locking conflicts and dependencies:
118 * If multiple threads attempt to lock the same byte (or flock the same file)
119 * only one can be granted the lock, and other must wait their turn.
120 * The first lock has been "applied" or "granted", the others are "waiting"
121 * and are "blocked" by the "applied" lock..
122 *
123 * Waiting and applied locks are all kept in trees whose properties are:
124 *
125 * - the root of a tree may be an applied or waiting lock.
126 * - every other node in the tree is a waiting lock that
127 * conflicts with every ancestor of that node.
128 *
129 * Every such tree begins life as a waiting singleton which obviously
130 * satisfies the above properties.
131 *
132 * The only ways we modify trees preserve these properties:
133 *
134 * 1. We may add a new leaf node, but only after first verifying that it
135 * conflicts with all of its ancestors.
136 * 2. We may remove the root of a tree, creating a new singleton
137 * tree from the root and N new trees rooted in the immediate
138 * children.
139 * 3. If the root of a tree is not currently an applied lock, we may
140 * apply it (if possible).
141 * 4. We may upgrade the root of the tree (either extend its range,
142 * or upgrade its entire range from read to write).
143 *
144 * When an applied lock is modified in a way that reduces or downgrades any
145 * part of its range, we remove all its children (2 above). This particularly
146 * happens when a lock is unlocked.
147 *
148 * For each of those child trees we "wake up" the thread which is
149 * waiting for the lock so it can continue handling as follows: if the
150 * root of the tree applies, we do so (3). If it doesn't, it must
151 * conflict with some applied lock. We remove (wake up) all of its children
152 * (2), and add it is a new leaf to the tree rooted in the applied
153 * lock (1). We then repeat the process recursively with those
154 * children.
155 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 */
157
158#include <linux/capability.h>
159#include <linux/file.h>
Al Viro9f3acc32008-04-24 07:44:08 -0400160#include <linux/fdtable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161#include <linux/fs.h>
162#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163#include <linux/security.h>
164#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165#include <linux/syscalls.h>
166#include <linux/time.h>
Dipankar Sarma4fb3a532005-09-16 19:28:13 -0700167#include <linux/rcupdate.h>
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000168#include <linux/pid_namespace.h>
Jeff Layton48f74182013-06-21 08:58:18 -0400169#include <linux/hashtable.h>
Jeff Layton7012b022013-06-21 08:58:22 -0400170#include <linux/percpu.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
Jeff Layton62af4f12014-05-09 14:13:05 -0400172#define CREATE_TRACE_POINTS
173#include <trace/events/filelock.h>
174
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -0800175#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177#define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
178#define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
Christoph Hellwig11afe9f2015-01-21 19:17:03 +0100179#define IS_LEASE(fl) (fl->fl_flags & (FL_LEASE|FL_DELEG|FL_LAYOUT))
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400180#define IS_OFDLCK(fl) (fl->fl_flags & FL_OFDLCK)
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -0400181#define IS_REMOTELCK(fl) (fl->fl_pid <= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400183static bool lease_breaking(struct file_lock *fl)
184{
J. Bruce Fields778fc542011-07-26 18:25:49 -0400185 return fl->fl_flags & (FL_UNLOCK_PENDING | FL_DOWNGRADE_PENDING);
186}
187
188static int target_leasetype(struct file_lock *fl)
189{
190 if (fl->fl_flags & FL_UNLOCK_PENDING)
191 return F_UNLCK;
192 if (fl->fl_flags & FL_DOWNGRADE_PENDING)
193 return F_RDLCK;
194 return fl->fl_type;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400195}
196
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197int leases_enable = 1;
198int lease_break_time = 45;
199
Jeff Layton1c8c6012013-06-21 08:58:15 -0400200/*
Jeff Layton7012b022013-06-21 08:58:22 -0400201 * The global file_lock_list is only used for displaying /proc/locks, so we
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200202 * keep a list on each CPU, with each list protected by its own spinlock.
203 * Global serialization is done using file_rwsem.
204 *
205 * Note that alterations to the list also require that the relevant flc_lock is
206 * held.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400207 */
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200208struct file_lock_list_struct {
209 spinlock_t lock;
210 struct hlist_head hlist;
211};
212static DEFINE_PER_CPU(struct file_lock_list_struct, file_lock_list);
Peter Zijlstraaba37662015-06-22 14:16:33 +0200213DEFINE_STATIC_PERCPU_RWSEM(file_rwsem);
Jeff Layton88974692013-06-21 08:58:14 -0400214
Jeff Layton1c8c6012013-06-21 08:58:15 -0400215/*
Jeff Layton48f74182013-06-21 08:58:18 -0400216 * The blocked_hash is used to find POSIX lock loops for deadlock detection.
Jeff Layton7b2296a2013-06-21 08:58:20 -0400217 * It is protected by blocked_lock_lock.
Jeff Layton48f74182013-06-21 08:58:18 -0400218 *
219 * We hash locks by lockowner in order to optimize searching for the lock a
220 * particular lockowner is waiting on.
221 *
222 * FIXME: make this value scale via some heuristic? We generally will want more
223 * buckets when we have more lockowners holding locks, but that's a little
224 * difficult to determine without knowing what the workload will look like.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400225 */
Jeff Layton48f74182013-06-21 08:58:18 -0400226#define BLOCKED_HASH_BITS 7
227static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
Jeff Layton88974692013-06-21 08:58:14 -0400228
Jeff Layton1c8c6012013-06-21 08:58:15 -0400229/*
Jeff Layton7b2296a2013-06-21 08:58:20 -0400230 * This lock protects the blocked_hash. Generally, if you're accessing it, you
231 * want to be holding this lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400232 *
NeilBrownada5c1d2018-11-30 10:04:08 +1100233 * In addition, it also protects the fl->fl_blocked_requests list, and the
234 * fl->fl_blocker pointer for file_lock structures that are acting as lock
235 * requests (in contrast to those that are acting as records of acquired locks).
Jeff Layton1c8c6012013-06-21 08:58:15 -0400236 *
237 * Note that when we acquire this lock in order to change the above fields,
Jeff Layton6109c852015-01-16 15:05:57 -0500238 * we often hold the flc_lock as well. In certain cases, when reading the fields
Jeff Layton1c8c6012013-06-21 08:58:15 -0400239 * protected by this lock, we can skip acquiring it iff we already hold the
Jeff Layton6109c852015-01-16 15:05:57 -0500240 * flc_lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400241 */
Jeff Layton7b2296a2013-06-21 08:58:20 -0400242static DEFINE_SPINLOCK(blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
Jeff Layton4a075e32015-01-16 15:05:54 -0500244static struct kmem_cache *flctx_cache __read_mostly;
Christoph Lametere18b8902006-12-06 20:33:20 -0800245static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
Jeff Layton4a075e32015-01-16 15:05:54 -0500247static struct file_lock_context *
Jeff Layton5c1c6692015-04-03 09:04:03 -0400248locks_get_lock_context(struct inode *inode, int type)
Jeff Layton4a075e32015-01-16 15:05:54 -0500249{
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200250 struct file_lock_context *ctx;
Jeff Layton4a075e32015-01-16 15:05:54 -0500251
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200252 /* paired with cmpxchg() below */
253 ctx = smp_load_acquire(&inode->i_flctx);
254 if (likely(ctx) || type == F_UNLCK)
Jeff Layton4a075e32015-01-16 15:05:54 -0500255 goto out;
256
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200257 ctx = kmem_cache_alloc(flctx_cache, GFP_KERNEL);
258 if (!ctx)
Jeff Layton4a075e32015-01-16 15:05:54 -0500259 goto out;
260
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200261 spin_lock_init(&ctx->flc_lock);
262 INIT_LIST_HEAD(&ctx->flc_flock);
263 INIT_LIST_HEAD(&ctx->flc_posix);
264 INIT_LIST_HEAD(&ctx->flc_lease);
Jeff Layton4a075e32015-01-16 15:05:54 -0500265
266 /*
267 * Assign the pointer if it's not already assigned. If it is, then
268 * free the context we just allocated.
269 */
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200270 if (cmpxchg(&inode->i_flctx, NULL, ctx)) {
271 kmem_cache_free(flctx_cache, ctx);
272 ctx = smp_load_acquire(&inode->i_flctx);
273 }
Jeff Layton4a075e32015-01-16 15:05:54 -0500274out:
Jeff Layton18909102016-01-06 21:26:10 -0500275 trace_locks_get_lock_context(inode, type, ctx);
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200276 return ctx;
Jeff Layton4a075e32015-01-16 15:05:54 -0500277}
278
Jeff Laytone24dada2016-01-06 21:28:41 -0500279static void
280locks_dump_ctx_list(struct list_head *list, char *list_type)
281{
282 struct file_lock *fl;
283
284 list_for_each_entry(fl, list, fl_list) {
285 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);
286 }
287}
288
289static void
290locks_check_ctx_lists(struct inode *inode)
291{
292 struct file_lock_context *ctx = inode->i_flctx;
293
294 if (unlikely(!list_empty(&ctx->flc_flock) ||
295 !list_empty(&ctx->flc_posix) ||
296 !list_empty(&ctx->flc_lease))) {
297 pr_warn("Leaked locks on dev=0x%x:0x%x ino=0x%lx:\n",
298 MAJOR(inode->i_sb->s_dev), MINOR(inode->i_sb->s_dev),
299 inode->i_ino);
300 locks_dump_ctx_list(&ctx->flc_flock, "FLOCK");
301 locks_dump_ctx_list(&ctx->flc_posix, "POSIX");
302 locks_dump_ctx_list(&ctx->flc_lease, "LEASE");
303 }
304}
305
Benjamin Coddington39537042017-07-21 13:36:25 -0400306static void
307locks_check_ctx_file_list(struct file *filp, struct list_head *list,
308 char *list_type)
309{
310 struct file_lock *fl;
311 struct inode *inode = locks_inode(filp);
312
313 list_for_each_entry(fl, list, fl_list)
314 if (fl->fl_file == filp)
315 pr_warn("Leaked %s lock on dev=0x%x:0x%x ino=0x%lx "
316 " fl_owner=%p fl_flags=0x%x fl_type=0x%x fl_pid=%u\n",
317 list_type, MAJOR(inode->i_sb->s_dev),
318 MINOR(inode->i_sb->s_dev), inode->i_ino,
319 fl->fl_owner, fl->fl_flags, fl->fl_type, fl->fl_pid);
320}
321
Jeff Layton4a075e32015-01-16 15:05:54 -0500322void
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500323locks_free_lock_context(struct inode *inode)
Jeff Layton4a075e32015-01-16 15:05:54 -0500324{
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500325 struct file_lock_context *ctx = inode->i_flctx;
326
Jeff Laytone24dada2016-01-06 21:28:41 -0500327 if (unlikely(ctx)) {
328 locks_check_ctx_lists(inode);
Jeff Layton4a075e32015-01-16 15:05:54 -0500329 kmem_cache_free(flctx_cache, ctx);
330 }
331}
332
Miklos Szerediee19cc42011-07-07 13:06:09 +0200333static void locks_init_lock_heads(struct file_lock *fl)
Miklos Szeredia51cb912011-07-06 12:33:55 +0200334{
Jeff Layton139ca042013-06-21 08:58:17 -0400335 INIT_HLIST_NODE(&fl->fl_link);
Jeff Layton6dee60f2015-01-16 15:05:54 -0500336 INIT_LIST_HEAD(&fl->fl_list);
NeilBrownada5c1d2018-11-30 10:04:08 +1100337 INIT_LIST_HEAD(&fl->fl_blocked_requests);
338 INIT_LIST_HEAD(&fl->fl_blocked_member);
Miklos Szerediee19cc42011-07-07 13:06:09 +0200339 init_waitqueue_head(&fl->fl_wait);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200340}
341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200343struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200345 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200346
347 if (fl)
Miklos Szerediee19cc42011-07-07 13:06:09 +0200348 locks_init_lock_heads(fl);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200349
350 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200352EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500354void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500355{
NeilBrown59264592019-04-24 12:00:08 +1000356 BUG_ON(waitqueue_active(&fl->fl_wait));
357 BUG_ON(!list_empty(&fl->fl_list));
358 BUG_ON(!list_empty(&fl->fl_blocked_requests));
359 BUG_ON(!list_empty(&fl->fl_blocked_member));
360 BUG_ON(!hlist_unhashed(&fl->fl_link));
361
Trond Myklebust47831f32006-03-20 13:44:05 -0500362 if (fl->fl_ops) {
363 if (fl->fl_ops->fl_release_private)
364 fl->fl_ops->fl_release_private(fl);
365 fl->fl_ops = NULL;
366 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500367
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400368 if (fl->fl_lmops) {
Jeff Laytoncae80b32015-04-03 09:04:04 -0400369 if (fl->fl_lmops->lm_put_owner) {
370 fl->fl_lmops->lm_put_owner(fl->fl_owner);
371 fl->fl_owner = NULL;
372 }
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400373 fl->fl_lmops = NULL;
374 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500375}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500376EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500377
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378/* Free a lock which is not in use. */
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400379void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380{
Trond Myklebust47831f32006-03-20 13:44:05 -0500381 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 kmem_cache_free(filelock_cache, fl);
383}
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400384EXPORT_SYMBOL(locks_free_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
Jeff Laytoned9814d2014-08-11 14:20:31 -0400386static void
387locks_dispose_list(struct list_head *dispose)
388{
389 struct file_lock *fl;
390
391 while (!list_empty(dispose)) {
Jeff Layton6dee60f2015-01-16 15:05:54 -0500392 fl = list_first_entry(dispose, struct file_lock, fl_list);
393 list_del_init(&fl->fl_list);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400394 locks_free_lock(fl);
395 }
396}
397
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398void locks_init_lock(struct file_lock *fl)
399{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200400 memset(fl, 0, sizeof(struct file_lock));
401 locks_init_lock_heads(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403EXPORT_SYMBOL(locks_init_lock);
404
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405/*
406 * Initialize a new lock from an existing file_lock structure.
407 */
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400408void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409{
410 new->fl_owner = fl->fl_owner;
411 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500412 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 new->fl_flags = fl->fl_flags;
414 new->fl_type = fl->fl_type;
415 new->fl_start = fl->fl_start;
416 new->fl_end = fl->fl_end;
Kinglong Meef3282962014-08-22 10:18:43 -0400417 new->fl_lmops = fl->fl_lmops;
Trond Myklebust09969052006-03-20 13:44:38 -0500418 new->fl_ops = NULL;
Kinglong Meef3282962014-08-22 10:18:43 -0400419
420 if (fl->fl_lmops) {
421 if (fl->fl_lmops->lm_get_owner)
Jeff Laytoncae80b32015-04-03 09:04:04 -0400422 fl->fl_lmops->lm_get_owner(fl->fl_owner);
Kinglong Meef3282962014-08-22 10:18:43 -0400423 }
Trond Myklebust09969052006-03-20 13:44:38 -0500424}
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400425EXPORT_SYMBOL(locks_copy_conflock);
Trond Myklebust09969052006-03-20 13:44:38 -0500426
427void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
428{
Jeff Layton566709b2014-08-11 14:09:35 -0400429 /* "new" must be a freshly-initialized lock */
430 WARN_ON_ONCE(new->fl_ops);
Trond Myklebust09969052006-03-20 13:44:38 -0500431
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400432 locks_copy_conflock(new, fl);
Kinglong Meef3282962014-08-22 10:18:43 -0400433
Trond Myklebust09969052006-03-20 13:44:38 -0500434 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 new->fl_ops = fl->fl_ops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500436
Kinglong Meef3282962014-08-22 10:18:43 -0400437 if (fl->fl_ops) {
438 if (fl->fl_ops->fl_copy_lock)
439 fl->fl_ops->fl_copy_lock(new, fl);
440 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442EXPORT_SYMBOL(locks_copy_lock);
443
NeilBrown5946c432018-11-30 10:04:08 +1100444static void locks_move_blocks(struct file_lock *new, struct file_lock *fl)
445{
446 struct file_lock *f;
447
448 /*
449 * As ctx->flc_lock is held, new requests cannot be added to
450 * ->fl_blocked_requests, so we don't need a lock to check if it
451 * is empty.
452 */
453 if (list_empty(&fl->fl_blocked_requests))
454 return;
455 spin_lock(&blocked_lock_lock);
456 list_splice_init(&fl->fl_blocked_requests, &new->fl_blocked_requests);
NeilBrownbf77ae42019-01-03 11:04:08 +1100457 list_for_each_entry(f, &new->fl_blocked_requests, fl_blocked_member)
NeilBrown5946c432018-11-30 10:04:08 +1100458 f->fl_blocker = new;
459 spin_unlock(&blocked_lock_lock);
460}
461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462static inline int flock_translate_cmd(int cmd) {
463 if (cmd & LOCK_MAND)
464 return cmd & (LOCK_MAND | LOCK_RW);
465 switch (cmd) {
466 case LOCK_SH:
467 return F_RDLCK;
468 case LOCK_EX:
469 return F_WRLCK;
470 case LOCK_UN:
471 return F_UNLCK;
472 }
473 return -EINVAL;
474}
475
476/* Fill in a file_lock structure with an appropriate FLOCK lock. */
Jeff Layton6e129d002014-09-04 10:25:06 -0400477static struct file_lock *
NeilBrownd6367d62018-11-30 10:04:08 +1100478flock_make_lock(struct file *filp, unsigned int cmd, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 int type = flock_translate_cmd(cmd);
Jeff Layton6e129d002014-09-04 10:25:06 -0400481
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 if (type < 0)
Jeff Layton6e129d002014-09-04 10:25:06 -0400483 return ERR_PTR(type);
NeilBrown7bbd1fc2018-11-30 10:04:08 +1100484
NeilBrownd6367d62018-11-30 10:04:08 +1100485 if (fl == NULL) {
486 fl = locks_alloc_lock();
487 if (fl == NULL)
488 return ERR_PTR(-ENOMEM);
489 } else {
490 locks_init_lock(fl);
491 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492
493 fl->fl_file = filp;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +0200494 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 fl->fl_pid = current->tgid;
496 fl->fl_flags = FL_FLOCK;
497 fl->fl_type = type;
498 fl->fl_end = OFFSET_MAX;
NeilBrown7bbd1fc2018-11-30 10:04:08 +1100499
Jeff Layton6e129d002014-09-04 10:25:06 -0400500 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501}
502
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400503static int assign_type(struct file_lock *fl, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504{
505 switch (type) {
506 case F_RDLCK:
507 case F_WRLCK:
508 case F_UNLCK:
509 fl->fl_type = type;
510 break;
511 default:
512 return -EINVAL;
513 }
514 return 0;
515}
516
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500517static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
518 struct flock64 *l)
519{
520 switch (l->l_whence) {
521 case SEEK_SET:
522 fl->fl_start = 0;
523 break;
524 case SEEK_CUR:
525 fl->fl_start = filp->f_pos;
526 break;
527 case SEEK_END:
528 fl->fl_start = i_size_read(file_inode(filp));
529 break;
530 default:
531 return -EINVAL;
532 }
533 if (l->l_start > OFFSET_MAX - fl->fl_start)
534 return -EOVERFLOW;
535 fl->fl_start += l->l_start;
536 if (fl->fl_start < 0)
537 return -EINVAL;
538
539 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
540 POSIX-2001 defines it. */
541 if (l->l_len > 0) {
542 if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
543 return -EOVERFLOW;
544 fl->fl_end = fl->fl_start + l->l_len - 1;
545
546 } else if (l->l_len < 0) {
547 if (fl->fl_start + l->l_len < 0)
548 return -EINVAL;
549 fl->fl_end = fl->fl_start - 1;
550 fl->fl_start += l->l_len;
551 } else
552 fl->fl_end = OFFSET_MAX;
553
554 fl->fl_owner = current->files;
555 fl->fl_pid = current->tgid;
556 fl->fl_file = filp;
557 fl->fl_flags = FL_POSIX;
558 fl->fl_ops = NULL;
559 fl->fl_lmops = NULL;
560
561 return assign_type(fl, l->l_type);
562}
563
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
565 * style lock.
566 */
567static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
568 struct flock *l)
569{
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500570 struct flock64 ll = {
571 .l_type = l->l_type,
572 .l_whence = l->l_whence,
573 .l_start = l->l_start,
574 .l_len = l->l_len,
575 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500577 return flock64_to_posix_lock(filp, fl, &ll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578}
579
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580/* default lease lock manager operations */
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400581static bool
582lease_break_callback(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583{
584 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400585 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586}
587
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400588static void
589lease_setup(struct file_lock *fl, void **priv)
590{
591 struct file *filp = fl->fl_file;
592 struct fasync_struct *fa = *priv;
593
594 /*
595 * fasync_insert_entry() returns the old entry if any. If there was no
596 * old entry, then it used "priv" and inserted it into the fasync list.
597 * Clear the pointer to indicate that it shouldn't be freed.
598 */
599 if (!fasync_insert_entry(fa->fa_fd, filp, &fl->fl_fasync, fa))
600 *priv = NULL;
601
Eric W. Biederman01919132017-07-16 22:05:57 -0500602 __f_setown(filp, task_pid(current), PIDTYPE_TGID, 0);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400603}
604
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700605static const struct lock_manager_operations lease_manager_ops = {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400606 .lm_break = lease_break_callback,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400607 .lm_change = lease_modify,
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400608 .lm_setup = lease_setup,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609};
610
611/*
612 * Initialize a lease, use the default lock manager operations
613 */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400614static int lease_init(struct file *filp, long type, struct file_lock *fl)
Joe Perches447a5642018-03-21 15:09:32 -0700615{
Trond Myklebust75dff552006-05-07 23:02:42 -0400616 if (assign_type(fl, type) != 0)
617 return -EINVAL;
618
Jeff Layton7ca76312014-09-01 19:04:48 -0400619 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 fl->fl_pid = current->tgid;
621
622 fl->fl_file = filp;
623 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 fl->fl_start = 0;
625 fl->fl_end = OFFSET_MAX;
626 fl->fl_ops = NULL;
627 fl->fl_lmops = &lease_manager_ops;
628 return 0;
629}
630
631/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400632static struct file_lock *lease_alloc(struct file *filp, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633{
634 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400635 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
637 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500638 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
640 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400641 if (error) {
642 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500643 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400644 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500645 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646}
647
648/* Check if two locks overlap each other.
649 */
650static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
651{
652 return ((fl1->fl_end >= fl2->fl_start) &&
653 (fl2->fl_end >= fl1->fl_start));
654}
655
656/*
657 * Check whether two locks have the same owner.
658 */
Matt Mackall33443c42006-01-08 01:05:22 -0800659static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 return fl1->fl_owner == fl2->fl_owner;
662}
663
Jeff Layton6109c852015-01-16 15:05:57 -0500664/* Must be called with the flc_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500665static void locks_insert_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400666{
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200667 struct file_lock_list_struct *fll = this_cpu_ptr(&file_lock_list);
668
Peter Zijlstraaba37662015-06-22 14:16:33 +0200669 percpu_rwsem_assert_held(&file_rwsem);
670
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200671 spin_lock(&fll->lock);
Jeff Layton7012b022013-06-21 08:58:22 -0400672 fl->fl_link_cpu = smp_processor_id();
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200673 hlist_add_head(&fl->fl_link, &fll->hlist);
674 spin_unlock(&fll->lock);
Jeff Layton88974692013-06-21 08:58:14 -0400675}
676
Jeff Layton6109c852015-01-16 15:05:57 -0500677/* Must be called with the flc_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500678static void locks_delete_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400679{
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200680 struct file_lock_list_struct *fll;
681
Peter Zijlstraaba37662015-06-22 14:16:33 +0200682 percpu_rwsem_assert_held(&file_rwsem);
683
Jeff Layton7012b022013-06-21 08:58:22 -0400684 /*
685 * Avoid taking lock if already unhashed. This is safe since this check
Jeff Layton6109c852015-01-16 15:05:57 -0500686 * is done while holding the flc_lock, and new insertions into the list
Jeff Layton7012b022013-06-21 08:58:22 -0400687 * also require that it be held.
688 */
689 if (hlist_unhashed(&fl->fl_link))
690 return;
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200691
692 fll = per_cpu_ptr(&file_lock_list, fl->fl_link_cpu);
693 spin_lock(&fll->lock);
Jeff Layton139ca042013-06-21 08:58:17 -0400694 hlist_del_init(&fl->fl_link);
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200695 spin_unlock(&fll->lock);
Jeff Layton88974692013-06-21 08:58:14 -0400696}
697
Jeff Layton3999e492013-06-21 08:58:19 -0400698static unsigned long
699posix_owner_key(struct file_lock *fl)
700{
Jeff Layton3999e492013-06-21 08:58:19 -0400701 return (unsigned long)fl->fl_owner;
702}
703
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500704static void locks_insert_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400705{
Daniel Wagner663d5af2015-04-03 09:04:03 -0400706 lockdep_assert_held(&blocked_lock_lock);
707
Jeff Layton3999e492013-06-21 08:58:19 -0400708 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
Jeff Layton88974692013-06-21 08:58:14 -0400709}
710
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500711static void locks_delete_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400712{
Daniel Wagner663d5af2015-04-03 09:04:03 -0400713 lockdep_assert_held(&blocked_lock_lock);
714
Jeff Layton48f74182013-06-21 08:58:18 -0400715 hash_del(&waiter->fl_link);
Jeff Layton88974692013-06-21 08:58:14 -0400716}
717
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718/* Remove waiter from blocker's block list.
719 * When blocker ends up pointing to itself then the list is empty.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400720 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400721 * Must be called with blocked_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 */
Matt Mackall33443c42006-01-08 01:05:22 -0800723static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724{
Jeff Layton88974692013-06-21 08:58:14 -0400725 locks_delete_global_blocked(waiter);
NeilBrownada5c1d2018-11-30 10:04:08 +1100726 list_del_init(&waiter->fl_blocked_member);
727 waiter->fl_blocker = NULL;
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);
742 }
743}
744
NeilBrowncb03f942018-11-30 10:04:08 +1100745/**
746 * locks_delete_lock - stop waiting for a file lock
747 * @waiter: the lock which was waiting
748 *
749 * lockd/nfsd need to disconnect the lock while working on it.
750 */
751int locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752{
NeilBrowncb03f942018-11-30 10:04:08 +1100753 int status = -ENOENT;
754
NeilBrown16306a62018-11-30 10:04:08 +1100755 /*
756 * If fl_blocker is NULL, it won't be set again as this thread
757 * "owns" the lock and is the only one that might try to claim
758 * the lock. So it is safe to test fl_blocker locklessly.
759 * Also if fl_blocker is NULL, this waiter is not listed on
760 * fl_blocked_requests for some lock, so no other request can
761 * be added to the list of fl_blocked_requests for this
762 * request. So if fl_blocker is NULL, it is safe to
763 * locklessly check if fl_blocked_requests is empty. If both
764 * of these checks succeed, there is no need to take the lock.
765 */
766 if (waiter->fl_blocker == NULL &&
767 list_empty(&waiter->fl_blocked_requests))
NeilBrowncb03f942018-11-30 10:04:08 +1100768 return status;
Jeff Layton7b2296a2013-06-21 08:58:20 -0400769 spin_lock(&blocked_lock_lock);
NeilBrowncb03f942018-11-30 10:04:08 +1100770 if (waiter->fl_blocker)
771 status = 0;
NeilBrown5946c432018-11-30 10:04:08 +1100772 __locks_wake_up_blocks(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 __locks_delete_block(waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400774 spin_unlock(&blocked_lock_lock);
NeilBrowncb03f942018-11-30 10:04:08 +1100775 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776}
NeilBrowncb03f942018-11-30 10:04:08 +1100777EXPORT_SYMBOL(locks_delete_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778
779/* Insert waiter into blocker's block list.
780 * We use a circular list so that processes can be easily woken up in
781 * the order they blocked. The documentation doesn't require this but
782 * it seems like the reasonable thing to do.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400783 *
Jeff Layton6109c852015-01-16 15:05:57 -0500784 * Must be called with both the flc_lock and blocked_lock_lock held. The
NeilBrownada5c1d2018-11-30 10:04:08 +1100785 * fl_blocked_requests list itself is protected by the blocked_lock_lock,
786 * but by ensuring that the flc_lock is also held on insertions we can avoid
787 * taking the blocked_lock_lock in some cases when we see that the
788 * fl_blocked_requests list is empty.
NeilBrownfd7732e2018-11-30 10:04:08 +1100789 *
790 * Rather than just adding to the list, we check for conflicts with any existing
791 * waiters, and add beneath any waiter that blocks the new waiter.
792 * Thus wakeups don't happen until needed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400794static void __locks_insert_block(struct file_lock *blocker,
NeilBrownfd7732e2018-11-30 10:04:08 +1100795 struct file_lock *waiter,
796 bool conflict(struct file_lock *,
797 struct file_lock *))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798{
NeilBrownfd7732e2018-11-30 10:04:08 +1100799 struct file_lock *fl;
NeilBrownada5c1d2018-11-30 10:04:08 +1100800 BUG_ON(!list_empty(&waiter->fl_blocked_member));
NeilBrownfd7732e2018-11-30 10:04:08 +1100801
802new_blocker:
803 list_for_each_entry(fl, &blocker->fl_blocked_requests, fl_blocked_member)
804 if (conflict(fl, waiter)) {
805 blocker = fl;
806 goto new_blocker;
807 }
NeilBrownada5c1d2018-11-30 10:04:08 +1100808 waiter->fl_blocker = blocker;
809 list_add_tail(&waiter->fl_blocked_member, &blocker->fl_blocked_requests);
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400810 if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400811 locks_insert_global_blocked(waiter);
NeilBrown5946c432018-11-30 10:04:08 +1100812
813 /* The requests in waiter->fl_blocked are known to conflict with
814 * waiter, but might not conflict with blocker, or the requests
815 * and lock which block it. So they all need to be woken.
816 */
817 __locks_wake_up_blocks(waiter);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400818}
819
Jeff Layton6109c852015-01-16 15:05:57 -0500820/* Must be called with flc_lock held. */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400821static void locks_insert_block(struct file_lock *blocker,
NeilBrownfd7732e2018-11-30 10:04:08 +1100822 struct file_lock *waiter,
823 bool conflict(struct file_lock *,
824 struct file_lock *))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400825{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400826 spin_lock(&blocked_lock_lock);
NeilBrownfd7732e2018-11-30 10:04:08 +1100827 __locks_insert_block(blocker, waiter, conflict);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400828 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829}
830
Jeff Layton1cb36012013-06-21 08:58:12 -0400831/*
832 * Wake up processes blocked waiting for blocker.
833 *
Jeff Layton6109c852015-01-16 15:05:57 -0500834 * Must be called with the inode->flc_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 */
836static void locks_wake_up_blocks(struct file_lock *blocker)
837{
Jeff Layton4e8c7652013-06-21 08:58:16 -0400838 /*
839 * Avoid taking global lock if list is empty. This is safe since new
Jeff Layton6109c852015-01-16 15:05:57 -0500840 * blocked requests are only added to the list under the flc_lock, and
NeilBrownada5c1d2018-11-30 10:04:08 +1100841 * the flc_lock is always held here. Note that removal from the
842 * fl_blocked_requests list does not require the flc_lock, so we must
843 * recheck list_empty() after acquiring the blocked_lock_lock.
Jeff Layton4e8c7652013-06-21 08:58:16 -0400844 */
NeilBrownada5c1d2018-11-30 10:04:08 +1100845 if (list_empty(&blocker->fl_blocked_requests))
Jeff Layton4e8c7652013-06-21 08:58:16 -0400846 return;
847
Jeff Layton7b2296a2013-06-21 08:58:20 -0400848 spin_lock(&blocked_lock_lock);
NeilBrownad6bbd82018-11-30 10:04:08 +1100849 __locks_wake_up_blocks(blocker);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400850 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851}
852
Jeff Layton5263e312015-01-16 15:05:55 -0500853static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500854locks_insert_lock_ctx(struct file_lock *fl, struct list_head *before)
Jeff Layton5263e312015-01-16 15:05:55 -0500855{
Jeff Layton5263e312015-01-16 15:05:55 -0500856 list_add_tail(&fl->fl_list, before);
857 locks_insert_global_locks(fl);
858}
859
Jeff Layton8634b512015-01-16 15:05:55 -0500860static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500861locks_unlink_lock_ctx(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862{
Jeff Layton88974692013-06-21 08:58:14 -0400863 locks_delete_global_locks(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500864 list_del_init(&fl->fl_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 locks_wake_up_blocks(fl);
Jeff Layton24cbe782014-02-03 12:13:06 -0500866}
867
Jeff Layton5263e312015-01-16 15:05:55 -0500868static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500869locks_delete_lock_ctx(struct file_lock *fl, struct list_head *dispose)
Jeff Layton5263e312015-01-16 15:05:55 -0500870{
Jeff Laytone084c1b2015-02-16 14:32:03 -0500871 locks_unlink_lock_ctx(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500872 if (dispose)
873 list_add(&fl->fl_list, dispose);
874 else
875 locks_free_lock(fl);
Jeff Layton5263e312015-01-16 15:05:55 -0500876}
877
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
879 * checks for shared/exclusive status of overlapping locks.
880 */
NeilBrownc0e15902018-11-30 10:04:08 +1100881static bool locks_conflict(struct file_lock *caller_fl,
882 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883{
884 if (sys_fl->fl_type == F_WRLCK)
NeilBrownc0e15902018-11-30 10:04:08 +1100885 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 if (caller_fl->fl_type == F_WRLCK)
NeilBrownc0e15902018-11-30 10:04:08 +1100887 return true;
888 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889}
890
891/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
892 * checking before calling the locks_conflict().
893 */
NeilBrownc0e15902018-11-30 10:04:08 +1100894static bool posix_locks_conflict(struct file_lock *caller_fl,
895 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896{
897 /* POSIX locks owned by the same process do not conflict with
898 * each other.
899 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400900 if (posix_same_owner(caller_fl, sys_fl))
NeilBrownc0e15902018-11-30 10:04:08 +1100901 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
903 /* Check whether they overlap */
904 if (!locks_overlap(caller_fl, sys_fl))
NeilBrownc0e15902018-11-30 10:04:08 +1100905 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906
NeilBrownc0e15902018-11-30 10:04:08 +1100907 return locks_conflict(caller_fl, sys_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908}
909
910/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
911 * checking before calling the locks_conflict().
912 */
NeilBrownc0e15902018-11-30 10:04:08 +1100913static bool flock_locks_conflict(struct file_lock *caller_fl,
914 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915{
916 /* FLOCK locks referring to the same filp do not conflict with
917 * each other.
918 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400919 if (caller_fl->fl_file == sys_fl->fl_file)
NeilBrownc0e15902018-11-30 10:04:08 +1100920 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
NeilBrownc0e15902018-11-30 10:04:08 +1100922 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923
NeilBrownc0e15902018-11-30 10:04:08 +1100924 return locks_conflict(caller_fl, sys_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925}
926
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400927void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500928posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929{
930 struct file_lock *cfl;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500931 struct file_lock_context *ctx;
Miklos Szeredic568d682016-09-16 12:44:20 +0200932 struct inode *inode = locks_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200934 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500935 if (!ctx || list_empty_careful(&ctx->flc_posix)) {
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400936 fl->fl_type = F_UNLCK;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500937 return;
938 }
939
Jeff Layton6109c852015-01-16 15:05:57 -0500940 spin_lock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500941 list_for_each_entry(cfl, &ctx->flc_posix, fl_list) {
942 if (posix_locks_conflict(fl, cfl)) {
943 locks_copy_conflock(fl, cfl);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500944 goto out;
945 }
946 }
947 fl->fl_type = F_UNLCK;
948out:
Jeff Layton6109c852015-01-16 15:05:57 -0500949 spin_unlock(&ctx->flc_lock);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400950 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952EXPORT_SYMBOL(posix_test_lock);
953
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400954/*
955 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400957 * We attempt to detect deadlocks that are due purely to posix file
958 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400960 * We assume that a task can be waiting for at most one lock at a time.
961 * So for any acquired lock, the process holding that lock may be
962 * waiting on at most one other lock. That lock in turns may be held by
963 * someone waiting for at most one other lock. Given a requested lock
964 * caller_fl which is about to wait for a conflicting lock block_fl, we
965 * follow this chain of waiters to ensure we are not about to create a
966 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400967 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400968 * Since we do this before we ever put a process to sleep on a lock, we
969 * are ensured that there is never a cycle; that is what guarantees that
970 * the while() loop in posix_locks_deadlock() eventually completes.
971 *
972 * Note: the above assumption may not be true when handling lock
973 * requests from a broken NFS client. It may also fail in the presence
974 * of tasks (such as posix threads) sharing the same open file table.
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400975 * To handle those cases, we just bail out after a few iterations.
Jeff Layton57b65322014-02-03 12:13:09 -0500976 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400977 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
Jeff Layton57b65322014-02-03 12:13:09 -0500978 * Because the owner is not even nominally tied to a thread of
979 * execution, the deadlock detection below can't reasonably work well. Just
980 * skip it for those.
981 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400982 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
Jeff Layton57b65322014-02-03 12:13:09 -0500983 * locks that just checks for the case where two tasks are attempting to
984 * upgrade from read to write locks on the same inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400986
987#define MAX_DEADLK_ITERATIONS 10
988
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400989/* Find a lock that the owner of the given block_fl is blocking on. */
990static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
991{
992 struct file_lock *fl;
993
Jeff Layton3999e492013-06-21 08:58:19 -0400994 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
NeilBrown5946c432018-11-30 10:04:08 +1100995 if (posix_same_owner(fl, block_fl)) {
996 while (fl->fl_blocker)
997 fl = fl->fl_blocker;
998 return fl;
999 }
J. Bruce Fieldsb5331842007-10-26 18:05:40 -04001000 }
1001 return NULL;
1002}
1003
Jeff Layton7b2296a2013-06-21 08:58:20 -04001004/* Must be called with the blocked_lock_lock held! */
Adrian Bunkb0904e12006-06-23 02:05:13 -07001005static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 struct file_lock *block_fl)
1007{
J. Bruce Fields97855b42007-10-30 11:20:02 -04001008 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009
Daniel Wagner663d5af2015-04-03 09:04:03 -04001010 lockdep_assert_held(&blocked_lock_lock);
1011
Jeff Layton57b65322014-02-03 12:13:09 -05001012 /*
1013 * This deadlock detector can't reasonably detect deadlocks with
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001014 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
Jeff Layton57b65322014-02-03 12:13:09 -05001015 */
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001016 if (IS_OFDLCK(caller_fl))
Jeff Layton57b65322014-02-03 12:13:09 -05001017 return 0;
1018
J. Bruce Fieldsb5331842007-10-26 18:05:40 -04001019 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
1020 if (i++ > MAX_DEADLK_ITERATIONS)
1021 return 0;
1022 if (posix_same_owner(caller_fl, block_fl))
1023 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 }
1025 return 0;
1026}
1027
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -04001029 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -04001030 *
1031 * Note that if called with an FL_EXISTS argument, the caller may determine
1032 * whether or not a lock was successfully freed by testing the return
1033 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 */
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04001035static int flock_lock_inode(struct inode *inode, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036{
Trond Myklebust993dfa82006-03-31 02:30:55 -08001037 struct file_lock *new_fl = NULL;
Jeff Layton5263e312015-01-16 15:05:55 -05001038 struct file_lock *fl;
1039 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 int error = 0;
Jeff Layton5263e312015-01-16 15:05:55 -05001041 bool found = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -04001042 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043
Jeff Layton5c1c6692015-04-03 09:04:03 -04001044 ctx = locks_get_lock_context(inode, request->fl_type);
1045 if (!ctx) {
1046 if (request->fl_type != F_UNLCK)
1047 return -ENOMEM;
1048 return (request->fl_flags & FL_EXISTS) ? -ENOENT : 0;
1049 }
Jeff Layton5263e312015-01-16 15:05:55 -05001050
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001051 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
1052 new_fl = locks_alloc_lock();
1053 if (!new_fl)
1054 return -ENOMEM;
1055 }
1056
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001057 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001058 spin_lock(&ctx->flc_lock);
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001059 if (request->fl_flags & FL_ACCESS)
1060 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +04001061
Jeff Layton5263e312015-01-16 15:05:55 -05001062 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04001063 if (request->fl_file != fl->fl_file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001065 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 goto out;
Jeff Layton5263e312015-01-16 15:05:55 -05001067 found = true;
Jeff Laytone084c1b2015-02-16 14:32:03 -05001068 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 break;
1070 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071
Trond Myklebustf475ae92006-06-29 16:38:32 -04001072 if (request->fl_type == F_UNLCK) {
1073 if ((request->fl_flags & FL_EXISTS) && !found)
1074 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001075 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001076 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001078find_conflict:
Jeff Layton5263e312015-01-16 15:05:55 -05001079 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Trond Myklebust993dfa82006-03-31 02:30:55 -08001080 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 continue;
1082 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -07001083 if (!(request->fl_flags & FL_SLEEP))
1084 goto out;
1085 error = FILE_LOCK_DEFERRED;
NeilBrownfd7732e2018-11-30 10:04:08 +11001086 locks_insert_block(fl, request, flock_locks_conflict);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 goto out;
1088 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001089 if (request->fl_flags & FL_ACCESS)
1090 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001091 locks_copy_lock(new_fl, request);
NeilBrown5946c432018-11-30 10:04:08 +11001092 locks_move_blocks(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001093 locks_insert_lock_ctx(new_fl, &ctx->flc_flock);
Trond Myklebust993dfa82006-03-31 02:30:55 -08001094 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +04001095 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096
1097out:
Jeff Layton6109c852015-01-16 15:05:57 -05001098 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001099 percpu_up_read(&file_rwsem);
Trond Myklebust993dfa82006-03-31 02:30:55 -08001100 if (new_fl)
1101 locks_free_lock(new_fl);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001102 locks_dispose_list(&dispose);
Jeff Laytonc883da32018-07-30 07:54:56 -04001103 trace_flock_lock_inode(inode, request, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 return error;
1105}
1106
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001107static int posix_lock_inode(struct inode *inode, struct file_lock *request,
1108 struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001110 struct file_lock *fl, *tmp;
Miklos Szeredi39005d02006-06-23 02:05:10 -07001111 struct file_lock *new_fl = NULL;
1112 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 struct file_lock *left = NULL;
1114 struct file_lock *right = NULL;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001115 struct file_lock_context *ctx;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001116 int error;
1117 bool added = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -04001118 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119
Jeff Layton5c1c6692015-04-03 09:04:03 -04001120 ctx = locks_get_lock_context(inode, request->fl_type);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001121 if (!ctx)
Jeff Layton5c1c6692015-04-03 09:04:03 -04001122 return (request->fl_type == F_UNLCK) ? 0 : -ENOMEM;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001123
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 /*
1125 * We may need two file_lock structures for this operation,
1126 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -07001127 *
1128 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 */
Miklos Szeredi39005d02006-06-23 02:05:10 -07001130 if (!(request->fl_flags & FL_ACCESS) &&
1131 (request->fl_type != F_UNLCK ||
1132 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
1133 new_fl = locks_alloc_lock();
1134 new_fl2 = locks_alloc_lock();
1135 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001137 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001138 spin_lock(&ctx->flc_lock);
Jeff Layton1cb36012013-06-21 08:58:12 -04001139 /*
1140 * New lock request. Walk all POSIX locks and look for conflicts. If
1141 * there are any, either return error or put the request on the
Jeff Layton48f74182013-06-21 08:58:18 -04001142 * blocker's list of waiters and the global blocked_hash.
Jeff Layton1cb36012013-06-21 08:58:12 -04001143 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 if (request->fl_type != F_UNLCK) {
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001145 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 if (!posix_locks_conflict(request, fl))
1147 continue;
Andy Adamson5842add2006-03-26 01:37:26 -08001148 if (conflock)
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001149 locks_copy_conflock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 error = -EAGAIN;
1151 if (!(request->fl_flags & FL_SLEEP))
1152 goto out;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001153 /*
1154 * Deadlock detection and insertion into the blocked
1155 * locks list must be done while holding the same lock!
1156 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 error = -EDEADLK;
Jeff Layton7b2296a2013-06-21 08:58:20 -04001158 spin_lock(&blocked_lock_lock);
Jeff Layton945ab8f2019-03-25 08:15:14 -04001159 /*
1160 * Ensure that we don't find any locks blocked on this
1161 * request during deadlock detection.
1162 */
1163 __locks_wake_up_blocks(request);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001164 if (likely(!posix_locks_deadlock(request, fl))) {
1165 error = FILE_LOCK_DEFERRED;
NeilBrownfd7732e2018-11-30 10:04:08 +11001166 __locks_insert_block(fl, request,
1167 posix_locks_conflict);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001168 }
Jeff Layton7b2296a2013-06-21 08:58:20 -04001169 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170 goto out;
NeilBrown7bbd1fc2018-11-30 10:04:08 +11001171 }
1172 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173
1174 /* If we're just looking for a conflict, we're done. */
1175 error = 0;
1176 if (request->fl_flags & FL_ACCESS)
1177 goto out;
1178
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001179 /* Find the first old lock with the same owner as the new lock */
1180 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1181 if (posix_same_owner(request, fl))
1182 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 }
1184
Jeff Layton1cb36012013-06-21 08:58:12 -04001185 /* Process locks with this owner. */
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001186 list_for_each_entry_safe_from(fl, tmp, &ctx->flc_posix, fl_list) {
1187 if (!posix_same_owner(request, fl))
1188 break;
1189
1190 /* Detect adjacent or overlapping regions (if same lock type) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -07001192 /* In all comparisons of start vs end, use
1193 * "start - 1" rather than "end + 1". If end
1194 * is OFFSET_MAX, end + 1 will become negative.
1195 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 if (fl->fl_end < request->fl_start - 1)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001197 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 /* If the next lock in the list has entirely bigger
1199 * addresses than the new one, insert the lock here.
1200 */
Olaf Kirch449231d2005-08-25 16:25:35 -07001201 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 break;
1203
1204 /* If we come here, the new and old lock are of the
1205 * same type and adjacent or overlapping. Make one
1206 * lock yielding from the lower start address of both
1207 * locks to the higher end address.
1208 */
1209 if (fl->fl_start > request->fl_start)
1210 fl->fl_start = request->fl_start;
1211 else
1212 request->fl_start = fl->fl_start;
1213 if (fl->fl_end < request->fl_end)
1214 fl->fl_end = request->fl_end;
1215 else
1216 request->fl_end = fl->fl_end;
1217 if (added) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001218 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 continue;
1220 }
1221 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001222 added = true;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001223 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 /* Processing for different lock types is a bit
1225 * more complex.
1226 */
1227 if (fl->fl_end < request->fl_start)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001228 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 if (fl->fl_start > request->fl_end)
1230 break;
1231 if (request->fl_type == F_UNLCK)
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001232 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 if (fl->fl_start < request->fl_start)
1234 left = fl;
1235 /* If the next lock in the list has a higher end
1236 * address than the new one, insert the new one here.
1237 */
1238 if (fl->fl_end > request->fl_end) {
1239 right = fl;
1240 break;
1241 }
1242 if (fl->fl_start >= request->fl_start) {
1243 /* The new lock completely replaces an old
1244 * one (This may happen several times).
1245 */
1246 if (added) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001247 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 continue;
1249 }
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001250 /*
1251 * Replace the old lock with new_fl, and
1252 * remove the old one. It's safe to do the
1253 * insert here since we know that we won't be
1254 * using new_fl later, and that the lock is
1255 * just replacing an existing lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256 */
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001257 error = -ENOLCK;
1258 if (!new_fl)
1259 goto out;
1260 locks_copy_lock(new_fl, request);
1261 request = new_fl;
1262 new_fl = NULL;
Jeff Laytone084c1b2015-02-16 14:32:03 -05001263 locks_insert_lock_ctx(request, &fl->fl_list);
1264 locks_delete_lock_ctx(fl, &dispose);
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001265 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 }
1267 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 }
1269
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001270 /*
Jeff Layton1cb36012013-06-21 08:58:12 -04001271 * The above code only modifies existing locks in case of merging or
1272 * replacing. If new lock(s) need to be inserted all modifications are
1273 * done below this, so it's safe yet to bail out.
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001274 */
1275 error = -ENOLCK; /* "no luck" */
1276 if (right && left == right && !new_fl2)
1277 goto out;
1278
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279 error = 0;
1280 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -04001281 if (request->fl_type == F_UNLCK) {
1282 if (request->fl_flags & FL_EXISTS)
1283 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001285 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001286
1287 if (!new_fl) {
1288 error = -ENOLCK;
1289 goto out;
1290 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 locks_copy_lock(new_fl, request);
NeilBrown5946c432018-11-30 10:04:08 +11001292 locks_move_blocks(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001293 locks_insert_lock_ctx(new_fl, &fl->fl_list);
Jeff Layton2e2f756f2015-02-17 17:08:23 -05001294 fl = new_fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 new_fl = NULL;
1296 }
1297 if (right) {
1298 if (left == right) {
1299 /* The new lock breaks the old one in two pieces,
1300 * so we have to use the second new lock.
1301 */
1302 left = new_fl2;
1303 new_fl2 = NULL;
1304 locks_copy_lock(left, right);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001305 locks_insert_lock_ctx(left, &fl->fl_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 }
1307 right->fl_start = request->fl_end + 1;
1308 locks_wake_up_blocks(right);
1309 }
1310 if (left) {
1311 left->fl_end = request->fl_start - 1;
1312 locks_wake_up_blocks(left);
1313 }
1314 out:
Jeff Layton6109c852015-01-16 15:05:57 -05001315 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001316 percpu_up_read(&file_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 /*
1318 * Free any unused locks.
1319 */
1320 if (new_fl)
1321 locks_free_lock(new_fl);
1322 if (new_fl2)
1323 locks_free_lock(new_fl2);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001324 locks_dispose_list(&dispose);
Jeff Layton18909102016-01-06 21:26:10 -05001325 trace_posix_lock_inode(inode, request, error);
1326
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 return error;
1328}
1329
1330/**
1331 * posix_lock_file - Apply a POSIX-style lock to a file
1332 * @filp: The file to apply the lock to
1333 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001334 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 *
1336 * Add a POSIX style lock to a file.
1337 * We merge adjacent & overlapping locks whenever possible.
1338 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001339 *
1340 * Note that if called with an FL_EXISTS argument, the caller may determine
1341 * whether or not a lock was successfully freed by testing the return
1342 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 */
Marc Eshel150b3932007-01-18 16:15:35 -05001344int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001345 struct file_lock *conflock)
1346{
Miklos Szeredic568d682016-09-16 12:44:20 +02001347 return posix_lock_inode(locks_inode(filp), fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001348}
Marc Eshel150b3932007-01-18 16:15:35 -05001349EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350
1351/**
Jeff Layton29d01b22015-07-11 06:43:02 -04001352 * posix_lock_inode_wait - Apply a POSIX-style lock to a file
1353 * @inode: inode of file to which lock request should be applied
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 * @fl: The lock to be applied
1355 *
Benjamin Coddington616fb382015-10-22 13:38:15 -04001356 * Apply a POSIX style lock request to an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 */
Benjamin Coddington616fb382015-10-22 13:38:15 -04001358static int posix_lock_inode_wait(struct inode *inode, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359{
1360 int error;
1361 might_sleep ();
1362 for (;;) {
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001363 error = posix_lock_inode(inode, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001364 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11001366 error = wait_event_interruptible(fl->fl_wait, !fl->fl_blocker);
NeilBrown16306a62018-11-30 10:04:08 +11001367 if (error)
1368 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 }
NeilBrown16306a62018-11-30 10:04:08 +11001370 locks_delete_block(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 return error;
1372}
Jeff Layton29d01b22015-07-11 06:43:02 -04001373
Jeff Layton9e8925b2015-11-16 09:49:34 -05001374#ifdef CONFIG_MANDATORY_FILE_LOCKING
Jeff Layton29d01b22015-07-11 06:43:02 -04001375/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 * locks_mandatory_locked - Check for an active lock
Jeff Laytond7a06982014-03-10 09:54:15 -04001377 * @file: the file to check
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 *
1379 * Searches the inode's list of locks to find any POSIX locks which conflict.
1380 * This function is called from locks_verify_locked() only.
1381 */
Jeff Laytond7a06982014-03-10 09:54:15 -04001382int locks_mandatory_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001384 int ret;
Miklos Szeredic568d682016-09-16 12:44:20 +02001385 struct inode *inode = locks_inode(file);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001386 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 struct file_lock *fl;
1388
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001389 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001390 if (!ctx || list_empty_careful(&ctx->flc_posix))
1391 return 0;
1392
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 /*
1394 * Search the lock list for this inode for any POSIX locks.
1395 */
Jeff Layton6109c852015-01-16 15:05:57 -05001396 spin_lock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001397 ret = 0;
1398 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001399 if (fl->fl_owner != current->files &&
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001400 fl->fl_owner != file) {
1401 ret = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 break;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001403 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 }
Jeff Layton6109c852015-01-16 15:05:57 -05001405 spin_unlock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001406 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407}
1408
1409/**
1410 * locks_mandatory_area - Check for a conflicting lock
Christoph Hellwigacc15572015-12-03 12:59:49 +01001411 * @inode: the file to check
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 * @filp: how the file was opened (if it was)
Christoph Hellwigacc15572015-12-03 12:59:49 +01001413 * @start: first byte in the file to check
1414 * @end: lastbyte in the file to check
1415 * @type: %F_WRLCK for a write lock, else %F_RDLCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 *
1417 * Searches the inode's list of locks to find any POSIX locks which conflict.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 */
Christoph Hellwigacc15572015-12-03 12:59:49 +01001419int locks_mandatory_area(struct inode *inode, struct file *filp, loff_t start,
1420 loff_t end, unsigned char type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421{
1422 struct file_lock fl;
1423 int error;
Jeff Layton29723ad2014-03-10 09:54:19 -04001424 bool sleep = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425
1426 locks_init_lock(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 fl.fl_pid = current->tgid;
1428 fl.fl_file = filp;
1429 fl.fl_flags = FL_POSIX | FL_ACCESS;
1430 if (filp && !(filp->f_flags & O_NONBLOCK))
Jeff Layton29723ad2014-03-10 09:54:19 -04001431 sleep = true;
Christoph Hellwigacc15572015-12-03 12:59:49 +01001432 fl.fl_type = type;
1433 fl.fl_start = start;
1434 fl.fl_end = end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435
1436 for (;;) {
Jeff Layton29723ad2014-03-10 09:54:19 -04001437 if (filp) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001438 fl.fl_owner = filp;
Jeff Layton29723ad2014-03-10 09:54:19 -04001439 fl.fl_flags &= ~FL_SLEEP;
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001440 error = posix_lock_inode(inode, &fl, NULL);
Jeff Layton29723ad2014-03-10 09:54:19 -04001441 if (!error)
1442 break;
1443 }
1444
1445 if (sleep)
1446 fl.fl_flags |= FL_SLEEP;
1447 fl.fl_owner = current->files;
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001448 error = posix_lock_inode(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001449 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11001451 error = wait_event_interruptible(fl.fl_wait, !fl.fl_blocker);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 if (!error) {
1453 /*
1454 * If we've been sleeping someone might have
1455 * changed the permissions behind our back.
1456 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001457 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 continue;
1459 }
1460
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 break;
1462 }
NeilBrown16306a62018-11-30 10:04:08 +11001463 locks_delete_block(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464
1465 return error;
1466}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467EXPORT_SYMBOL(locks_mandatory_area);
Jeff Layton9e8925b2015-11-16 09:49:34 -05001468#endif /* CONFIG_MANDATORY_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469
J. Bruce Fields778fc542011-07-26 18:25:49 -04001470static void lease_clear_pending(struct file_lock *fl, int arg)
1471{
1472 switch (arg) {
1473 case F_UNLCK:
1474 fl->fl_flags &= ~FL_UNLOCK_PENDING;
Gustavo A. R. Silva0a4c9262019-01-23 02:48:28 -06001475 /* fall through */
J. Bruce Fields778fc542011-07-26 18:25:49 -04001476 case F_RDLCK:
1477 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1478 }
1479}
1480
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481/* We already had a lease on this file; just change its type */
Jeff Layton7448cc32015-01-16 15:05:57 -05001482int lease_modify(struct file_lock *fl, int arg, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 int error = assign_type(fl, arg);
1485
1486 if (error)
1487 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001488 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001490 if (arg == F_UNLCK) {
1491 struct file *filp = fl->fl_file;
1492
1493 f_delown(filp);
1494 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001495 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1496 if (fl->fl_fasync != NULL) {
1497 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1498 fl->fl_fasync = NULL;
1499 }
Jeff Laytone084c1b2015-02-16 14:32:03 -05001500 locks_delete_lock_ctx(fl, dispose);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001501 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 return 0;
1503}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504EXPORT_SYMBOL(lease_modify);
1505
J. Bruce Fields778fc542011-07-26 18:25:49 -04001506static bool past_time(unsigned long then)
1507{
1508 if (!then)
1509 /* 0 is a special value meaning "this never expires": */
1510 return false;
1511 return time_after(jiffies, then);
1512}
1513
Jeff Laytonc45198e2014-09-01 07:12:07 -04001514static void time_out_leases(struct inode *inode, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515{
Jeff Layton8634b512015-01-16 15:05:55 -05001516 struct file_lock_context *ctx = inode->i_flctx;
1517 struct file_lock *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518
Jeff Layton6109c852015-01-16 15:05:57 -05001519 lockdep_assert_held(&ctx->flc_lock);
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001520
Jeff Layton8634b512015-01-16 15:05:55 -05001521 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001522 trace_time_out_leases(inode, fl);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001523 if (past_time(fl->fl_downgrade_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001524 lease_modify(fl, F_RDLCK, dispose);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001525 if (past_time(fl->fl_break_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001526 lease_modify(fl, F_UNLCK, dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 }
1528}
1529
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001530static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1531{
Ira Weinyd51f5272019-06-05 18:45:34 -07001532 bool rc;
1533
1534 if ((breaker->fl_flags & FL_LAYOUT) != (lease->fl_flags & FL_LAYOUT)) {
1535 rc = false;
1536 goto trace;
1537 }
1538 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE)) {
1539 rc = false;
1540 goto trace;
1541 }
1542
1543 rc = locks_conflict(breaker, lease);
1544trace:
1545 trace_leases_conflict(rc, lease, breaker);
1546 return rc;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001547}
1548
Jeff Layton03d12dd2014-09-01 14:53:41 -04001549static bool
1550any_leases_conflict(struct inode *inode, struct file_lock *breaker)
1551{
Jeff Layton8634b512015-01-16 15:05:55 -05001552 struct file_lock_context *ctx = inode->i_flctx;
Jeff Layton03d12dd2014-09-01 14:53:41 -04001553 struct file_lock *fl;
1554
Jeff Layton6109c852015-01-16 15:05:57 -05001555 lockdep_assert_held(&ctx->flc_lock);
Jeff Layton03d12dd2014-09-01 14:53:41 -04001556
Jeff Layton8634b512015-01-16 15:05:55 -05001557 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Jeff Layton03d12dd2014-09-01 14:53:41 -04001558 if (leases_conflict(fl, breaker))
1559 return true;
1560 }
1561 return false;
1562}
1563
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564/**
1565 * __break_lease - revoke all outstanding leases on file
1566 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001567 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1568 * break all leases
1569 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1570 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571 *
david m. richter87250dd2007-05-09 16:10:27 -04001572 * break_lease (inlined for speed) has checked there already is at least
1573 * some kind of lock (maybe a lease) on this file. Leases are broken on
1574 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 * specified %O_NONBLOCK to your open().
1576 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001577int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001579 int error = 0;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001580 struct file_lock_context *ctx;
Yan, Zhenga9011252015-03-27 10:34:20 +08001581 struct file_lock *new_fl, *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 unsigned long break_time;
Al Viro8737c932009-12-24 06:47:55 -05001583 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001584 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585
Al Viro8737c932009-12-24 06:47:55 -05001586 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001587 if (IS_ERR(new_fl))
1588 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001589 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590
Jeff Layton8634b512015-01-16 15:05:55 -05001591 /* typically we will check that ctx is non-NULL before calling */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001592 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001593 if (!ctx) {
1594 WARN_ON_ONCE(1);
Wenwen Wangcfddf9f2019-08-19 18:47:34 -05001595 goto free_lock;
Jeff Layton8634b512015-01-16 15:05:55 -05001596 }
1597
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001598 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001599 spin_lock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600
Jeff Laytonc45198e2014-09-01 07:12:07 -04001601 time_out_leases(inode, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602
Jeff Layton03d12dd2014-09-01 14:53:41 -04001603 if (!any_leases_conflict(inode, new_fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001604 goto out;
1605
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 break_time = 0;
1607 if (lease_break_time > 0) {
1608 break_time = jiffies + lease_break_time * HZ;
1609 if (break_time == 0)
1610 break_time++; /* so that 0 means no break time */
1611 }
1612
Yan, Zhenga9011252015-03-27 10:34:20 +08001613 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001614 if (!leases_conflict(fl, new_fl))
1615 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001616 if (want_write) {
1617 if (fl->fl_flags & FL_UNLOCK_PENDING)
1618 continue;
1619 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001621 } else {
Jeff Layton8634b512015-01-16 15:05:55 -05001622 if (lease_breaking(fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001623 continue;
1624 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1625 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 }
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001627 if (fl->fl_lmops->lm_break(fl))
Jeff Laytone084c1b2015-02-16 14:32:03 -05001628 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 }
1630
Jeff Layton8634b512015-01-16 15:05:55 -05001631 if (list_empty(&ctx->flc_lease))
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001632 goto out;
1633
Jeff Layton843c6b22014-09-01 14:27:43 -04001634 if (mode & O_NONBLOCK) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001635 trace_break_lease_noblock(inode, new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 error = -EWOULDBLOCK;
1637 goto out;
1638 }
1639
1640restart:
Jeff Layton8634b512015-01-16 15:05:55 -05001641 fl = list_first_entry(&ctx->flc_lease, struct file_lock, fl_list);
1642 break_time = fl->fl_break_time;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001643 if (break_time != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 break_time -= jiffies;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001645 if (break_time == 0)
1646 break_time++;
NeilBrownfd7732e2018-11-30 10:04:08 +11001647 locks_insert_block(fl, new_fl, leases_conflict);
Jeff Layton62af4f12014-05-09 14:13:05 -04001648 trace_break_lease_block(inode, new_fl);
Jeff Layton6109c852015-01-16 15:05:57 -05001649 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001650 percpu_up_read(&file_rwsem);
Peter Zijlstraaba37662015-06-22 14:16:33 +02001651
Jeff Laytonc45198e2014-09-01 07:12:07 -04001652 locks_dispose_list(&dispose);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001653 error = wait_event_interruptible_timeout(new_fl->fl_wait,
NeilBrownada5c1d2018-11-30 10:04:08 +11001654 !new_fl->fl_blocker, break_time);
Peter Zijlstraaba37662015-06-22 14:16:33 +02001655
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001656 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001657 spin_lock(&ctx->flc_lock);
Jeff Layton62af4f12014-05-09 14:13:05 -04001658 trace_break_lease_unblock(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001659 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 if (error >= 0) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001661 /*
1662 * Wait for the next conflicting lease that has not been
1663 * broken yet
1664 */
Jeff Layton03d12dd2014-09-01 14:53:41 -04001665 if (error == 0)
1666 time_out_leases(inode, &dispose);
1667 if (any_leases_conflict(inode, new_fl))
1668 goto restart;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 error = 0;
1670 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671out:
Jeff Layton6109c852015-01-16 15:05:57 -05001672 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001673 percpu_up_read(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001674 locks_dispose_list(&dispose);
Wenwen Wangcfddf9f2019-08-19 18:47:34 -05001675free_lock:
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001676 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 return error;
1678}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679EXPORT_SYMBOL(__break_lease);
1680
1681/**
Amir Goldstein76c47942018-01-03 17:14:34 +02001682 * lease_get_mtime - update modified time of an inode with exclusive lease
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683 * @inode: the inode
Amir Goldstein76c47942018-01-03 17:14:34 +02001684 * @time: pointer to a timespec which contains the last modified time
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 *
1686 * This is to force NFS clients to flush their caches for files with
1687 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001688 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001690void lease_get_mtime(struct inode *inode, struct timespec64 *time)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691{
Jeff Laytonbfe86022014-08-22 10:18:44 -04001692 bool has_lease = false;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001693 struct file_lock_context *ctx;
Jeff Layton8634b512015-01-16 15:05:55 -05001694 struct file_lock *fl;
Jeff Laytonbfe86022014-08-22 10:18:44 -04001695
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001696 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001697 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Jeff Layton6109c852015-01-16 15:05:57 -05001698 spin_lock(&ctx->flc_lock);
Geliang Tang8ace5df2015-11-18 21:40:33 +08001699 fl = list_first_entry_or_null(&ctx->flc_lease,
1700 struct file_lock, fl_list);
1701 if (fl && (fl->fl_type == F_WRLCK))
1702 has_lease = true;
Jeff Layton6109c852015-01-16 15:05:57 -05001703 spin_unlock(&ctx->flc_lock);
Jeff Laytonbfe86022014-08-22 10:18:44 -04001704 }
1705
1706 if (has_lease)
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001707 *time = current_time(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709EXPORT_SYMBOL(lease_get_mtime);
1710
1711/**
1712 * fcntl_getlease - Enquire what lease is currently active
1713 * @filp: the file
1714 *
1715 * The value returned by this function will be one of
1716 * (if no lease break is pending):
1717 *
1718 * %F_RDLCK to indicate a shared lease is held.
1719 *
1720 * %F_WRLCK to indicate an exclusive lease is held.
1721 *
1722 * %F_UNLCK to indicate no lease is held.
1723 *
1724 * (if a lease break is pending):
1725 *
1726 * %F_RDLCK to indicate an exclusive lease needs to be
1727 * changed to a shared lease (or removed).
1728 *
1729 * %F_UNLCK to indicate the lease needs to be removed.
1730 *
1731 * XXX: sfr & willy disagree over whether F_INPROGRESS
1732 * should be returned to userspace.
1733 */
1734int fcntl_getlease(struct file *filp)
1735{
1736 struct file_lock *fl;
Miklos Szeredic568d682016-09-16 12:44:20 +02001737 struct inode *inode = locks_inode(filp);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001738 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739 int type = F_UNLCK;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001740 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001742 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001743 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001744 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001745 spin_lock(&ctx->flc_lock);
Miklos Szeredic568d682016-09-16 12:44:20 +02001746 time_out_leases(inode, &dispose);
Jeff Layton8634b512015-01-16 15:05:55 -05001747 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1748 if (fl->fl_file != filp)
1749 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001750 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 break;
1752 }
Jeff Layton6109c852015-01-16 15:05:57 -05001753 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001754 percpu_up_read(&file_rwsem);
Peter Zijlstra5f430862016-10-08 10:12:28 +02001755
Jeff Layton8634b512015-01-16 15:05:55 -05001756 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 return type;
1759}
1760
Jeff Layton24cbe782014-02-03 12:13:06 -05001761/**
Amir Goldstein387e3742019-06-07 17:24:38 +03001762 * check_conflicting_open - see if the given file points to an inode that has
NeilBrown7bbd1fc2018-11-30 10:04:08 +11001763 * an existing open that would conflict with the
1764 * desired lease.
Amir Goldstein387e3742019-06-07 17:24:38 +03001765 * @filp: file to check
Jeff Layton24cbe782014-02-03 12:13:06 -05001766 * @arg: type of lease that we're trying to acquire
Randy Dunlap7fadc592015-08-09 18:43:17 -07001767 * @flags: current lock flags
Jeff Layton24cbe782014-02-03 12:13:06 -05001768 *
1769 * Check to see if there's an existing open fd on this file that would
1770 * conflict with the lease we're trying to set.
1771 */
1772static int
Amir Goldstein387e3742019-06-07 17:24:38 +03001773check_conflicting_open(struct file *filp, const long arg, int flags)
Jeff Layton24cbe782014-02-03 12:13:06 -05001774{
Amir Goldstein387e3742019-06-07 17:24:38 +03001775 struct inode *inode = locks_inode(filp);
1776 int self_wcount = 0, self_rcount = 0;
Jeff Layton24cbe782014-02-03 12:13:06 -05001777
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001778 if (flags & FL_LAYOUT)
1779 return 0;
1780
Amir Goldstein387e3742019-06-07 17:24:38 +03001781 if (arg == F_RDLCK)
1782 return inode_is_open_for_write(inode) ? -EAGAIN : 0;
1783 else if (arg != F_WRLCK)
1784 return 0;
1785
1786 /*
1787 * Make sure that only read/write count is from lease requestor.
1788 * Note that this will result in denying write leases when i_writecount
1789 * is negative, which is what we want. (We shouldn't grant write leases
1790 * on files open for execution.)
1791 */
1792 if (filp->f_mode & FMODE_WRITE)
1793 self_wcount = 1;
1794 else if (filp->f_mode & FMODE_READ)
1795 self_rcount = 1;
1796
1797 if (atomic_read(&inode->i_writecount) != self_wcount ||
1798 atomic_read(&inode->i_readcount) != self_rcount)
Jeff Layton24cbe782014-02-03 12:13:06 -05001799 return -EAGAIN;
1800
Amir Goldstein387e3742019-06-07 17:24:38 +03001801 return 0;
Jeff Layton24cbe782014-02-03 12:13:06 -05001802}
1803
Jeff Laytone6f5c782014-08-22 10:40:25 -04001804static int
1805generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806{
Jeff Layton8634b512015-01-16 15:05:55 -05001807 struct file_lock *fl, *my_fl = NULL, *lease;
Amir Goldstein387e3742019-06-07 17:24:38 +03001808 struct inode *inode = locks_inode(filp);
Jeff Layton8634b512015-01-16 15:05:55 -05001809 struct file_lock_context *ctx;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001810 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001811 int error;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001812 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813
J. Bruce Fields096657b2010-10-30 17:31:14 -04001814 lease = *flp;
Jeff Layton62af4f12014-05-09 14:13:05 -04001815 trace_generic_add_lease(inode, lease);
1816
Jeff Layton5c1c6692015-04-03 09:04:03 -04001817 /* Note that arg is never F_UNLCK here */
1818 ctx = locks_get_lock_context(inode, arg);
Jeff Layton8634b512015-01-16 15:05:55 -05001819 if (!ctx)
1820 return -ENOMEM;
1821
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001822 /*
1823 * In the delegation case we need mutual exclusion with
1824 * a number of operations that take the i_mutex. We trylock
1825 * because delegations are an optional optimization, and if
1826 * there's some chance of a conflict--we'd rather not
1827 * bother, maybe that's a sign this just isn't a good file to
1828 * hand out a delegation on.
1829 */
Al Viro59551022016-01-22 15:40:57 -05001830 if (is_deleg && !inode_trylock(inode))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001831 return -EAGAIN;
1832
1833 if (is_deleg && arg == F_WRLCK) {
1834 /* Write delegations are not currently supported: */
Al Viro59551022016-01-22 15:40:57 -05001835 inode_unlock(inode);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001836 WARN_ON_ONCE(1);
1837 return -EINVAL;
1838 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001839
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001840 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001841 spin_lock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001842 time_out_leases(inode, &dispose);
Amir Goldstein387e3742019-06-07 17:24:38 +03001843 error = check_conflicting_open(filp, arg, lease->fl_flags);
Jeff Layton24cbe782014-02-03 12:13:06 -05001844 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001845 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001846
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847 /*
1848 * At this point, we know that if there is an exclusive
1849 * lease on this file, then we hold it on this filp
1850 * (otherwise our open of this file would have blocked).
1851 * And if we are trying to acquire an exclusive lease,
1852 * then the file is not open by anyone (including us)
1853 * except for this filp.
1854 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001855 error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001856 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001857 if (fl->fl_file == filp &&
1858 fl->fl_owner == lease->fl_owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001859 my_fl = fl;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001860 continue;
1861 }
Jeff Layton8634b512015-01-16 15:05:55 -05001862
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001863 /*
1864 * No exclusive leases if someone else has a lease on
1865 * this file:
1866 */
1867 if (arg == F_WRLCK)
1868 goto out;
1869 /*
1870 * Modifying our existing lease is OK, but no getting a
1871 * new lease if someone else is opening for write:
1872 */
1873 if (fl->fl_flags & FL_UNLOCK_PENDING)
1874 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 }
1876
Jeff Layton8634b512015-01-16 15:05:55 -05001877 if (my_fl != NULL) {
Jeff Layton0164bf02015-03-04 17:34:32 -05001878 lease = my_fl;
1879 error = lease->fl_lmops->lm_change(lease, arg, &dispose);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001880 if (error)
1881 goto out;
1882 goto out_setup;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 }
1884
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 error = -EINVAL;
1886 if (!leases_enable)
1887 goto out;
1888
Jeff Laytone084c1b2015-02-16 14:32:03 -05001889 locks_insert_lock_ctx(lease, &ctx->flc_lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001890 /*
1891 * The check in break_lease() is lockless. It's possible for another
1892 * open to race in after we did the earlier check for a conflicting
1893 * open but before the lease was inserted. Check again for a
1894 * conflicting open and cancel the lease if there is one.
1895 *
1896 * We also add a barrier here to ensure that the insertion of the lock
1897 * precedes these checks.
1898 */
1899 smp_mb();
Amir Goldstein387e3742019-06-07 17:24:38 +03001900 error = check_conflicting_open(filp, arg, lease->fl_flags);
Jeff Layton8634b512015-01-16 15:05:55 -05001901 if (error) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001902 locks_unlink_lock_ctx(lease);
Jeff Layton8634b512015-01-16 15:05:55 -05001903 goto out;
1904 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001905
1906out_setup:
1907 if (lease->fl_lmops->lm_setup)
1908 lease->fl_lmops->lm_setup(lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909out:
Jeff Layton6109c852015-01-16 15:05:57 -05001910 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001911 percpu_up_read(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001912 locks_dispose_list(&dispose);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001913 if (is_deleg)
Al Viro59551022016-01-22 15:40:57 -05001914 inode_unlock(inode);
Jeff Layton8634b512015-01-16 15:05:55 -05001915 if (!error && !my_fl)
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001916 *flp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917 return error;
1918}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001919
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001920static int generic_delete_lease(struct file *filp, void *owner)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001921{
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001922 int error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001923 struct file_lock *fl, *victim = NULL;
Miklos Szeredic568d682016-09-16 12:44:20 +02001924 struct inode *inode = locks_inode(filp);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001925 struct file_lock_context *ctx;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001926 LIST_HEAD(dispose);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001927
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001928 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001929 if (!ctx) {
1930 trace_generic_delete_lease(inode, NULL);
1931 return error;
1932 }
1933
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001934 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001935 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001936 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001937 if (fl->fl_file == filp &&
1938 fl->fl_owner == owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001939 victim = fl;
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001940 break;
Jeff Layton8634b512015-01-16 15:05:55 -05001941 }
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001942 }
Jeff Laytona9b1b452015-03-14 09:45:35 -04001943 trace_generic_delete_lease(inode, victim);
Jeff Layton8634b512015-01-16 15:05:55 -05001944 if (victim)
Jeff Layton7448cc32015-01-16 15:05:57 -05001945 error = fl->fl_lmops->lm_change(victim, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05001946 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001947 percpu_up_read(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001948 locks_dispose_list(&dispose);
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001949 return error;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001950}
1951
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952/**
1953 * generic_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001954 * @filp: file pointer
1955 * @arg: type of lease to obtain
1956 * @flp: input - file_lock to use, output - file_lock inserted
1957 * @priv: private data for lm_setup (may be NULL if lm_setup
1958 * doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959 *
1960 * The (input) flp->fl_lmops->lm_break function is required
1961 * by break_lease().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001963int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
1964 void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965{
Miklos Szeredic568d682016-09-16 12:44:20 +02001966 struct inode *inode = locks_inode(filp);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001967 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001969 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001970 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001972 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 error = security_file_lock(filp, arg);
1974 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001975 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001977 switch (arg) {
1978 case F_UNLCK:
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001979 return generic_delete_lease(filp, *priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001980 case F_RDLCK:
1981 case F_WRLCK:
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001982 if (!(*flp)->fl_lmops->lm_break) {
1983 WARN_ON_ONCE(1);
1984 return -ENOLCK;
1985 }
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001986
Jeff Laytone6f5c782014-08-22 10:40:25 -04001987 return generic_add_lease(filp, arg, flp, priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001988 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001989 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001992EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001994/**
Jeff Laytone51673a2014-08-22 18:13:28 -04001995 * vfs_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001996 * @filp: file pointer
1997 * @arg: type of lease to obtain
1998 * @lease: file_lock to use when adding a lease
1999 * @priv: private info for lm_setup when adding a lease (may be
NeilBrown7bbd1fc2018-11-30 10:04:08 +11002000 * NULL if lm_setup doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001 *
Jeff Laytone51673a2014-08-22 18:13:28 -04002002 * Call this to establish a lease on the file. The "lease" argument is not
2003 * used for F_UNLCK requests and may be NULL. For commands that set or alter
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04002004 * an existing lease, the ``(*lease)->fl_lmops->lm_break`` operation must be
2005 * set; if not, this function will return -ENOLCK (and generate a scary-looking
Jeff Laytone51673a2014-08-22 18:13:28 -04002006 * stack trace).
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002007 *
2008 * The "priv" pointer is passed directly to the lm_setup function as-is. It
2009 * may be NULL if the lm_setup operation doesn't require it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04002011int
2012vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002014 if (filp->f_op->setlease)
Jeff Laytonf82b4b62014-08-22 18:50:48 -04002015 return filp->f_op->setlease(filp, arg, lease, priv);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002016 else
Jeff Laytonf82b4b62014-08-22 18:50:48 -04002017 return generic_setlease(filp, arg, lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04002019EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002021static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022{
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002023 struct file_lock *fl;
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002024 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 int error;
2026
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02002027 fl = lease_alloc(filp, arg);
2028 if (IS_ERR(fl))
2029 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002031 new = fasync_alloc();
2032 if (!new) {
2033 locks_free_lock(fl);
2034 return -ENOMEM;
2035 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002036 new->fa_fd = fd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002038 error = vfs_setlease(filp, arg, &fl, (void **)&new);
Jeff Layton2dfb9282014-08-11 18:14:12 -04002039 if (fl)
2040 locks_free_lock(fl);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002041 if (new)
2042 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043 return error;
2044}
2045
2046/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002047 * fcntl_setlease - sets a lease on an open file
2048 * @fd: open file descriptor
2049 * @filp: file pointer
2050 * @arg: type of lease to obtain
2051 *
2052 * Call this fcntl to establish a lease on the file.
2053 * Note that you also need to call %F_SETSIG to
2054 * receive a signal when the lease is broken.
2055 */
2056int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
2057{
2058 if (arg == F_UNLCK)
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01002059 return vfs_setlease(filp, F_UNLCK, NULL, (void **)&filp);
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002060 return do_fcntl_add_lease(fd, filp, arg);
2061}
2062
2063/**
Jeff Layton29d01b22015-07-11 06:43:02 -04002064 * flock_lock_inode_wait - Apply a FLOCK-style lock to a file
2065 * @inode: inode of the file to apply to
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 * @fl: The lock to be applied
2067 *
Jeff Layton29d01b22015-07-11 06:43:02 -04002068 * Apply a FLOCK style lock request to an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069 */
Benjamin Coddington616fb382015-10-22 13:38:15 -04002070static int flock_lock_inode_wait(struct inode *inode, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071{
2072 int error;
2073 might_sleep();
2074 for (;;) {
Jeff Layton29d01b22015-07-11 06:43:02 -04002075 error = flock_lock_inode(inode, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07002076 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11002078 error = wait_event_interruptible(fl->fl_wait, !fl->fl_blocker);
NeilBrown16306a62018-11-30 10:04:08 +11002079 if (error)
2080 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 }
NeilBrown16306a62018-11-30 10:04:08 +11002082 locks_delete_block(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 return error;
2084}
2085
Jeff Layton29d01b22015-07-11 06:43:02 -04002086/**
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04002087 * locks_lock_inode_wait - Apply a lock to an inode
2088 * @inode: inode of the file to apply to
2089 * @fl: The lock to be applied
2090 *
2091 * Apply a POSIX or FLOCK style lock request to an inode.
2092 */
2093int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
2094{
2095 int res = 0;
2096 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
2097 case FL_POSIX:
2098 res = posix_lock_inode_wait(inode, fl);
2099 break;
2100 case FL_FLOCK:
2101 res = flock_lock_inode_wait(inode, fl);
2102 break;
2103 default:
2104 BUG();
2105 }
2106 return res;
2107}
2108EXPORT_SYMBOL(locks_lock_inode_wait);
2109
2110/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 * sys_flock: - flock() system call.
2112 * @fd: the file descriptor to lock.
2113 * @cmd: the type of lock to apply.
2114 *
2115 * Apply a %FL_FLOCK style lock to an open file descriptor.
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04002116 * The @cmd can be one of:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 *
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04002118 * - %LOCK_SH -- a shared lock.
2119 * - %LOCK_EX -- an exclusive lock.
2120 * - %LOCK_UN -- remove an existing lock.
2121 * - %LOCK_MAND -- a 'mandatory' flock.
2122 * This exists to emulate Windows Share Modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 *
2124 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
2125 * processes read and write access respectively.
2126 */
Heiko Carstens002c8972009-01-14 14:14:18 +01002127SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128{
Al Viro2903ff02012-08-28 12:52:22 -04002129 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 struct file_lock *lock;
2131 int can_sleep, unlock;
2132 int error;
2133
2134 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04002135 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 goto out;
2137
2138 can_sleep = !(cmd & LOCK_NB);
2139 cmd &= ~LOCK_NB;
2140 unlock = (cmd == LOCK_UN);
2141
Al Viroaeb5d722008-09-02 15:28:45 -04002142 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04002143 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 goto out_putf;
2145
NeilBrownd6367d62018-11-30 10:04:08 +11002146 lock = flock_make_lock(f.file, cmd, NULL);
Jeff Layton6e129d002014-09-04 10:25:06 -04002147 if (IS_ERR(lock)) {
2148 error = PTR_ERR(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 goto out_putf;
Jeff Layton6e129d002014-09-04 10:25:06 -04002150 }
2151
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 if (can_sleep)
2153 lock->fl_flags |= FL_SLEEP;
2154
Al Viro2903ff02012-08-28 12:52:22 -04002155 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 if (error)
2157 goto out_free;
2158
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002159 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04002160 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 (can_sleep) ? F_SETLKW : F_SETLK,
2162 lock);
2163 else
Benjamin Coddington4f656362015-10-22 13:38:14 -04002164 error = locks_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165
2166 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08002167 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168
2169 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04002170 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 out:
2172 return error;
2173}
2174
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002175/**
2176 * vfs_test_lock - test file byte range lock
2177 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04002178 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002179 *
2180 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
2181 * setting conf->fl_type to something other than F_UNLCK.
2182 */
2183int vfs_test_lock(struct file *filp, struct file_lock *fl)
2184{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002185 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002186 return filp->f_op->lock(filp, F_GETLK, fl);
2187 posix_test_lock(filp, fl);
2188 return 0;
2189}
2190EXPORT_SYMBOL_GPL(vfs_test_lock);
2191
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002192/**
2193 * locks_translate_pid - translate a file_lock's fl_pid number into a namespace
2194 * @fl: The file_lock who's fl_pid should be translated
2195 * @ns: The namespace into which the pid should be translated
2196 *
2197 * Used to tranlate a fl_pid into a namespace virtual pid number
2198 */
2199static pid_t locks_translate_pid(struct file_lock *fl, struct pid_namespace *ns)
2200{
2201 pid_t vnr;
2202 struct pid *pid;
2203
2204 if (IS_OFDLCK(fl))
2205 return -1;
2206 if (IS_REMOTELCK(fl))
2207 return fl->fl_pid;
Konstantin Khorenko826d7bc2018-06-08 17:27:11 +03002208 /*
2209 * If the flock owner process is dead and its pid has been already
2210 * freed, the translation below won't work, but we still want to show
2211 * flock owner pid number in init pidns.
2212 */
2213 if (ns == &init_pid_ns)
2214 return (pid_t)fl->fl_pid;
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002215
2216 rcu_read_lock();
2217 pid = find_pid_ns(fl->fl_pid, &init_pid_ns);
2218 vnr = pid_nr_ns(pid, ns);
2219 rcu_read_unlock();
2220 return vnr;
2221}
2222
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002223static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
2224{
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002225 flock->l_pid = locks_translate_pid(fl, task_active_pid_ns(current));
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002226#if BITS_PER_LONG == 32
2227 /*
2228 * Make sure we can represent the posix lock via
2229 * legacy 32bit flock.
2230 */
2231 if (fl->fl_start > OFFT_OFFSET_MAX)
2232 return -EOVERFLOW;
2233 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
2234 return -EOVERFLOW;
2235#endif
2236 flock->l_start = fl->fl_start;
2237 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2238 fl->fl_end - fl->fl_start + 1;
2239 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04002240 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002241 return 0;
2242}
2243
2244#if BITS_PER_LONG == 32
2245static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
2246{
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002247 flock->l_pid = locks_translate_pid(fl, task_active_pid_ns(current));
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002248 flock->l_start = fl->fl_start;
2249 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2250 fl->fl_end - fl->fl_start + 1;
2251 flock->l_whence = 0;
2252 flock->l_type = fl->fl_type;
2253}
2254#endif
2255
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256/* Report the first existing lock that would conflict with l.
2257 * This implements the F_GETLK command of fcntl().
2258 */
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002259int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260{
Benjamin Coddington52306e82017-07-16 10:28:21 -04002261 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 int error;
2263
Benjamin Coddington52306e82017-07-16 10:28:21 -04002264 fl = locks_alloc_lock();
2265 if (fl == NULL)
2266 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002268 if (flock->l_type != F_RDLCK && flock->l_type != F_WRLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269 goto out;
2270
Benjamin Coddington52306e82017-07-16 10:28:21 -04002271 error = flock_to_posix_lock(filp, fl, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272 if (error)
2273 goto out;
2274
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002275 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002276 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002277 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002278 goto out;
2279
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002280 cmd = F_GETLK;
Benjamin Coddington52306e82017-07-16 10:28:21 -04002281 fl->fl_flags |= FL_OFDLCK;
2282 fl->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002283 }
2284
Benjamin Coddington52306e82017-07-16 10:28:21 -04002285 error = vfs_test_lock(filp, fl);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002286 if (error)
2287 goto out;
NeilBrown7bbd1fc2018-11-30 10:04:08 +11002288
Benjamin Coddington52306e82017-07-16 10:28:21 -04002289 flock->l_type = fl->fl_type;
2290 if (fl->fl_type != F_UNLCK) {
2291 error = posix_lock_to_flock(flock, fl);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002292 if (error)
Benjamin Coddington52306e82017-07-16 10:28:21 -04002293 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295out:
Benjamin Coddington52306e82017-07-16 10:28:21 -04002296 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297 return error;
2298}
2299
Marc Eshel7723ec92007-01-18 15:08:55 -05002300/**
2301 * vfs_lock_file - file byte range lock
2302 * @filp: The file to apply the lock to
2303 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2304 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05002305 * @conf: Place to return a copy of the conflicting lock, if found.
2306 *
2307 * A caller that doesn't care about the conflicting lock may pass NULL
2308 * as the final argument.
2309 *
2310 * If the filesystem defines a private ->lock() method, then @conf will
2311 * be left unchanged; so a caller that cares should initialize it to
2312 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05002313 *
2314 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2315 * locks, the ->lock() interface may return asynchronously, before the lock has
2316 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002317 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05002318 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2319 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002320 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05002321 * request completes.
2322 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07002323 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2324 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05002325 * nonzero return code and the file system should release the lock. The file
2326 * system is also responsible to keep a corresponding posix lock when it
2327 * grants a lock so the VFS can find out which locks are locally held and do
2328 * the correct lock cleanup when required.
2329 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002330 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05002331 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05002332 */
Marc Eshel150b3932007-01-18 16:15:35 -05002333int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05002334{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002335 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05002336 return filp->f_op->lock(filp, cmd, fl);
2337 else
Marc Eshel150b3932007-01-18 16:15:35 -05002338 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05002339}
2340EXPORT_SYMBOL_GPL(vfs_lock_file);
2341
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002342static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2343 struct file_lock *fl)
2344{
2345 int error;
2346
2347 error = security_file_lock(filp, fl->fl_type);
2348 if (error)
2349 return error;
2350
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002351 for (;;) {
2352 error = vfs_lock_file(filp, cmd, fl, NULL);
2353 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002354 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11002355 error = wait_event_interruptible(fl->fl_wait, !fl->fl_blocker);
NeilBrown16306a62018-11-30 10:04:08 +11002356 if (error)
2357 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002358 }
NeilBrown16306a62018-11-30 10:04:08 +11002359 locks_delete_block(fl);
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002360
2361 return error;
2362}
2363
Benjamin Coddington6ca7d912015-10-15 09:07:07 -04002364/* Ensure that fl->fl_file has compatible f_mode for F_SETLK calls */
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002365static int
2366check_fmode_for_setlk(struct file_lock *fl)
2367{
2368 switch (fl->fl_type) {
2369 case F_RDLCK:
2370 if (!(fl->fl_file->f_mode & FMODE_READ))
2371 return -EBADF;
2372 break;
2373 case F_WRLCK:
2374 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2375 return -EBADF;
2376 }
2377 return 0;
2378}
2379
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380/* Apply the lock described by l to an open file descriptor.
2381 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2382 */
Peter Staubachc2936212005-07-27 11:45:09 -07002383int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002384 struct flock *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385{
2386 struct file_lock *file_lock = locks_alloc_lock();
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002387 struct inode *inode = locks_inode(filp);
Al Viro0b2bac22008-05-06 13:58:34 -04002388 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389 int error;
2390
2391 if (file_lock == NULL)
2392 return -ENOLCK;
2393
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394 /* Don't allow mandatory locks on files that may be memory mapped
2395 * and shared.
2396 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002397 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398 error = -EAGAIN;
2399 goto out;
2400 }
2401
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002402 error = flock_to_posix_lock(filp, file_lock, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403 if (error)
2404 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002405
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002406 error = check_fmode_for_setlk(file_lock);
2407 if (error)
2408 goto out;
2409
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002410 /*
2411 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002412 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002413 */
2414 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002415 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002416 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002417 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002418 goto out;
2419
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002420 cmd = F_SETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002421 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002422 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002423 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002424 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002425 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002426 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002427 goto out;
2428
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002429 cmd = F_SETLKW;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002430 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002431 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002432 /* Fallthrough */
2433 case F_SETLKW:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434 file_lock->fl_flags |= FL_SLEEP;
2435 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002436
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002437 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438
Peter Staubachc2936212005-07-27 11:45:09 -07002439 /*
Jeff Layton0752ba82016-01-08 07:30:43 -05002440 * Attempt to detect a close/fcntl race and recover by releasing the
2441 * lock that was just acquired. There is no need to do that when we're
2442 * unlocking though, or for OFD locks.
Peter Staubachc2936212005-07-27 11:45:09 -07002443 */
Jeff Layton0752ba82016-01-08 07:30:43 -05002444 if (!error && file_lock->fl_type != F_UNLCK &&
2445 !(file_lock->fl_flags & FL_OFDLCK)) {
Jeff Layton7f3697e2016-01-07 16:38:10 -05002446 /*
2447 * We need that spin_lock here - it prevents reordering between
2448 * update of i_flctx->flc_posix and check for it done in
2449 * close(). rcu_read_lock() wouldn't do.
2450 */
2451 spin_lock(&current->files->file_lock);
2452 f = fcheck(fd);
2453 spin_unlock(&current->files->file_lock);
2454 if (f != filp) {
2455 file_lock->fl_type = F_UNLCK;
2456 error = do_lock_file_wait(filp, cmd, file_lock);
2457 WARN_ON_ONCE(error);
2458 error = -EBADF;
2459 }
Peter Staubachc2936212005-07-27 11:45:09 -07002460 }
Peter Staubachc2936212005-07-27 11:45:09 -07002461out:
Jeff Layton18909102016-01-06 21:26:10 -05002462 trace_fcntl_setlk(inode, file_lock, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 locks_free_lock(file_lock);
2464 return error;
2465}
2466
2467#if BITS_PER_LONG == 32
2468/* Report the first existing lock that would conflict with l.
2469 * This implements the F_GETLK command of fcntl().
2470 */
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002471int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472{
Benjamin Coddington52306e82017-07-16 10:28:21 -04002473 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474 int error;
2475
Benjamin Coddington52306e82017-07-16 10:28:21 -04002476 fl = locks_alloc_lock();
2477 if (fl == NULL)
2478 return -ENOMEM;
2479
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002481 if (flock->l_type != F_RDLCK && flock->l_type != F_WRLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482 goto out;
2483
Benjamin Coddington52306e82017-07-16 10:28:21 -04002484 error = flock64_to_posix_lock(filp, fl, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485 if (error)
2486 goto out;
2487
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002488 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002489 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002490 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002491 goto out;
2492
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002493 cmd = F_GETLK64;
Benjamin Coddington52306e82017-07-16 10:28:21 -04002494 fl->fl_flags |= FL_OFDLCK;
2495 fl->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002496 }
2497
Benjamin Coddington52306e82017-07-16 10:28:21 -04002498 error = vfs_test_lock(filp, fl);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002499 if (error)
2500 goto out;
2501
Benjamin Coddington52306e82017-07-16 10:28:21 -04002502 flock->l_type = fl->fl_type;
2503 if (fl->fl_type != F_UNLCK)
2504 posix_lock_to_flock64(flock, fl);
Kinglong Meef3282962014-08-22 10:18:43 -04002505
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506out:
Benjamin Coddington52306e82017-07-16 10:28:21 -04002507 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002508 return error;
2509}
2510
2511/* Apply the lock described by l to an open file descriptor.
2512 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2513 */
Peter Staubachc2936212005-07-27 11:45:09 -07002514int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002515 struct flock64 *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002516{
2517 struct file_lock *file_lock = locks_alloc_lock();
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002518 struct inode *inode = locks_inode(filp);
Al Viro0b2bac22008-05-06 13:58:34 -04002519 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520 int error;
2521
2522 if (file_lock == NULL)
2523 return -ENOLCK;
2524
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525 /* Don't allow mandatory locks on files that may be memory mapped
2526 * and shared.
2527 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002528 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002529 error = -EAGAIN;
2530 goto out;
2531 }
2532
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002533 error = flock64_to_posix_lock(filp, file_lock, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534 if (error)
2535 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002536
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002537 error = check_fmode_for_setlk(file_lock);
2538 if (error)
2539 goto out;
2540
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002541 /*
2542 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002543 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002544 */
2545 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002546 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002547 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002548 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002549 goto out;
2550
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002551 cmd = F_SETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002552 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002553 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002554 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002555 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002556 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002557 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002558 goto out;
2559
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002560 cmd = F_SETLKW64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002561 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002562 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002563 /* Fallthrough */
2564 case F_SETLKW64:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002565 file_lock->fl_flags |= FL_SLEEP;
2566 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002567
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002568 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569
Peter Staubachc2936212005-07-27 11:45:09 -07002570 /*
Jeff Layton0752ba82016-01-08 07:30:43 -05002571 * Attempt to detect a close/fcntl race and recover by releasing the
2572 * lock that was just acquired. There is no need to do that when we're
2573 * unlocking though, or for OFD locks.
Peter Staubachc2936212005-07-27 11:45:09 -07002574 */
Jeff Layton0752ba82016-01-08 07:30:43 -05002575 if (!error && file_lock->fl_type != F_UNLCK &&
2576 !(file_lock->fl_flags & FL_OFDLCK)) {
Jeff Layton7f3697e2016-01-07 16:38:10 -05002577 /*
2578 * We need that spin_lock here - it prevents reordering between
2579 * update of i_flctx->flc_posix and check for it done in
2580 * close(). rcu_read_lock() wouldn't do.
2581 */
2582 spin_lock(&current->files->file_lock);
2583 f = fcheck(fd);
2584 spin_unlock(&current->files->file_lock);
2585 if (f != filp) {
2586 file_lock->fl_type = F_UNLCK;
2587 error = do_lock_file_wait(filp, cmd, file_lock);
2588 WARN_ON_ONCE(error);
2589 error = -EBADF;
2590 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002592out:
2593 locks_free_lock(file_lock);
2594 return error;
2595}
2596#endif /* BITS_PER_LONG == 32 */
2597
2598/*
2599 * This function is called when the file is being removed
2600 * from the task's fd array. POSIX locks belonging to this task
2601 * are deleted at this time.
2602 */
2603void locks_remove_posix(struct file *filp, fl_owner_t owner)
2604{
Jeff Layton18909102016-01-06 21:26:10 -05002605 int error;
Miklos Szeredic568d682016-09-16 12:44:20 +02002606 struct inode *inode = locks_inode(filp);
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002607 struct file_lock lock;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002608 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609
2610 /*
2611 * If there are no locks held on this file, we don't need to call
2612 * posix_lock_file(). Another process could be setting a lock on this
2613 * file at the same time, but we wouldn't remove that lock anyway.
2614 */
Miklos Szeredic568d682016-09-16 12:44:20 +02002615 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05002616 if (!ctx || list_empty(&ctx->flc_posix))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617 return;
2618
NeilBrownd6367d62018-11-30 10:04:08 +11002619 locks_init_lock(&lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002621 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622 lock.fl_start = 0;
2623 lock.fl_end = OFFSET_MAX;
2624 lock.fl_owner = owner;
2625 lock.fl_pid = current->tgid;
2626 lock.fl_file = filp;
2627 lock.fl_ops = NULL;
2628 lock.fl_lmops = NULL;
2629
Jeff Layton18909102016-01-06 21:26:10 -05002630 error = vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002631
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2633 lock.fl_ops->fl_release_private(&lock);
Miklos Szeredic568d682016-09-16 12:44:20 +02002634 trace_locks_remove_posix(inode, &lock, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636EXPORT_SYMBOL(locks_remove_posix);
2637
Jeff Layton3d8e5602015-01-16 15:05:58 -05002638/* The i_flctx must be valid when calling into here */
Jeff Laytondd459bb2015-01-16 15:05:54 -05002639static void
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002640locks_remove_flock(struct file *filp, struct file_lock_context *flctx)
Jeff Laytondd459bb2015-01-16 15:05:54 -05002641{
NeilBrownd6367d62018-11-30 10:04:08 +11002642 struct file_lock fl;
Miklos Szeredic568d682016-09-16 12:44:20 +02002643 struct inode *inode = locks_inode(filp);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002644
Jeff Layton3d8e5602015-01-16 15:05:58 -05002645 if (list_empty(&flctx->flc_flock))
Jeff Laytondd459bb2015-01-16 15:05:54 -05002646 return;
2647
NeilBrownd6367d62018-11-30 10:04:08 +11002648 flock_make_lock(filp, LOCK_UN, &fl);
2649 fl.fl_flags |= FL_CLOSE;
2650
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002651 if (filp->f_op->flock)
Jeff Laytondd459bb2015-01-16 15:05:54 -05002652 filp->f_op->flock(filp, F_SETLKW, &fl);
2653 else
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04002654 flock_lock_inode(inode, &fl);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002655
2656 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2657 fl.fl_ops->fl_release_private(&fl);
2658}
2659
Jeff Layton3d8e5602015-01-16 15:05:58 -05002660/* The i_flctx must be valid when calling into here */
Jeff Layton8634b512015-01-16 15:05:55 -05002661static void
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002662locks_remove_lease(struct file *filp, struct file_lock_context *ctx)
Jeff Layton8634b512015-01-16 15:05:55 -05002663{
Jeff Layton8634b512015-01-16 15:05:55 -05002664 struct file_lock *fl, *tmp;
2665 LIST_HEAD(dispose);
2666
Jeff Layton3d8e5602015-01-16 15:05:58 -05002667 if (list_empty(&ctx->flc_lease))
Jeff Layton8634b512015-01-16 15:05:55 -05002668 return;
2669
Peter Zijlstra02e525b22019-02-21 15:38:40 +01002670 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05002671 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05002672 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list)
Jeff Laytonc4e136c2015-02-16 19:37:42 -05002673 if (filp == fl->fl_file)
2674 lease_modify(fl, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05002675 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01002676 percpu_up_read(&file_rwsem);
Peter Zijlstra5f430862016-10-08 10:12:28 +02002677
Jeff Layton8634b512015-01-16 15:05:55 -05002678 locks_dispose_list(&dispose);
2679}
2680
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681/*
2682 * This function is called on the last close of an open file.
2683 */
Jeff Layton78ed8a12014-02-03 12:13:08 -05002684void locks_remove_file(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002685{
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002686 struct file_lock_context *ctx;
2687
Miklos Szeredic568d682016-09-16 12:44:20 +02002688 ctx = smp_load_acquire(&locks_inode(filp)->i_flctx);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002689 if (!ctx)
Jeff Layton3d8e5602015-01-16 15:05:58 -05002690 return;
2691
Jeff Laytondd459bb2015-01-16 15:05:54 -05002692 /* remove any OFD locks */
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002693 locks_remove_posix(filp, filp);
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002694
Jeff Laytondd459bb2015-01-16 15:05:54 -05002695 /* remove flock locks */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002696 locks_remove_flock(filp, ctx);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002697
Jeff Layton8634b512015-01-16 15:05:55 -05002698 /* remove any leases */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002699 locks_remove_lease(filp, ctx);
Benjamin Coddington39537042017-07-21 13:36:25 -04002700
2701 spin_lock(&ctx->flc_lock);
2702 locks_check_ctx_file_list(filp, &ctx->flc_posix, "POSIX");
2703 locks_check_ctx_file_list(filp, &ctx->flc_flock, "FLOCK");
2704 locks_check_ctx_file_list(filp, &ctx->flc_lease, "LEASE");
2705 spin_unlock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002706}
2707
2708/**
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002709 * vfs_cancel_lock - file byte range unblock lock
2710 * @filp: The file to apply the unblock to
2711 * @fl: The lock to be unblocked
2712 *
2713 * Used by lock managers to cancel blocked requests
2714 */
2715int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2716{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002717 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002718 return filp->f_op->lock(filp, F_CANCELLK, fl);
2719 return 0;
2720}
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002721EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2722
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002723#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002724#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002725#include <linux/seq_file.h>
2726
Jeff Layton7012b022013-06-21 08:58:22 -04002727struct locks_iterator {
2728 int li_cpu;
2729 loff_t li_pos;
2730};
2731
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002732static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002733 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002734{
2735 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002736 unsigned int fl_pid;
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002737 struct pid_namespace *proc_pidns = file_inode(f->file)->i_sb->s_fs_info;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002738
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002739 fl_pid = locks_translate_pid(fl, proc_pidns);
2740 /*
Konstantin Khorenko1cf8e5d2018-06-08 17:27:12 +03002741 * If lock owner is dead (and pid is freed) or not visible in current
2742 * pidns, zero is shown as a pid value. Check lock info from
2743 * init_pid_ns to get saved lock pid value.
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002744 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002745
2746 if (fl->fl_file != NULL)
Miklos Szeredic568d682016-09-16 12:44:20 +02002747 inode = locks_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002748
Jerome Marchand99dc8292010-10-26 14:22:33 -07002749 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002750 if (IS_POSIX(fl)) {
Jeff Laytonc918d422014-02-03 12:13:09 -05002751 if (fl->fl_flags & FL_ACCESS)
Fabian Frederick5315c262014-05-09 14:13:05 -04002752 seq_puts(f, "ACCESS");
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002753 else if (IS_OFDLCK(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002754 seq_puts(f, "OFDLCK");
Jeff Laytonc918d422014-02-03 12:13:09 -05002755 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002756 seq_puts(f, "POSIX ");
Jeff Laytonc918d422014-02-03 12:13:09 -05002757
2758 seq_printf(f, " %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002759 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002760 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761 } else if (IS_FLOCK(fl)) {
2762 if (fl->fl_type & LOCK_MAND) {
Fabian Frederick5315c262014-05-09 14:13:05 -04002763 seq_puts(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002765 seq_puts(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766 }
2767 } else if (IS_LEASE(fl)) {
Jeff Layton8144f1f2014-08-11 13:36:54 -04002768 if (fl->fl_flags & FL_DELEG)
2769 seq_puts(f, "DELEG ");
2770 else
2771 seq_puts(f, "LEASE ");
2772
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002773 if (lease_breaking(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002774 seq_puts(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002775 else if (fl->fl_file)
Fabian Frederick5315c262014-05-09 14:13:05 -04002776 seq_puts(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002777 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002778 seq_puts(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002779 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002780 seq_puts(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781 }
2782 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002783 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002784 (fl->fl_type & LOCK_READ)
2785 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2786 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2787 } else {
Pavel Begunkov43e4cb92019-07-24 20:16:31 +03002788 int type = IS_LEASE(fl) ? target_leasetype(fl) : fl->fl_type;
2789
2790 seq_printf(f, "%s ", (type == F_WRLCK) ? "WRITE" :
2791 (type == F_RDLCK) ? "READ" : "UNLCK");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002792 }
2793 if (inode) {
Jeff Layton36488882015-04-03 09:04:04 -04002794 /* userspace relies on this representation of dev_t */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002795 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002796 MAJOR(inode->i_sb->s_dev),
2797 MINOR(inode->i_sb->s_dev), inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002798 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002799 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800 }
2801 if (IS_POSIX(fl)) {
2802 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002803 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002804 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002805 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002807 seq_puts(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002808 }
2809}
2810
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002811static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002812{
Jeff Layton7012b022013-06-21 08:58:22 -04002813 struct locks_iterator *iter = f->private;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002814 struct file_lock *fl, *bfl;
Nikolay Borisovd67fd442016-08-17 16:18:46 -04002815 struct pid_namespace *proc_pidns = file_inode(f->file)->i_sb->s_fs_info;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002816
Jeff Layton139ca042013-06-21 08:58:17 -04002817 fl = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002818
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002819 if (locks_translate_pid(fl, proc_pidns) == 0)
Nikolay Borisovd67fd442016-08-17 16:18:46 -04002820 return 0;
2821
Jeff Layton7012b022013-06-21 08:58:22 -04002822 lock_get_status(f, fl, iter->li_pos, "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002823
NeilBrownada5c1d2018-11-30 10:04:08 +11002824 list_for_each_entry(bfl, &fl->fl_blocked_requests, fl_blocked_member)
Jeff Layton7012b022013-06-21 08:58:22 -04002825 lock_get_status(f, bfl, iter->li_pos, " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002826
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002827 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002828}
2829
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002830static void __show_fd_locks(struct seq_file *f,
2831 struct list_head *head, int *id,
2832 struct file *filp, struct files_struct *files)
2833{
2834 struct file_lock *fl;
2835
2836 list_for_each_entry(fl, head, fl_list) {
2837
2838 if (filp != fl->fl_file)
2839 continue;
2840 if (fl->fl_owner != files &&
2841 fl->fl_owner != filp)
2842 continue;
2843
2844 (*id)++;
2845 seq_puts(f, "lock:\t");
2846 lock_get_status(f, fl, *id, "");
2847 }
2848}
2849
2850void show_fd_locks(struct seq_file *f,
2851 struct file *filp, struct files_struct *files)
2852{
Miklos Szeredic568d682016-09-16 12:44:20 +02002853 struct inode *inode = locks_inode(filp);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002854 struct file_lock_context *ctx;
2855 int id = 0;
2856
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002857 ctx = smp_load_acquire(&inode->i_flctx);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002858 if (!ctx)
2859 return;
2860
2861 spin_lock(&ctx->flc_lock);
2862 __show_fd_locks(f, &ctx->flc_flock, &id, filp, files);
2863 __show_fd_locks(f, &ctx->flc_posix, &id, filp, files);
2864 __show_fd_locks(f, &ctx->flc_lease, &id, filp, files);
2865 spin_unlock(&ctx->flc_lock);
2866}
2867
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002868static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002869 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002870{
Jeff Layton7012b022013-06-21 08:58:22 -04002871 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002872
Jeff Layton7012b022013-06-21 08:58:22 -04002873 iter->li_pos = *pos + 1;
Peter Zijlstraaba37662015-06-22 14:16:33 +02002874 percpu_down_write(&file_rwsem);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002875 spin_lock(&blocked_lock_lock);
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002876 return seq_hlist_start_percpu(&file_lock_list.hlist, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002877}
2878
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002879static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2880{
Jeff Layton7012b022013-06-21 08:58:22 -04002881 struct locks_iterator *iter = f->private;
2882
2883 ++iter->li_pos;
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002884 return seq_hlist_next_percpu(v, &file_lock_list.hlist, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002885}
2886
2887static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002888 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002889{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002890 spin_unlock(&blocked_lock_lock);
Peter Zijlstraaba37662015-06-22 14:16:33 +02002891 percpu_up_write(&file_rwsem);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002892}
2893
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002894static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002895 .start = locks_start,
2896 .next = locks_next,
2897 .stop = locks_stop,
2898 .show = locks_show,
2899};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002900
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002901static int __init proc_locks_init(void)
2902{
Christoph Hellwig44414d82018-04-24 17:05:17 +02002903 proc_create_seq_private("locks", 0, NULL, &locks_seq_operations,
2904 sizeof(struct locks_iterator), NULL);
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002905 return 0;
2906}
Paul Gortmaker91899222015-12-17 14:11:03 -05002907fs_initcall(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002908#endif
2909
Linus Torvalds1da177e2005-04-16 15:20:36 -07002910static int __init filelock_init(void)
2911{
Jeff Layton7012b022013-06-21 08:58:22 -04002912 int i;
2913
Jeff Layton4a075e32015-01-16 15:05:54 -05002914 flctx_cache = kmem_cache_create("file_lock_ctx",
2915 sizeof(struct file_lock_context), 0, SLAB_PANIC, NULL);
2916
Linus Torvalds1da177e2005-04-16 15:20:36 -07002917 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002918 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2919
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002920 for_each_possible_cpu(i) {
2921 struct file_lock_list_struct *fll = per_cpu_ptr(&file_lock_list, i);
2922
2923 spin_lock_init(&fll->lock);
2924 INIT_HLIST_HEAD(&fll->hlist);
2925 }
Jeff Layton7012b022013-06-21 08:58:22 -04002926
Linus Torvalds1da177e2005-04-16 15:20:36 -07002927 return 0;
2928}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002929core_initcall(filelock_init);