blob: de87a323178928e6225abd33292301ffe48ad04c [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{
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400661 if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 return fl2->fl_lmops == fl1->fl_lmops &&
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400663 fl1->fl_lmops->lm_compare_owner(fl1, fl2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 return fl1->fl_owner == fl2->fl_owner;
665}
666
Jeff Layton6109c852015-01-16 15:05:57 -0500667/* Must be called with the flc_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500668static void locks_insert_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400669{
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200670 struct file_lock_list_struct *fll = this_cpu_ptr(&file_lock_list);
671
Peter Zijlstraaba37662015-06-22 14:16:33 +0200672 percpu_rwsem_assert_held(&file_rwsem);
673
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200674 spin_lock(&fll->lock);
Jeff Layton7012b022013-06-21 08:58:22 -0400675 fl->fl_link_cpu = smp_processor_id();
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200676 hlist_add_head(&fl->fl_link, &fll->hlist);
677 spin_unlock(&fll->lock);
Jeff Layton88974692013-06-21 08:58:14 -0400678}
679
Jeff Layton6109c852015-01-16 15:05:57 -0500680/* Must be called with the flc_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500681static void locks_delete_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400682{
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200683 struct file_lock_list_struct *fll;
684
Peter Zijlstraaba37662015-06-22 14:16:33 +0200685 percpu_rwsem_assert_held(&file_rwsem);
686
Jeff Layton7012b022013-06-21 08:58:22 -0400687 /*
688 * Avoid taking lock if already unhashed. This is safe since this check
Jeff Layton6109c852015-01-16 15:05:57 -0500689 * is done while holding the flc_lock, and new insertions into the list
Jeff Layton7012b022013-06-21 08:58:22 -0400690 * also require that it be held.
691 */
692 if (hlist_unhashed(&fl->fl_link))
693 return;
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200694
695 fll = per_cpu_ptr(&file_lock_list, fl->fl_link_cpu);
696 spin_lock(&fll->lock);
Jeff Layton139ca042013-06-21 08:58:17 -0400697 hlist_del_init(&fl->fl_link);
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200698 spin_unlock(&fll->lock);
Jeff Layton88974692013-06-21 08:58:14 -0400699}
700
Jeff Layton3999e492013-06-21 08:58:19 -0400701static unsigned long
702posix_owner_key(struct file_lock *fl)
703{
704 if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
705 return fl->fl_lmops->lm_owner_key(fl);
706 return (unsigned long)fl->fl_owner;
707}
708
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500709static void locks_insert_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400710{
Daniel Wagner663d5af2015-04-03 09:04:03 -0400711 lockdep_assert_held(&blocked_lock_lock);
712
Jeff Layton3999e492013-06-21 08:58:19 -0400713 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
Jeff Layton88974692013-06-21 08:58:14 -0400714}
715
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500716static void locks_delete_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400717{
Daniel Wagner663d5af2015-04-03 09:04:03 -0400718 lockdep_assert_held(&blocked_lock_lock);
719
Jeff Layton48f74182013-06-21 08:58:18 -0400720 hash_del(&waiter->fl_link);
Jeff Layton88974692013-06-21 08:58:14 -0400721}
722
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723/* Remove waiter from blocker's block list.
724 * When blocker ends up pointing to itself then the list is empty.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400725 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400726 * Must be called with blocked_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 */
Matt Mackall33443c42006-01-08 01:05:22 -0800728static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729{
Jeff Layton88974692013-06-21 08:58:14 -0400730 locks_delete_global_blocked(waiter);
NeilBrownada5c1d2018-11-30 10:04:08 +1100731 list_del_init(&waiter->fl_blocked_member);
732 waiter->fl_blocker = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733}
734
NeilBrownad6bbd82018-11-30 10:04:08 +1100735static void __locks_wake_up_blocks(struct file_lock *blocker)
736{
737 while (!list_empty(&blocker->fl_blocked_requests)) {
738 struct file_lock *waiter;
739
740 waiter = list_first_entry(&blocker->fl_blocked_requests,
741 struct file_lock, fl_blocked_member);
742 __locks_delete_block(waiter);
743 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
744 waiter->fl_lmops->lm_notify(waiter);
745 else
746 wake_up(&waiter->fl_wait);
747 }
748}
749
NeilBrowncb03f942018-11-30 10:04:08 +1100750/**
751 * locks_delete_lock - stop waiting for a file lock
752 * @waiter: the lock which was waiting
753 *
754 * lockd/nfsd need to disconnect the lock while working on it.
755 */
756int locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757{
NeilBrowncb03f942018-11-30 10:04:08 +1100758 int status = -ENOENT;
759
NeilBrown16306a62018-11-30 10:04:08 +1100760 /*
761 * If fl_blocker is NULL, it won't be set again as this thread
762 * "owns" the lock and is the only one that might try to claim
763 * the lock. So it is safe to test fl_blocker locklessly.
764 * Also if fl_blocker is NULL, this waiter is not listed on
765 * fl_blocked_requests for some lock, so no other request can
766 * be added to the list of fl_blocked_requests for this
767 * request. So if fl_blocker is NULL, it is safe to
768 * locklessly check if fl_blocked_requests is empty. If both
769 * of these checks succeed, there is no need to take the lock.
770 */
771 if (waiter->fl_blocker == NULL &&
772 list_empty(&waiter->fl_blocked_requests))
NeilBrowncb03f942018-11-30 10:04:08 +1100773 return status;
Jeff Layton7b2296a2013-06-21 08:58:20 -0400774 spin_lock(&blocked_lock_lock);
NeilBrowncb03f942018-11-30 10:04:08 +1100775 if (waiter->fl_blocker)
776 status = 0;
NeilBrown5946c432018-11-30 10:04:08 +1100777 __locks_wake_up_blocks(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 __locks_delete_block(waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400779 spin_unlock(&blocked_lock_lock);
NeilBrowncb03f942018-11-30 10:04:08 +1100780 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781}
NeilBrowncb03f942018-11-30 10:04:08 +1100782EXPORT_SYMBOL(locks_delete_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783
784/* Insert waiter into blocker's block list.
785 * We use a circular list so that processes can be easily woken up in
786 * the order they blocked. The documentation doesn't require this but
787 * it seems like the reasonable thing to do.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400788 *
Jeff Layton6109c852015-01-16 15:05:57 -0500789 * Must be called with both the flc_lock and blocked_lock_lock held. The
NeilBrownada5c1d2018-11-30 10:04:08 +1100790 * fl_blocked_requests list itself is protected by the blocked_lock_lock,
791 * but by ensuring that the flc_lock is also held on insertions we can avoid
792 * taking the blocked_lock_lock in some cases when we see that the
793 * fl_blocked_requests list is empty.
NeilBrownfd7732e2018-11-30 10:04:08 +1100794 *
795 * Rather than just adding to the list, we check for conflicts with any existing
796 * waiters, and add beneath any waiter that blocks the new waiter.
797 * Thus wakeups don't happen until needed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400799static void __locks_insert_block(struct file_lock *blocker,
NeilBrownfd7732e2018-11-30 10:04:08 +1100800 struct file_lock *waiter,
801 bool conflict(struct file_lock *,
802 struct file_lock *))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803{
NeilBrownfd7732e2018-11-30 10:04:08 +1100804 struct file_lock *fl;
NeilBrownada5c1d2018-11-30 10:04:08 +1100805 BUG_ON(!list_empty(&waiter->fl_blocked_member));
NeilBrownfd7732e2018-11-30 10:04:08 +1100806
807new_blocker:
808 list_for_each_entry(fl, &blocker->fl_blocked_requests, fl_blocked_member)
809 if (conflict(fl, waiter)) {
810 blocker = fl;
811 goto new_blocker;
812 }
NeilBrownada5c1d2018-11-30 10:04:08 +1100813 waiter->fl_blocker = blocker;
814 list_add_tail(&waiter->fl_blocked_member, &blocker->fl_blocked_requests);
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400815 if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400816 locks_insert_global_blocked(waiter);
NeilBrown5946c432018-11-30 10:04:08 +1100817
818 /* The requests in waiter->fl_blocked are known to conflict with
819 * waiter, but might not conflict with blocker, or the requests
820 * and lock which block it. So they all need to be woken.
821 */
822 __locks_wake_up_blocks(waiter);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400823}
824
Jeff Layton6109c852015-01-16 15:05:57 -0500825/* Must be called with flc_lock held. */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400826static void locks_insert_block(struct file_lock *blocker,
NeilBrownfd7732e2018-11-30 10:04:08 +1100827 struct file_lock *waiter,
828 bool conflict(struct file_lock *,
829 struct file_lock *))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400830{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400831 spin_lock(&blocked_lock_lock);
NeilBrownfd7732e2018-11-30 10:04:08 +1100832 __locks_insert_block(blocker, waiter, conflict);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400833 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834}
835
Jeff Layton1cb36012013-06-21 08:58:12 -0400836/*
837 * Wake up processes blocked waiting for blocker.
838 *
Jeff Layton6109c852015-01-16 15:05:57 -0500839 * Must be called with the inode->flc_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 */
841static void locks_wake_up_blocks(struct file_lock *blocker)
842{
Jeff Layton4e8c7652013-06-21 08:58:16 -0400843 /*
844 * Avoid taking global lock if list is empty. This is safe since new
Jeff Layton6109c852015-01-16 15:05:57 -0500845 * blocked requests are only added to the list under the flc_lock, and
NeilBrownada5c1d2018-11-30 10:04:08 +1100846 * the flc_lock is always held here. Note that removal from the
847 * fl_blocked_requests list does not require the flc_lock, so we must
848 * recheck list_empty() after acquiring the blocked_lock_lock.
Jeff Layton4e8c7652013-06-21 08:58:16 -0400849 */
NeilBrownada5c1d2018-11-30 10:04:08 +1100850 if (list_empty(&blocker->fl_blocked_requests))
Jeff Layton4e8c7652013-06-21 08:58:16 -0400851 return;
852
Jeff Layton7b2296a2013-06-21 08:58:20 -0400853 spin_lock(&blocked_lock_lock);
NeilBrownad6bbd82018-11-30 10:04:08 +1100854 __locks_wake_up_blocks(blocker);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400855 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856}
857
Jeff Layton5263e312015-01-16 15:05:55 -0500858static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500859locks_insert_lock_ctx(struct file_lock *fl, struct list_head *before)
Jeff Layton5263e312015-01-16 15:05:55 -0500860{
Jeff Layton5263e312015-01-16 15:05:55 -0500861 list_add_tail(&fl->fl_list, before);
862 locks_insert_global_locks(fl);
863}
864
Jeff Layton8634b512015-01-16 15:05:55 -0500865static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500866locks_unlink_lock_ctx(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867{
Jeff Layton88974692013-06-21 08:58:14 -0400868 locks_delete_global_locks(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500869 list_del_init(&fl->fl_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 locks_wake_up_blocks(fl);
Jeff Layton24cbe782014-02-03 12:13:06 -0500871}
872
Jeff Layton5263e312015-01-16 15:05:55 -0500873static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500874locks_delete_lock_ctx(struct file_lock *fl, struct list_head *dispose)
Jeff Layton5263e312015-01-16 15:05:55 -0500875{
Jeff Laytone084c1b2015-02-16 14:32:03 -0500876 locks_unlink_lock_ctx(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500877 if (dispose)
878 list_add(&fl->fl_list, dispose);
879 else
880 locks_free_lock(fl);
Jeff Layton5263e312015-01-16 15:05:55 -0500881}
882
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
884 * checks for shared/exclusive status of overlapping locks.
885 */
NeilBrownc0e15902018-11-30 10:04:08 +1100886static bool locks_conflict(struct file_lock *caller_fl,
887 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888{
889 if (sys_fl->fl_type == F_WRLCK)
NeilBrownc0e15902018-11-30 10:04:08 +1100890 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 if (caller_fl->fl_type == F_WRLCK)
NeilBrownc0e15902018-11-30 10:04:08 +1100892 return true;
893 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894}
895
896/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
897 * checking before calling the locks_conflict().
898 */
NeilBrownc0e15902018-11-30 10:04:08 +1100899static bool posix_locks_conflict(struct file_lock *caller_fl,
900 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901{
902 /* POSIX locks owned by the same process do not conflict with
903 * each other.
904 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400905 if (posix_same_owner(caller_fl, sys_fl))
NeilBrownc0e15902018-11-30 10:04:08 +1100906 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907
908 /* Check whether they overlap */
909 if (!locks_overlap(caller_fl, sys_fl))
NeilBrownc0e15902018-11-30 10:04:08 +1100910 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911
NeilBrownc0e15902018-11-30 10:04:08 +1100912 return locks_conflict(caller_fl, sys_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913}
914
915/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
916 * checking before calling the locks_conflict().
917 */
NeilBrownc0e15902018-11-30 10:04:08 +1100918static bool flock_locks_conflict(struct file_lock *caller_fl,
919 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920{
921 /* FLOCK locks referring to the same filp do not conflict with
922 * each other.
923 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400924 if (caller_fl->fl_file == sys_fl->fl_file)
NeilBrownc0e15902018-11-30 10:04:08 +1100925 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
NeilBrownc0e15902018-11-30 10:04:08 +1100927 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928
NeilBrownc0e15902018-11-30 10:04:08 +1100929 return locks_conflict(caller_fl, sys_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930}
931
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400932void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500933posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934{
935 struct file_lock *cfl;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500936 struct file_lock_context *ctx;
Miklos Szeredic568d682016-09-16 12:44:20 +0200937 struct inode *inode = locks_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200939 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500940 if (!ctx || list_empty_careful(&ctx->flc_posix)) {
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400941 fl->fl_type = F_UNLCK;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500942 return;
943 }
944
Jeff Layton6109c852015-01-16 15:05:57 -0500945 spin_lock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500946 list_for_each_entry(cfl, &ctx->flc_posix, fl_list) {
947 if (posix_locks_conflict(fl, cfl)) {
948 locks_copy_conflock(fl, cfl);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500949 goto out;
950 }
951 }
952 fl->fl_type = F_UNLCK;
953out:
Jeff Layton6109c852015-01-16 15:05:57 -0500954 spin_unlock(&ctx->flc_lock);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400955 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957EXPORT_SYMBOL(posix_test_lock);
958
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400959/*
960 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400962 * We attempt to detect deadlocks that are due purely to posix file
963 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400965 * We assume that a task can be waiting for at most one lock at a time.
966 * So for any acquired lock, the process holding that lock may be
967 * waiting on at most one other lock. That lock in turns may be held by
968 * someone waiting for at most one other lock. Given a requested lock
969 * caller_fl which is about to wait for a conflicting lock block_fl, we
970 * follow this chain of waiters to ensure we are not about to create a
971 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400972 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400973 * Since we do this before we ever put a process to sleep on a lock, we
974 * are ensured that there is never a cycle; that is what guarantees that
975 * the while() loop in posix_locks_deadlock() eventually completes.
976 *
977 * Note: the above assumption may not be true when handling lock
978 * requests from a broken NFS client. It may also fail in the presence
979 * of tasks (such as posix threads) sharing the same open file table.
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400980 * To handle those cases, we just bail out after a few iterations.
Jeff Layton57b65322014-02-03 12:13:09 -0500981 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400982 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
Jeff Layton57b65322014-02-03 12:13:09 -0500983 * Because the owner is not even nominally tied to a thread of
984 * execution, the deadlock detection below can't reasonably work well. Just
985 * skip it for those.
986 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400987 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
Jeff Layton57b65322014-02-03 12:13:09 -0500988 * locks that just checks for the case where two tasks are attempting to
989 * upgrade from read to write locks on the same inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400991
992#define MAX_DEADLK_ITERATIONS 10
993
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400994/* Find a lock that the owner of the given block_fl is blocking on. */
995static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
996{
997 struct file_lock *fl;
998
Jeff Layton3999e492013-06-21 08:58:19 -0400999 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
NeilBrown5946c432018-11-30 10:04:08 +11001000 if (posix_same_owner(fl, block_fl)) {
1001 while (fl->fl_blocker)
1002 fl = fl->fl_blocker;
1003 return fl;
1004 }
J. Bruce Fieldsb5331842007-10-26 18:05:40 -04001005 }
1006 return NULL;
1007}
1008
Jeff Layton7b2296a2013-06-21 08:58:20 -04001009/* Must be called with the blocked_lock_lock held! */
Adrian Bunkb0904e12006-06-23 02:05:13 -07001010static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 struct file_lock *block_fl)
1012{
J. Bruce Fields97855b42007-10-30 11:20:02 -04001013 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014
Daniel Wagner663d5af2015-04-03 09:04:03 -04001015 lockdep_assert_held(&blocked_lock_lock);
1016
Jeff Layton57b65322014-02-03 12:13:09 -05001017 /*
1018 * This deadlock detector can't reasonably detect deadlocks with
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001019 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
Jeff Layton57b65322014-02-03 12:13:09 -05001020 */
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001021 if (IS_OFDLCK(caller_fl))
Jeff Layton57b65322014-02-03 12:13:09 -05001022 return 0;
1023
J. Bruce Fieldsb5331842007-10-26 18:05:40 -04001024 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
1025 if (i++ > MAX_DEADLK_ITERATIONS)
1026 return 0;
1027 if (posix_same_owner(caller_fl, block_fl))
1028 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 }
1030 return 0;
1031}
1032
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -04001034 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -04001035 *
1036 * Note that if called with an FL_EXISTS argument, the caller may determine
1037 * whether or not a lock was successfully freed by testing the return
1038 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 */
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04001040static int flock_lock_inode(struct inode *inode, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041{
Trond Myklebust993dfa82006-03-31 02:30:55 -08001042 struct file_lock *new_fl = NULL;
Jeff Layton5263e312015-01-16 15:05:55 -05001043 struct file_lock *fl;
1044 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 int error = 0;
Jeff Layton5263e312015-01-16 15:05:55 -05001046 bool found = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -04001047 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048
Jeff Layton5c1c6692015-04-03 09:04:03 -04001049 ctx = locks_get_lock_context(inode, request->fl_type);
1050 if (!ctx) {
1051 if (request->fl_type != F_UNLCK)
1052 return -ENOMEM;
1053 return (request->fl_flags & FL_EXISTS) ? -ENOENT : 0;
1054 }
Jeff Layton5263e312015-01-16 15:05:55 -05001055
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001056 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
1057 new_fl = locks_alloc_lock();
1058 if (!new_fl)
1059 return -ENOMEM;
1060 }
1061
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001062 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001063 spin_lock(&ctx->flc_lock);
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001064 if (request->fl_flags & FL_ACCESS)
1065 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +04001066
Jeff Layton5263e312015-01-16 15:05:55 -05001067 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04001068 if (request->fl_file != fl->fl_file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001070 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 goto out;
Jeff Layton5263e312015-01-16 15:05:55 -05001072 found = true;
Jeff Laytone084c1b2015-02-16 14:32:03 -05001073 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 break;
1075 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076
Trond Myklebustf475ae92006-06-29 16:38:32 -04001077 if (request->fl_type == F_UNLCK) {
1078 if ((request->fl_flags & FL_EXISTS) && !found)
1079 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001080 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001081 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001083find_conflict:
Jeff Layton5263e312015-01-16 15:05:55 -05001084 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Trond Myklebust993dfa82006-03-31 02:30:55 -08001085 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 continue;
1087 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -07001088 if (!(request->fl_flags & FL_SLEEP))
1089 goto out;
1090 error = FILE_LOCK_DEFERRED;
NeilBrownfd7732e2018-11-30 10:04:08 +11001091 locks_insert_block(fl, request, flock_locks_conflict);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 goto out;
1093 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001094 if (request->fl_flags & FL_ACCESS)
1095 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001096 locks_copy_lock(new_fl, request);
NeilBrown5946c432018-11-30 10:04:08 +11001097 locks_move_blocks(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001098 locks_insert_lock_ctx(new_fl, &ctx->flc_flock);
Trond Myklebust993dfa82006-03-31 02:30:55 -08001099 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +04001100 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101
1102out:
Jeff Layton6109c852015-01-16 15:05:57 -05001103 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001104 percpu_up_read(&file_rwsem);
Trond Myklebust993dfa82006-03-31 02:30:55 -08001105 if (new_fl)
1106 locks_free_lock(new_fl);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001107 locks_dispose_list(&dispose);
Jeff Laytonc883da32018-07-30 07:54:56 -04001108 trace_flock_lock_inode(inode, request, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 return error;
1110}
1111
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001112static int posix_lock_inode(struct inode *inode, struct file_lock *request,
1113 struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001115 struct file_lock *fl, *tmp;
Miklos Szeredi39005d02006-06-23 02:05:10 -07001116 struct file_lock *new_fl = NULL;
1117 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 struct file_lock *left = NULL;
1119 struct file_lock *right = NULL;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001120 struct file_lock_context *ctx;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001121 int error;
1122 bool added = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -04001123 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124
Jeff Layton5c1c6692015-04-03 09:04:03 -04001125 ctx = locks_get_lock_context(inode, request->fl_type);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001126 if (!ctx)
Jeff Layton5c1c6692015-04-03 09:04:03 -04001127 return (request->fl_type == F_UNLCK) ? 0 : -ENOMEM;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001128
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 /*
1130 * We may need two file_lock structures for this operation,
1131 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -07001132 *
1133 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 */
Miklos Szeredi39005d02006-06-23 02:05:10 -07001135 if (!(request->fl_flags & FL_ACCESS) &&
1136 (request->fl_type != F_UNLCK ||
1137 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
1138 new_fl = locks_alloc_lock();
1139 new_fl2 = locks_alloc_lock();
1140 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001142 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001143 spin_lock(&ctx->flc_lock);
Jeff Layton1cb36012013-06-21 08:58:12 -04001144 /*
1145 * New lock request. Walk all POSIX locks and look for conflicts. If
1146 * there are any, either return error or put the request on the
Jeff Layton48f74182013-06-21 08:58:18 -04001147 * blocker's list of waiters and the global blocked_hash.
Jeff Layton1cb36012013-06-21 08:58:12 -04001148 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 if (request->fl_type != F_UNLCK) {
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001150 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 if (!posix_locks_conflict(request, fl))
1152 continue;
Andy Adamson5842add2006-03-26 01:37:26 -08001153 if (conflock)
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001154 locks_copy_conflock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 error = -EAGAIN;
1156 if (!(request->fl_flags & FL_SLEEP))
1157 goto out;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001158 /*
1159 * Deadlock detection and insertion into the blocked
1160 * locks list must be done while holding the same lock!
1161 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 error = -EDEADLK;
Jeff Layton7b2296a2013-06-21 08:58:20 -04001163 spin_lock(&blocked_lock_lock);
Jeff Layton945ab8f2019-03-25 08:15:14 -04001164 /*
1165 * Ensure that we don't find any locks blocked on this
1166 * request during deadlock detection.
1167 */
1168 __locks_wake_up_blocks(request);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001169 if (likely(!posix_locks_deadlock(request, fl))) {
1170 error = FILE_LOCK_DEFERRED;
NeilBrownfd7732e2018-11-30 10:04:08 +11001171 __locks_insert_block(fl, request,
1172 posix_locks_conflict);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001173 }
Jeff Layton7b2296a2013-06-21 08:58:20 -04001174 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 goto out;
NeilBrown7bbd1fc2018-11-30 10:04:08 +11001176 }
1177 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178
1179 /* If we're just looking for a conflict, we're done. */
1180 error = 0;
1181 if (request->fl_flags & FL_ACCESS)
1182 goto out;
1183
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001184 /* Find the first old lock with the same owner as the new lock */
1185 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1186 if (posix_same_owner(request, fl))
1187 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 }
1189
Jeff Layton1cb36012013-06-21 08:58:12 -04001190 /* Process locks with this owner. */
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001191 list_for_each_entry_safe_from(fl, tmp, &ctx->flc_posix, fl_list) {
1192 if (!posix_same_owner(request, fl))
1193 break;
1194
1195 /* Detect adjacent or overlapping regions (if same lock type) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -07001197 /* In all comparisons of start vs end, use
1198 * "start - 1" rather than "end + 1". If end
1199 * is OFFSET_MAX, end + 1 will become negative.
1200 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 if (fl->fl_end < request->fl_start - 1)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001202 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 /* If the next lock in the list has entirely bigger
1204 * addresses than the new one, insert the lock here.
1205 */
Olaf Kirch449231d2005-08-25 16:25:35 -07001206 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 break;
1208
1209 /* If we come here, the new and old lock are of the
1210 * same type and adjacent or overlapping. Make one
1211 * lock yielding from the lower start address of both
1212 * locks to the higher end address.
1213 */
1214 if (fl->fl_start > request->fl_start)
1215 fl->fl_start = request->fl_start;
1216 else
1217 request->fl_start = fl->fl_start;
1218 if (fl->fl_end < request->fl_end)
1219 fl->fl_end = request->fl_end;
1220 else
1221 request->fl_end = fl->fl_end;
1222 if (added) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001223 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 continue;
1225 }
1226 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001227 added = true;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001228 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 /* Processing for different lock types is a bit
1230 * more complex.
1231 */
1232 if (fl->fl_end < request->fl_start)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001233 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 if (fl->fl_start > request->fl_end)
1235 break;
1236 if (request->fl_type == F_UNLCK)
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001237 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 if (fl->fl_start < request->fl_start)
1239 left = fl;
1240 /* If the next lock in the list has a higher end
1241 * address than the new one, insert the new one here.
1242 */
1243 if (fl->fl_end > request->fl_end) {
1244 right = fl;
1245 break;
1246 }
1247 if (fl->fl_start >= request->fl_start) {
1248 /* The new lock completely replaces an old
1249 * one (This may happen several times).
1250 */
1251 if (added) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001252 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 continue;
1254 }
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001255 /*
1256 * Replace the old lock with new_fl, and
1257 * remove the old one. It's safe to do the
1258 * insert here since we know that we won't be
1259 * using new_fl later, and that the lock is
1260 * just replacing an existing lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 */
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001262 error = -ENOLCK;
1263 if (!new_fl)
1264 goto out;
1265 locks_copy_lock(new_fl, request);
1266 request = new_fl;
1267 new_fl = NULL;
Jeff Laytone084c1b2015-02-16 14:32:03 -05001268 locks_insert_lock_ctx(request, &fl->fl_list);
1269 locks_delete_lock_ctx(fl, &dispose);
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001270 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 }
1272 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 }
1274
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001275 /*
Jeff Layton1cb36012013-06-21 08:58:12 -04001276 * The above code only modifies existing locks in case of merging or
1277 * replacing. If new lock(s) need to be inserted all modifications are
1278 * done below this, so it's safe yet to bail out.
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001279 */
1280 error = -ENOLCK; /* "no luck" */
1281 if (right && left == right && !new_fl2)
1282 goto out;
1283
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 error = 0;
1285 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -04001286 if (request->fl_type == F_UNLCK) {
1287 if (request->fl_flags & FL_EXISTS)
1288 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001290 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001291
1292 if (!new_fl) {
1293 error = -ENOLCK;
1294 goto out;
1295 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 locks_copy_lock(new_fl, request);
NeilBrown5946c432018-11-30 10:04:08 +11001297 locks_move_blocks(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001298 locks_insert_lock_ctx(new_fl, &fl->fl_list);
Jeff Layton2e2f756f2015-02-17 17:08:23 -05001299 fl = new_fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 new_fl = NULL;
1301 }
1302 if (right) {
1303 if (left == right) {
1304 /* The new lock breaks the old one in two pieces,
1305 * so we have to use the second new lock.
1306 */
1307 left = new_fl2;
1308 new_fl2 = NULL;
1309 locks_copy_lock(left, right);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001310 locks_insert_lock_ctx(left, &fl->fl_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 }
1312 right->fl_start = request->fl_end + 1;
1313 locks_wake_up_blocks(right);
1314 }
1315 if (left) {
1316 left->fl_end = request->fl_start - 1;
1317 locks_wake_up_blocks(left);
1318 }
1319 out:
Jeff Layton6109c852015-01-16 15:05:57 -05001320 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001321 percpu_up_read(&file_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 /*
1323 * Free any unused locks.
1324 */
1325 if (new_fl)
1326 locks_free_lock(new_fl);
1327 if (new_fl2)
1328 locks_free_lock(new_fl2);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001329 locks_dispose_list(&dispose);
Jeff Layton18909102016-01-06 21:26:10 -05001330 trace_posix_lock_inode(inode, request, error);
1331
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 return error;
1333}
1334
1335/**
1336 * posix_lock_file - Apply a POSIX-style lock to a file
1337 * @filp: The file to apply the lock to
1338 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001339 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 *
1341 * Add a POSIX style lock to a file.
1342 * We merge adjacent & overlapping locks whenever possible.
1343 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001344 *
1345 * Note that if called with an FL_EXISTS argument, the caller may determine
1346 * whether or not a lock was successfully freed by testing the return
1347 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 */
Marc Eshel150b3932007-01-18 16:15:35 -05001349int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001350 struct file_lock *conflock)
1351{
Miklos Szeredic568d682016-09-16 12:44:20 +02001352 return posix_lock_inode(locks_inode(filp), fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001353}
Marc Eshel150b3932007-01-18 16:15:35 -05001354EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355
1356/**
Jeff Layton29d01b22015-07-11 06:43:02 -04001357 * posix_lock_inode_wait - Apply a POSIX-style lock to a file
1358 * @inode: inode of file to which lock request should be applied
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 * @fl: The lock to be applied
1360 *
Benjamin Coddington616fb382015-10-22 13:38:15 -04001361 * Apply a POSIX style lock request to an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 */
Benjamin Coddington616fb382015-10-22 13:38:15 -04001363static int posix_lock_inode_wait(struct inode *inode, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364{
1365 int error;
1366 might_sleep ();
1367 for (;;) {
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001368 error = posix_lock_inode(inode, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001369 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11001371 error = wait_event_interruptible(fl->fl_wait, !fl->fl_blocker);
NeilBrown16306a62018-11-30 10:04:08 +11001372 if (error)
1373 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 }
NeilBrown16306a62018-11-30 10:04:08 +11001375 locks_delete_block(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 return error;
1377}
Jeff Layton29d01b22015-07-11 06:43:02 -04001378
Jeff Layton9e8925b2015-11-16 09:49:34 -05001379#ifdef CONFIG_MANDATORY_FILE_LOCKING
Jeff Layton29d01b22015-07-11 06:43:02 -04001380/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 * locks_mandatory_locked - Check for an active lock
Jeff Laytond7a06982014-03-10 09:54:15 -04001382 * @file: the file to check
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 *
1384 * Searches the inode's list of locks to find any POSIX locks which conflict.
1385 * This function is called from locks_verify_locked() only.
1386 */
Jeff Laytond7a06982014-03-10 09:54:15 -04001387int locks_mandatory_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001389 int ret;
Miklos Szeredic568d682016-09-16 12:44:20 +02001390 struct inode *inode = locks_inode(file);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001391 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392 struct file_lock *fl;
1393
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001394 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001395 if (!ctx || list_empty_careful(&ctx->flc_posix))
1396 return 0;
1397
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398 /*
1399 * Search the lock list for this inode for any POSIX locks.
1400 */
Jeff Layton6109c852015-01-16 15:05:57 -05001401 spin_lock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001402 ret = 0;
1403 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001404 if (fl->fl_owner != current->files &&
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001405 fl->fl_owner != file) {
1406 ret = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 break;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001408 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 }
Jeff Layton6109c852015-01-16 15:05:57 -05001410 spin_unlock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001411 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412}
1413
1414/**
1415 * locks_mandatory_area - Check for a conflicting lock
Christoph Hellwigacc15572015-12-03 12:59:49 +01001416 * @inode: the file to check
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 * @filp: how the file was opened (if it was)
Christoph Hellwigacc15572015-12-03 12:59:49 +01001418 * @start: first byte in the file to check
1419 * @end: lastbyte in the file to check
1420 * @type: %F_WRLCK for a write lock, else %F_RDLCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 *
1422 * Searches the inode's list of locks to find any POSIX locks which conflict.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 */
Christoph Hellwigacc15572015-12-03 12:59:49 +01001424int locks_mandatory_area(struct inode *inode, struct file *filp, loff_t start,
1425 loff_t end, unsigned char type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426{
1427 struct file_lock fl;
1428 int error;
Jeff Layton29723ad2014-03-10 09:54:19 -04001429 bool sleep = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430
1431 locks_init_lock(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 fl.fl_pid = current->tgid;
1433 fl.fl_file = filp;
1434 fl.fl_flags = FL_POSIX | FL_ACCESS;
1435 if (filp && !(filp->f_flags & O_NONBLOCK))
Jeff Layton29723ad2014-03-10 09:54:19 -04001436 sleep = true;
Christoph Hellwigacc15572015-12-03 12:59:49 +01001437 fl.fl_type = type;
1438 fl.fl_start = start;
1439 fl.fl_end = end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
1441 for (;;) {
Jeff Layton29723ad2014-03-10 09:54:19 -04001442 if (filp) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001443 fl.fl_owner = filp;
Jeff Layton29723ad2014-03-10 09:54:19 -04001444 fl.fl_flags &= ~FL_SLEEP;
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001445 error = posix_lock_inode(inode, &fl, NULL);
Jeff Layton29723ad2014-03-10 09:54:19 -04001446 if (!error)
1447 break;
1448 }
1449
1450 if (sleep)
1451 fl.fl_flags |= FL_SLEEP;
1452 fl.fl_owner = current->files;
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001453 error = posix_lock_inode(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001454 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11001456 error = wait_event_interruptible(fl.fl_wait, !fl.fl_blocker);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 if (!error) {
1458 /*
1459 * If we've been sleeping someone might have
1460 * changed the permissions behind our back.
1461 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001462 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 continue;
1464 }
1465
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466 break;
1467 }
NeilBrown16306a62018-11-30 10:04:08 +11001468 locks_delete_block(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469
1470 return error;
1471}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472EXPORT_SYMBOL(locks_mandatory_area);
Jeff Layton9e8925b2015-11-16 09:49:34 -05001473#endif /* CONFIG_MANDATORY_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474
J. Bruce Fields778fc542011-07-26 18:25:49 -04001475static void lease_clear_pending(struct file_lock *fl, int arg)
1476{
1477 switch (arg) {
1478 case F_UNLCK:
1479 fl->fl_flags &= ~FL_UNLOCK_PENDING;
Gustavo A. R. Silva0a4c9262019-01-23 02:48:28 -06001480 /* fall through */
J. Bruce Fields778fc542011-07-26 18:25:49 -04001481 case F_RDLCK:
1482 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1483 }
1484}
1485
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486/* We already had a lease on this file; just change its type */
Jeff Layton7448cc32015-01-16 15:05:57 -05001487int lease_modify(struct file_lock *fl, int arg, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 int error = assign_type(fl, arg);
1490
1491 if (error)
1492 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001493 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001495 if (arg == F_UNLCK) {
1496 struct file *filp = fl->fl_file;
1497
1498 f_delown(filp);
1499 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001500 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1501 if (fl->fl_fasync != NULL) {
1502 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1503 fl->fl_fasync = NULL;
1504 }
Jeff Laytone084c1b2015-02-16 14:32:03 -05001505 locks_delete_lock_ctx(fl, dispose);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001506 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 return 0;
1508}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509EXPORT_SYMBOL(lease_modify);
1510
J. Bruce Fields778fc542011-07-26 18:25:49 -04001511static bool past_time(unsigned long then)
1512{
1513 if (!then)
1514 /* 0 is a special value meaning "this never expires": */
1515 return false;
1516 return time_after(jiffies, then);
1517}
1518
Jeff Laytonc45198e2014-09-01 07:12:07 -04001519static void time_out_leases(struct inode *inode, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520{
Jeff Layton8634b512015-01-16 15:05:55 -05001521 struct file_lock_context *ctx = inode->i_flctx;
1522 struct file_lock *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523
Jeff Layton6109c852015-01-16 15:05:57 -05001524 lockdep_assert_held(&ctx->flc_lock);
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001525
Jeff Layton8634b512015-01-16 15:05:55 -05001526 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001527 trace_time_out_leases(inode, fl);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001528 if (past_time(fl->fl_downgrade_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001529 lease_modify(fl, F_RDLCK, dispose);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001530 if (past_time(fl->fl_break_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001531 lease_modify(fl, F_UNLCK, dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532 }
1533}
1534
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001535static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1536{
Ira Weinyd51f5272019-06-05 18:45:34 -07001537 bool rc;
1538
1539 if ((breaker->fl_flags & FL_LAYOUT) != (lease->fl_flags & FL_LAYOUT)) {
1540 rc = false;
1541 goto trace;
1542 }
1543 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE)) {
1544 rc = false;
1545 goto trace;
1546 }
1547
1548 rc = locks_conflict(breaker, lease);
1549trace:
1550 trace_leases_conflict(rc, lease, breaker);
1551 return rc;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001552}
1553
Jeff Layton03d12dd2014-09-01 14:53:41 -04001554static bool
1555any_leases_conflict(struct inode *inode, struct file_lock *breaker)
1556{
Jeff Layton8634b512015-01-16 15:05:55 -05001557 struct file_lock_context *ctx = inode->i_flctx;
Jeff Layton03d12dd2014-09-01 14:53:41 -04001558 struct file_lock *fl;
1559
Jeff Layton6109c852015-01-16 15:05:57 -05001560 lockdep_assert_held(&ctx->flc_lock);
Jeff Layton03d12dd2014-09-01 14:53:41 -04001561
Jeff Layton8634b512015-01-16 15:05:55 -05001562 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Jeff Layton03d12dd2014-09-01 14:53:41 -04001563 if (leases_conflict(fl, breaker))
1564 return true;
1565 }
1566 return false;
1567}
1568
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569/**
1570 * __break_lease - revoke all outstanding leases on file
1571 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001572 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1573 * break all leases
1574 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1575 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 *
david m. richter87250dd2007-05-09 16:10:27 -04001577 * break_lease (inlined for speed) has checked there already is at least
1578 * some kind of lock (maybe a lease) on this file. Leases are broken on
1579 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 * specified %O_NONBLOCK to your open().
1581 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001582int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001584 int error = 0;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001585 struct file_lock_context *ctx;
Yan, Zhenga9011252015-03-27 10:34:20 +08001586 struct file_lock *new_fl, *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 unsigned long break_time;
Al Viro8737c932009-12-24 06:47:55 -05001588 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001589 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590
Al Viro8737c932009-12-24 06:47:55 -05001591 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001592 if (IS_ERR(new_fl))
1593 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001594 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595
Jeff Layton8634b512015-01-16 15:05:55 -05001596 /* typically we will check that ctx is non-NULL before calling */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001597 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001598 if (!ctx) {
1599 WARN_ON_ONCE(1);
1600 return error;
1601 }
1602
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001603 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001604 spin_lock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605
Jeff Laytonc45198e2014-09-01 07:12:07 -04001606 time_out_leases(inode, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607
Jeff Layton03d12dd2014-09-01 14:53:41 -04001608 if (!any_leases_conflict(inode, new_fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001609 goto out;
1610
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 break_time = 0;
1612 if (lease_break_time > 0) {
1613 break_time = jiffies + lease_break_time * HZ;
1614 if (break_time == 0)
1615 break_time++; /* so that 0 means no break time */
1616 }
1617
Yan, Zhenga9011252015-03-27 10:34:20 +08001618 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001619 if (!leases_conflict(fl, new_fl))
1620 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001621 if (want_write) {
1622 if (fl->fl_flags & FL_UNLOCK_PENDING)
1623 continue;
1624 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001626 } else {
Jeff Layton8634b512015-01-16 15:05:55 -05001627 if (lease_breaking(fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001628 continue;
1629 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1630 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 }
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001632 if (fl->fl_lmops->lm_break(fl))
Jeff Laytone084c1b2015-02-16 14:32:03 -05001633 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 }
1635
Jeff Layton8634b512015-01-16 15:05:55 -05001636 if (list_empty(&ctx->flc_lease))
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001637 goto out;
1638
Jeff Layton843c6b22014-09-01 14:27:43 -04001639 if (mode & O_NONBLOCK) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001640 trace_break_lease_noblock(inode, new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 error = -EWOULDBLOCK;
1642 goto out;
1643 }
1644
1645restart:
Jeff Layton8634b512015-01-16 15:05:55 -05001646 fl = list_first_entry(&ctx->flc_lease, struct file_lock, fl_list);
1647 break_time = fl->fl_break_time;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001648 if (break_time != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 break_time -= jiffies;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001650 if (break_time == 0)
1651 break_time++;
NeilBrownfd7732e2018-11-30 10:04:08 +11001652 locks_insert_block(fl, new_fl, leases_conflict);
Jeff Layton62af4f12014-05-09 14:13:05 -04001653 trace_break_lease_block(inode, new_fl);
Jeff Layton6109c852015-01-16 15:05:57 -05001654 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001655 percpu_up_read(&file_rwsem);
Peter Zijlstraaba37662015-06-22 14:16:33 +02001656
Jeff Laytonc45198e2014-09-01 07:12:07 -04001657 locks_dispose_list(&dispose);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001658 error = wait_event_interruptible_timeout(new_fl->fl_wait,
NeilBrownada5c1d2018-11-30 10:04:08 +11001659 !new_fl->fl_blocker, break_time);
Peter Zijlstraaba37662015-06-22 14:16:33 +02001660
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001661 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001662 spin_lock(&ctx->flc_lock);
Jeff Layton62af4f12014-05-09 14:13:05 -04001663 trace_break_lease_unblock(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001664 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 if (error >= 0) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001666 /*
1667 * Wait for the next conflicting lease that has not been
1668 * broken yet
1669 */
Jeff Layton03d12dd2014-09-01 14:53:41 -04001670 if (error == 0)
1671 time_out_leases(inode, &dispose);
1672 if (any_leases_conflict(inode, new_fl))
1673 goto restart;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 error = 0;
1675 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676out:
Jeff Layton6109c852015-01-16 15:05:57 -05001677 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001678 percpu_up_read(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001679 locks_dispose_list(&dispose);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001680 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 return error;
1682}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683EXPORT_SYMBOL(__break_lease);
1684
1685/**
Amir Goldstein76c47942018-01-03 17:14:34 +02001686 * lease_get_mtime - update modified time of an inode with exclusive lease
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687 * @inode: the inode
Amir Goldstein76c47942018-01-03 17:14:34 +02001688 * @time: pointer to a timespec which contains the last modified time
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 *
1690 * This is to force NFS clients to flush their caches for files with
1691 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001692 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001694void lease_get_mtime(struct inode *inode, struct timespec64 *time)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695{
Jeff Laytonbfe86022014-08-22 10:18:44 -04001696 bool has_lease = false;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001697 struct file_lock_context *ctx;
Jeff Layton8634b512015-01-16 15:05:55 -05001698 struct file_lock *fl;
Jeff Laytonbfe86022014-08-22 10:18:44 -04001699
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001700 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001701 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Jeff Layton6109c852015-01-16 15:05:57 -05001702 spin_lock(&ctx->flc_lock);
Geliang Tang8ace5df2015-11-18 21:40:33 +08001703 fl = list_first_entry_or_null(&ctx->flc_lease,
1704 struct file_lock, fl_list);
1705 if (fl && (fl->fl_type == F_WRLCK))
1706 has_lease = true;
Jeff Layton6109c852015-01-16 15:05:57 -05001707 spin_unlock(&ctx->flc_lock);
Jeff Laytonbfe86022014-08-22 10:18:44 -04001708 }
1709
1710 if (has_lease)
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001711 *time = current_time(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713EXPORT_SYMBOL(lease_get_mtime);
1714
1715/**
1716 * fcntl_getlease - Enquire what lease is currently active
1717 * @filp: the file
1718 *
1719 * The value returned by this function will be one of
1720 * (if no lease break is pending):
1721 *
1722 * %F_RDLCK to indicate a shared lease is held.
1723 *
1724 * %F_WRLCK to indicate an exclusive lease is held.
1725 *
1726 * %F_UNLCK to indicate no lease is held.
1727 *
1728 * (if a lease break is pending):
1729 *
1730 * %F_RDLCK to indicate an exclusive lease needs to be
1731 * changed to a shared lease (or removed).
1732 *
1733 * %F_UNLCK to indicate the lease needs to be removed.
1734 *
1735 * XXX: sfr & willy disagree over whether F_INPROGRESS
1736 * should be returned to userspace.
1737 */
1738int fcntl_getlease(struct file *filp)
1739{
1740 struct file_lock *fl;
Miklos Szeredic568d682016-09-16 12:44:20 +02001741 struct inode *inode = locks_inode(filp);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001742 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 int type = F_UNLCK;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001744 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001746 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001747 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001748 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001749 spin_lock(&ctx->flc_lock);
Miklos Szeredic568d682016-09-16 12:44:20 +02001750 time_out_leases(inode, &dispose);
Jeff Layton8634b512015-01-16 15:05:55 -05001751 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1752 if (fl->fl_file != filp)
1753 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001754 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 break;
1756 }
Jeff Layton6109c852015-01-16 15:05:57 -05001757 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001758 percpu_up_read(&file_rwsem);
Peter Zijlstra5f430862016-10-08 10:12:28 +02001759
Jeff Layton8634b512015-01-16 15:05:55 -05001760 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762 return type;
1763}
1764
Jeff Layton24cbe782014-02-03 12:13:06 -05001765/**
Amir Goldstein387e3742019-06-07 17:24:38 +03001766 * check_conflicting_open - see if the given file points to an inode that has
NeilBrown7bbd1fc2018-11-30 10:04:08 +11001767 * an existing open that would conflict with the
1768 * desired lease.
Amir Goldstein387e3742019-06-07 17:24:38 +03001769 * @filp: file to check
Jeff Layton24cbe782014-02-03 12:13:06 -05001770 * @arg: type of lease that we're trying to acquire
Randy Dunlap7fadc592015-08-09 18:43:17 -07001771 * @flags: current lock flags
Jeff Layton24cbe782014-02-03 12:13:06 -05001772 *
1773 * Check to see if there's an existing open fd on this file that would
1774 * conflict with the lease we're trying to set.
1775 */
1776static int
Amir Goldstein387e3742019-06-07 17:24:38 +03001777check_conflicting_open(struct file *filp, const long arg, int flags)
Jeff Layton24cbe782014-02-03 12:13:06 -05001778{
Amir Goldstein387e3742019-06-07 17:24:38 +03001779 struct inode *inode = locks_inode(filp);
1780 int self_wcount = 0, self_rcount = 0;
Jeff Layton24cbe782014-02-03 12:13:06 -05001781
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001782 if (flags & FL_LAYOUT)
1783 return 0;
1784
Amir Goldstein387e3742019-06-07 17:24:38 +03001785 if (arg == F_RDLCK)
1786 return inode_is_open_for_write(inode) ? -EAGAIN : 0;
1787 else if (arg != F_WRLCK)
1788 return 0;
1789
1790 /*
1791 * Make sure that only read/write count is from lease requestor.
1792 * Note that this will result in denying write leases when i_writecount
1793 * is negative, which is what we want. (We shouldn't grant write leases
1794 * on files open for execution.)
1795 */
1796 if (filp->f_mode & FMODE_WRITE)
1797 self_wcount = 1;
1798 else if (filp->f_mode & FMODE_READ)
1799 self_rcount = 1;
1800
1801 if (atomic_read(&inode->i_writecount) != self_wcount ||
1802 atomic_read(&inode->i_readcount) != self_rcount)
Jeff Layton24cbe782014-02-03 12:13:06 -05001803 return -EAGAIN;
1804
Amir Goldstein387e3742019-06-07 17:24:38 +03001805 return 0;
Jeff Layton24cbe782014-02-03 12:13:06 -05001806}
1807
Jeff Laytone6f5c782014-08-22 10:40:25 -04001808static int
1809generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810{
Jeff Layton8634b512015-01-16 15:05:55 -05001811 struct file_lock *fl, *my_fl = NULL, *lease;
Amir Goldstein387e3742019-06-07 17:24:38 +03001812 struct inode *inode = locks_inode(filp);
Jeff Layton8634b512015-01-16 15:05:55 -05001813 struct file_lock_context *ctx;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001814 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001815 int error;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001816 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817
J. Bruce Fields096657b2010-10-30 17:31:14 -04001818 lease = *flp;
Jeff Layton62af4f12014-05-09 14:13:05 -04001819 trace_generic_add_lease(inode, lease);
1820
Jeff Layton5c1c6692015-04-03 09:04:03 -04001821 /* Note that arg is never F_UNLCK here */
1822 ctx = locks_get_lock_context(inode, arg);
Jeff Layton8634b512015-01-16 15:05:55 -05001823 if (!ctx)
1824 return -ENOMEM;
1825
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001826 /*
1827 * In the delegation case we need mutual exclusion with
1828 * a number of operations that take the i_mutex. We trylock
1829 * because delegations are an optional optimization, and if
1830 * there's some chance of a conflict--we'd rather not
1831 * bother, maybe that's a sign this just isn't a good file to
1832 * hand out a delegation on.
1833 */
Al Viro59551022016-01-22 15:40:57 -05001834 if (is_deleg && !inode_trylock(inode))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001835 return -EAGAIN;
1836
1837 if (is_deleg && arg == F_WRLCK) {
1838 /* Write delegations are not currently supported: */
Al Viro59551022016-01-22 15:40:57 -05001839 inode_unlock(inode);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001840 WARN_ON_ONCE(1);
1841 return -EINVAL;
1842 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001843
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001844 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001845 spin_lock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001846 time_out_leases(inode, &dispose);
Amir Goldstein387e3742019-06-07 17:24:38 +03001847 error = check_conflicting_open(filp, arg, lease->fl_flags);
Jeff Layton24cbe782014-02-03 12:13:06 -05001848 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001849 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001850
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 /*
1852 * At this point, we know that if there is an exclusive
1853 * lease on this file, then we hold it on this filp
1854 * (otherwise our open of this file would have blocked).
1855 * And if we are trying to acquire an exclusive lease,
1856 * then the file is not open by anyone (including us)
1857 * except for this filp.
1858 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001859 error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001860 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001861 if (fl->fl_file == filp &&
1862 fl->fl_owner == lease->fl_owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001863 my_fl = fl;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001864 continue;
1865 }
Jeff Layton8634b512015-01-16 15:05:55 -05001866
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001867 /*
1868 * No exclusive leases if someone else has a lease on
1869 * this file:
1870 */
1871 if (arg == F_WRLCK)
1872 goto out;
1873 /*
1874 * Modifying our existing lease is OK, but no getting a
1875 * new lease if someone else is opening for write:
1876 */
1877 if (fl->fl_flags & FL_UNLOCK_PENDING)
1878 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879 }
1880
Jeff Layton8634b512015-01-16 15:05:55 -05001881 if (my_fl != NULL) {
Jeff Layton0164bf02015-03-04 17:34:32 -05001882 lease = my_fl;
1883 error = lease->fl_lmops->lm_change(lease, arg, &dispose);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001884 if (error)
1885 goto out;
1886 goto out_setup;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 }
1888
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 error = -EINVAL;
1890 if (!leases_enable)
1891 goto out;
1892
Jeff Laytone084c1b2015-02-16 14:32:03 -05001893 locks_insert_lock_ctx(lease, &ctx->flc_lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001894 /*
1895 * The check in break_lease() is lockless. It's possible for another
1896 * open to race in after we did the earlier check for a conflicting
1897 * open but before the lease was inserted. Check again for a
1898 * conflicting open and cancel the lease if there is one.
1899 *
1900 * We also add a barrier here to ensure that the insertion of the lock
1901 * precedes these checks.
1902 */
1903 smp_mb();
Amir Goldstein387e3742019-06-07 17:24:38 +03001904 error = check_conflicting_open(filp, arg, lease->fl_flags);
Jeff Layton8634b512015-01-16 15:05:55 -05001905 if (error) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001906 locks_unlink_lock_ctx(lease);
Jeff Layton8634b512015-01-16 15:05:55 -05001907 goto out;
1908 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001909
1910out_setup:
1911 if (lease->fl_lmops->lm_setup)
1912 lease->fl_lmops->lm_setup(lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913out:
Jeff Layton6109c852015-01-16 15:05:57 -05001914 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001915 percpu_up_read(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001916 locks_dispose_list(&dispose);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001917 if (is_deleg)
Al Viro59551022016-01-22 15:40:57 -05001918 inode_unlock(inode);
Jeff Layton8634b512015-01-16 15:05:55 -05001919 if (!error && !my_fl)
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001920 *flp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 return error;
1922}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001923
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001924static int generic_delete_lease(struct file *filp, void *owner)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001925{
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001926 int error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001927 struct file_lock *fl, *victim = NULL;
Miklos Szeredic568d682016-09-16 12:44:20 +02001928 struct inode *inode = locks_inode(filp);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001929 struct file_lock_context *ctx;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001930 LIST_HEAD(dispose);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001931
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001932 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001933 if (!ctx) {
1934 trace_generic_delete_lease(inode, NULL);
1935 return error;
1936 }
1937
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001938 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001939 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001940 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001941 if (fl->fl_file == filp &&
1942 fl->fl_owner == owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001943 victim = fl;
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001944 break;
Jeff Layton8634b512015-01-16 15:05:55 -05001945 }
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001946 }
Jeff Laytona9b1b452015-03-14 09:45:35 -04001947 trace_generic_delete_lease(inode, victim);
Jeff Layton8634b512015-01-16 15:05:55 -05001948 if (victim)
Jeff Layton7448cc32015-01-16 15:05:57 -05001949 error = fl->fl_lmops->lm_change(victim, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05001950 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001951 percpu_up_read(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001952 locks_dispose_list(&dispose);
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001953 return error;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001954}
1955
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956/**
1957 * generic_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001958 * @filp: file pointer
1959 * @arg: type of lease to obtain
1960 * @flp: input - file_lock to use, output - file_lock inserted
1961 * @priv: private data for lm_setup (may be NULL if lm_setup
1962 * doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963 *
1964 * The (input) flp->fl_lmops->lm_break function is required
1965 * by break_lease().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001967int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
1968 void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969{
Miklos Szeredic568d682016-09-16 12:44:20 +02001970 struct inode *inode = locks_inode(filp);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001971 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001973 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001974 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001976 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 error = security_file_lock(filp, arg);
1978 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001979 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001981 switch (arg) {
1982 case F_UNLCK:
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001983 return generic_delete_lease(filp, *priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001984 case F_RDLCK:
1985 case F_WRLCK:
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001986 if (!(*flp)->fl_lmops->lm_break) {
1987 WARN_ON_ONCE(1);
1988 return -ENOLCK;
1989 }
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001990
Jeff Laytone6f5c782014-08-22 10:40:25 -04001991 return generic_add_lease(filp, arg, flp, priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001992 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001993 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001996EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001998/**
Jeff Laytone51673a2014-08-22 18:13:28 -04001999 * vfs_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002000 * @filp: file pointer
2001 * @arg: type of lease to obtain
2002 * @lease: file_lock to use when adding a lease
2003 * @priv: private info for lm_setup when adding a lease (may be
NeilBrown7bbd1fc2018-11-30 10:04:08 +11002004 * NULL if lm_setup doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 *
Jeff Laytone51673a2014-08-22 18:13:28 -04002006 * Call this to establish a lease on the file. The "lease" argument is not
2007 * used for F_UNLCK requests and may be NULL. For commands that set or alter
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04002008 * an existing lease, the ``(*lease)->fl_lmops->lm_break`` operation must be
2009 * set; if not, this function will return -ENOLCK (and generate a scary-looking
Jeff Laytone51673a2014-08-22 18:13:28 -04002010 * stack trace).
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002011 *
2012 * The "priv" pointer is passed directly to the lm_setup function as-is. It
2013 * may be NULL if the lm_setup operation doesn't require it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04002015int
2016vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002018 if (filp->f_op->setlease)
Jeff Laytonf82b4b62014-08-22 18:50:48 -04002019 return filp->f_op->setlease(filp, arg, lease, priv);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002020 else
Jeff Laytonf82b4b62014-08-22 18:50:48 -04002021 return generic_setlease(filp, arg, lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04002023EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002025static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026{
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002027 struct file_lock *fl;
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002028 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 int error;
2030
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02002031 fl = lease_alloc(filp, arg);
2032 if (IS_ERR(fl))
2033 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002035 new = fasync_alloc();
2036 if (!new) {
2037 locks_free_lock(fl);
2038 return -ENOMEM;
2039 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002040 new->fa_fd = fd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002042 error = vfs_setlease(filp, arg, &fl, (void **)&new);
Jeff Layton2dfb9282014-08-11 18:14:12 -04002043 if (fl)
2044 locks_free_lock(fl);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002045 if (new)
2046 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047 return error;
2048}
2049
2050/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002051 * fcntl_setlease - sets a lease on an open file
2052 * @fd: open file descriptor
2053 * @filp: file pointer
2054 * @arg: type of lease to obtain
2055 *
2056 * Call this fcntl to establish a lease on the file.
2057 * Note that you also need to call %F_SETSIG to
2058 * receive a signal when the lease is broken.
2059 */
2060int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
2061{
2062 if (arg == F_UNLCK)
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01002063 return vfs_setlease(filp, F_UNLCK, NULL, (void **)&filp);
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002064 return do_fcntl_add_lease(fd, filp, arg);
2065}
2066
2067/**
Jeff Layton29d01b22015-07-11 06:43:02 -04002068 * flock_lock_inode_wait - Apply a FLOCK-style lock to a file
2069 * @inode: inode of the file to apply to
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070 * @fl: The lock to be applied
2071 *
Jeff Layton29d01b22015-07-11 06:43:02 -04002072 * Apply a FLOCK style lock request to an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 */
Benjamin Coddington616fb382015-10-22 13:38:15 -04002074static int flock_lock_inode_wait(struct inode *inode, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075{
2076 int error;
2077 might_sleep();
2078 for (;;) {
Jeff Layton29d01b22015-07-11 06:43:02 -04002079 error = flock_lock_inode(inode, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07002080 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11002082 error = wait_event_interruptible(fl->fl_wait, !fl->fl_blocker);
NeilBrown16306a62018-11-30 10:04:08 +11002083 if (error)
2084 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 }
NeilBrown16306a62018-11-30 10:04:08 +11002086 locks_delete_block(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 return error;
2088}
2089
Jeff Layton29d01b22015-07-11 06:43:02 -04002090/**
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04002091 * locks_lock_inode_wait - Apply a lock to an inode
2092 * @inode: inode of the file to apply to
2093 * @fl: The lock to be applied
2094 *
2095 * Apply a POSIX or FLOCK style lock request to an inode.
2096 */
2097int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
2098{
2099 int res = 0;
2100 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
2101 case FL_POSIX:
2102 res = posix_lock_inode_wait(inode, fl);
2103 break;
2104 case FL_FLOCK:
2105 res = flock_lock_inode_wait(inode, fl);
2106 break;
2107 default:
2108 BUG();
2109 }
2110 return res;
2111}
2112EXPORT_SYMBOL(locks_lock_inode_wait);
2113
2114/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 * sys_flock: - flock() system call.
2116 * @fd: the file descriptor to lock.
2117 * @cmd: the type of lock to apply.
2118 *
2119 * Apply a %FL_FLOCK style lock to an open file descriptor.
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04002120 * The @cmd can be one of:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 *
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04002122 * - %LOCK_SH -- a shared lock.
2123 * - %LOCK_EX -- an exclusive lock.
2124 * - %LOCK_UN -- remove an existing lock.
2125 * - %LOCK_MAND -- a 'mandatory' flock.
2126 * This exists to emulate Windows Share Modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127 *
2128 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
2129 * processes read and write access respectively.
2130 */
Heiko Carstens002c8972009-01-14 14:14:18 +01002131SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132{
Al Viro2903ff02012-08-28 12:52:22 -04002133 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134 struct file_lock *lock;
2135 int can_sleep, unlock;
2136 int error;
2137
2138 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04002139 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 goto out;
2141
2142 can_sleep = !(cmd & LOCK_NB);
2143 cmd &= ~LOCK_NB;
2144 unlock = (cmd == LOCK_UN);
2145
Al Viroaeb5d722008-09-02 15:28:45 -04002146 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04002147 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148 goto out_putf;
2149
NeilBrownd6367d62018-11-30 10:04:08 +11002150 lock = flock_make_lock(f.file, cmd, NULL);
Jeff Layton6e129d002014-09-04 10:25:06 -04002151 if (IS_ERR(lock)) {
2152 error = PTR_ERR(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 goto out_putf;
Jeff Layton6e129d002014-09-04 10:25:06 -04002154 }
2155
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 if (can_sleep)
2157 lock->fl_flags |= FL_SLEEP;
2158
Al Viro2903ff02012-08-28 12:52:22 -04002159 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 if (error)
2161 goto out_free;
2162
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002163 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04002164 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 (can_sleep) ? F_SETLKW : F_SETLK,
2166 lock);
2167 else
Benjamin Coddington4f656362015-10-22 13:38:14 -04002168 error = locks_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169
2170 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08002171 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172
2173 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04002174 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 out:
2176 return error;
2177}
2178
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002179/**
2180 * vfs_test_lock - test file byte range lock
2181 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04002182 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002183 *
2184 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
2185 * setting conf->fl_type to something other than F_UNLCK.
2186 */
2187int vfs_test_lock(struct file *filp, struct file_lock *fl)
2188{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002189 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002190 return filp->f_op->lock(filp, F_GETLK, fl);
2191 posix_test_lock(filp, fl);
2192 return 0;
2193}
2194EXPORT_SYMBOL_GPL(vfs_test_lock);
2195
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002196/**
2197 * locks_translate_pid - translate a file_lock's fl_pid number into a namespace
2198 * @fl: The file_lock who's fl_pid should be translated
2199 * @ns: The namespace into which the pid should be translated
2200 *
2201 * Used to tranlate a fl_pid into a namespace virtual pid number
2202 */
2203static pid_t locks_translate_pid(struct file_lock *fl, struct pid_namespace *ns)
2204{
2205 pid_t vnr;
2206 struct pid *pid;
2207
2208 if (IS_OFDLCK(fl))
2209 return -1;
2210 if (IS_REMOTELCK(fl))
2211 return fl->fl_pid;
Konstantin Khorenko826d7bc2018-06-08 17:27:11 +03002212 /*
2213 * If the flock owner process is dead and its pid has been already
2214 * freed, the translation below won't work, but we still want to show
2215 * flock owner pid number in init pidns.
2216 */
2217 if (ns == &init_pid_ns)
2218 return (pid_t)fl->fl_pid;
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002219
2220 rcu_read_lock();
2221 pid = find_pid_ns(fl->fl_pid, &init_pid_ns);
2222 vnr = pid_nr_ns(pid, ns);
2223 rcu_read_unlock();
2224 return vnr;
2225}
2226
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002227static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
2228{
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002229 flock->l_pid = locks_translate_pid(fl, task_active_pid_ns(current));
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002230#if BITS_PER_LONG == 32
2231 /*
2232 * Make sure we can represent the posix lock via
2233 * legacy 32bit flock.
2234 */
2235 if (fl->fl_start > OFFT_OFFSET_MAX)
2236 return -EOVERFLOW;
2237 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
2238 return -EOVERFLOW;
2239#endif
2240 flock->l_start = fl->fl_start;
2241 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2242 fl->fl_end - fl->fl_start + 1;
2243 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04002244 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002245 return 0;
2246}
2247
2248#if BITS_PER_LONG == 32
2249static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
2250{
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002251 flock->l_pid = locks_translate_pid(fl, task_active_pid_ns(current));
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002252 flock->l_start = fl->fl_start;
2253 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2254 fl->fl_end - fl->fl_start + 1;
2255 flock->l_whence = 0;
2256 flock->l_type = fl->fl_type;
2257}
2258#endif
2259
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260/* Report the first existing lock that would conflict with l.
2261 * This implements the F_GETLK command of fcntl().
2262 */
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002263int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264{
Benjamin Coddington52306e82017-07-16 10:28:21 -04002265 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 int error;
2267
Benjamin Coddington52306e82017-07-16 10:28:21 -04002268 fl = locks_alloc_lock();
2269 if (fl == NULL)
2270 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002272 if (flock->l_type != F_RDLCK && flock->l_type != F_WRLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273 goto out;
2274
Benjamin Coddington52306e82017-07-16 10:28:21 -04002275 error = flock_to_posix_lock(filp, fl, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 if (error)
2277 goto out;
2278
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002279 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002280 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002281 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002282 goto out;
2283
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002284 cmd = F_GETLK;
Benjamin Coddington52306e82017-07-16 10:28:21 -04002285 fl->fl_flags |= FL_OFDLCK;
2286 fl->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002287 }
2288
Benjamin Coddington52306e82017-07-16 10:28:21 -04002289 error = vfs_test_lock(filp, fl);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002290 if (error)
2291 goto out;
NeilBrown7bbd1fc2018-11-30 10:04:08 +11002292
Benjamin Coddington52306e82017-07-16 10:28:21 -04002293 flock->l_type = fl->fl_type;
2294 if (fl->fl_type != F_UNLCK) {
2295 error = posix_lock_to_flock(flock, fl);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002296 if (error)
Benjamin Coddington52306e82017-07-16 10:28:21 -04002297 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299out:
Benjamin Coddington52306e82017-07-16 10:28:21 -04002300 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 return error;
2302}
2303
Marc Eshel7723ec92007-01-18 15:08:55 -05002304/**
2305 * vfs_lock_file - file byte range lock
2306 * @filp: The file to apply the lock to
2307 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2308 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05002309 * @conf: Place to return a copy of the conflicting lock, if found.
2310 *
2311 * A caller that doesn't care about the conflicting lock may pass NULL
2312 * as the final argument.
2313 *
2314 * If the filesystem defines a private ->lock() method, then @conf will
2315 * be left unchanged; so a caller that cares should initialize it to
2316 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05002317 *
2318 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2319 * locks, the ->lock() interface may return asynchronously, before the lock has
2320 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002321 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05002322 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2323 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002324 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05002325 * request completes.
2326 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07002327 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2328 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05002329 * nonzero return code and the file system should release the lock. The file
2330 * system is also responsible to keep a corresponding posix lock when it
2331 * grants a lock so the VFS can find out which locks are locally held and do
2332 * the correct lock cleanup when required.
2333 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002334 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05002335 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05002336 */
Marc Eshel150b3932007-01-18 16:15:35 -05002337int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05002338{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002339 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05002340 return filp->f_op->lock(filp, cmd, fl);
2341 else
Marc Eshel150b3932007-01-18 16:15:35 -05002342 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05002343}
2344EXPORT_SYMBOL_GPL(vfs_lock_file);
2345
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002346static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2347 struct file_lock *fl)
2348{
2349 int error;
2350
2351 error = security_file_lock(filp, fl->fl_type);
2352 if (error)
2353 return error;
2354
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002355 for (;;) {
2356 error = vfs_lock_file(filp, cmd, fl, NULL);
2357 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002358 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11002359 error = wait_event_interruptible(fl->fl_wait, !fl->fl_blocker);
NeilBrown16306a62018-11-30 10:04:08 +11002360 if (error)
2361 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002362 }
NeilBrown16306a62018-11-30 10:04:08 +11002363 locks_delete_block(fl);
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002364
2365 return error;
2366}
2367
Benjamin Coddington6ca7d912015-10-15 09:07:07 -04002368/* Ensure that fl->fl_file has compatible f_mode for F_SETLK calls */
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002369static int
2370check_fmode_for_setlk(struct file_lock *fl)
2371{
2372 switch (fl->fl_type) {
2373 case F_RDLCK:
2374 if (!(fl->fl_file->f_mode & FMODE_READ))
2375 return -EBADF;
2376 break;
2377 case F_WRLCK:
2378 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2379 return -EBADF;
2380 }
2381 return 0;
2382}
2383
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384/* Apply the lock described by l to an open file descriptor.
2385 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2386 */
Peter Staubachc2936212005-07-27 11:45:09 -07002387int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002388 struct flock *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389{
2390 struct file_lock *file_lock = locks_alloc_lock();
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002391 struct inode *inode = locks_inode(filp);
Al Viro0b2bac22008-05-06 13:58:34 -04002392 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393 int error;
2394
2395 if (file_lock == NULL)
2396 return -ENOLCK;
2397
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398 /* Don't allow mandatory locks on files that may be memory mapped
2399 * and shared.
2400 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002401 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402 error = -EAGAIN;
2403 goto out;
2404 }
2405
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002406 error = flock_to_posix_lock(filp, file_lock, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407 if (error)
2408 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002409
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002410 error = check_fmode_for_setlk(file_lock);
2411 if (error)
2412 goto out;
2413
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002414 /*
2415 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002416 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002417 */
2418 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002419 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002420 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002421 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002422 goto out;
2423
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002424 cmd = F_SETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002425 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002426 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002427 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002428 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002429 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002430 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002431 goto out;
2432
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002433 cmd = F_SETLKW;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002434 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002435 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002436 /* Fallthrough */
2437 case F_SETLKW:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 file_lock->fl_flags |= FL_SLEEP;
2439 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002440
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002441 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442
Peter Staubachc2936212005-07-27 11:45:09 -07002443 /*
Jeff Layton0752ba82016-01-08 07:30:43 -05002444 * Attempt to detect a close/fcntl race and recover by releasing the
2445 * lock that was just acquired. There is no need to do that when we're
2446 * unlocking though, or for OFD locks.
Peter Staubachc2936212005-07-27 11:45:09 -07002447 */
Jeff Layton0752ba82016-01-08 07:30:43 -05002448 if (!error && file_lock->fl_type != F_UNLCK &&
2449 !(file_lock->fl_flags & FL_OFDLCK)) {
Jeff Layton7f3697e2016-01-07 16:38:10 -05002450 /*
2451 * We need that spin_lock here - it prevents reordering between
2452 * update of i_flctx->flc_posix and check for it done in
2453 * close(). rcu_read_lock() wouldn't do.
2454 */
2455 spin_lock(&current->files->file_lock);
2456 f = fcheck(fd);
2457 spin_unlock(&current->files->file_lock);
2458 if (f != filp) {
2459 file_lock->fl_type = F_UNLCK;
2460 error = do_lock_file_wait(filp, cmd, file_lock);
2461 WARN_ON_ONCE(error);
2462 error = -EBADF;
2463 }
Peter Staubachc2936212005-07-27 11:45:09 -07002464 }
Peter Staubachc2936212005-07-27 11:45:09 -07002465out:
Jeff Layton18909102016-01-06 21:26:10 -05002466 trace_fcntl_setlk(inode, file_lock, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467 locks_free_lock(file_lock);
2468 return error;
2469}
2470
2471#if BITS_PER_LONG == 32
2472/* Report the first existing lock that would conflict with l.
2473 * This implements the F_GETLK command of fcntl().
2474 */
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002475int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476{
Benjamin Coddington52306e82017-07-16 10:28:21 -04002477 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478 int error;
2479
Benjamin Coddington52306e82017-07-16 10:28:21 -04002480 fl = locks_alloc_lock();
2481 if (fl == NULL)
2482 return -ENOMEM;
2483
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002485 if (flock->l_type != F_RDLCK && flock->l_type != F_WRLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486 goto out;
2487
Benjamin Coddington52306e82017-07-16 10:28:21 -04002488 error = flock64_to_posix_lock(filp, fl, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489 if (error)
2490 goto out;
2491
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002492 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002493 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002494 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002495 goto out;
2496
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002497 cmd = F_GETLK64;
Benjamin Coddington52306e82017-07-16 10:28:21 -04002498 fl->fl_flags |= FL_OFDLCK;
2499 fl->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002500 }
2501
Benjamin Coddington52306e82017-07-16 10:28:21 -04002502 error = vfs_test_lock(filp, fl);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002503 if (error)
2504 goto out;
2505
Benjamin Coddington52306e82017-07-16 10:28:21 -04002506 flock->l_type = fl->fl_type;
2507 if (fl->fl_type != F_UNLCK)
2508 posix_lock_to_flock64(flock, fl);
Kinglong Meef3282962014-08-22 10:18:43 -04002509
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510out:
Benjamin Coddington52306e82017-07-16 10:28:21 -04002511 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512 return error;
2513}
2514
2515/* Apply the lock described by l to an open file descriptor.
2516 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2517 */
Peter Staubachc2936212005-07-27 11:45:09 -07002518int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002519 struct flock64 *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520{
2521 struct file_lock *file_lock = locks_alloc_lock();
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002522 struct inode *inode = locks_inode(filp);
Al Viro0b2bac22008-05-06 13:58:34 -04002523 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002524 int error;
2525
2526 if (file_lock == NULL)
2527 return -ENOLCK;
2528
Linus Torvalds1da177e2005-04-16 15:20:36 -07002529 /* Don't allow mandatory locks on files that may be memory mapped
2530 * and shared.
2531 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002532 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533 error = -EAGAIN;
2534 goto out;
2535 }
2536
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002537 error = flock64_to_posix_lock(filp, file_lock, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002538 if (error)
2539 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002540
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002541 error = check_fmode_for_setlk(file_lock);
2542 if (error)
2543 goto out;
2544
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002545 /*
2546 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002547 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002548 */
2549 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002550 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002551 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002552 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002553 goto out;
2554
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002555 cmd = F_SETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002556 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002557 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002558 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002559 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002560 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002561 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002562 goto out;
2563
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002564 cmd = F_SETLKW64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002565 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002566 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002567 /* Fallthrough */
2568 case F_SETLKW64:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569 file_lock->fl_flags |= FL_SLEEP;
2570 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002571
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002572 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573
Peter Staubachc2936212005-07-27 11:45:09 -07002574 /*
Jeff Layton0752ba82016-01-08 07:30:43 -05002575 * Attempt to detect a close/fcntl race and recover by releasing the
2576 * lock that was just acquired. There is no need to do that when we're
2577 * unlocking though, or for OFD locks.
Peter Staubachc2936212005-07-27 11:45:09 -07002578 */
Jeff Layton0752ba82016-01-08 07:30:43 -05002579 if (!error && file_lock->fl_type != F_UNLCK &&
2580 !(file_lock->fl_flags & FL_OFDLCK)) {
Jeff Layton7f3697e2016-01-07 16:38:10 -05002581 /*
2582 * We need that spin_lock here - it prevents reordering between
2583 * update of i_flctx->flc_posix and check for it done in
2584 * close(). rcu_read_lock() wouldn't do.
2585 */
2586 spin_lock(&current->files->file_lock);
2587 f = fcheck(fd);
2588 spin_unlock(&current->files->file_lock);
2589 if (f != filp) {
2590 file_lock->fl_type = F_UNLCK;
2591 error = do_lock_file_wait(filp, cmd, file_lock);
2592 WARN_ON_ONCE(error);
2593 error = -EBADF;
2594 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002596out:
2597 locks_free_lock(file_lock);
2598 return error;
2599}
2600#endif /* BITS_PER_LONG == 32 */
2601
2602/*
2603 * This function is called when the file is being removed
2604 * from the task's fd array. POSIX locks belonging to this task
2605 * are deleted at this time.
2606 */
2607void locks_remove_posix(struct file *filp, fl_owner_t owner)
2608{
Jeff Layton18909102016-01-06 21:26:10 -05002609 int error;
Miklos Szeredic568d682016-09-16 12:44:20 +02002610 struct inode *inode = locks_inode(filp);
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002611 struct file_lock lock;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002612 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613
2614 /*
2615 * If there are no locks held on this file, we don't need to call
2616 * posix_lock_file(). Another process could be setting a lock on this
2617 * file at the same time, but we wouldn't remove that lock anyway.
2618 */
Miklos Szeredic568d682016-09-16 12:44:20 +02002619 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05002620 if (!ctx || list_empty(&ctx->flc_posix))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002621 return;
2622
NeilBrownd6367d62018-11-30 10:04:08 +11002623 locks_init_lock(&lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002624 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002625 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626 lock.fl_start = 0;
2627 lock.fl_end = OFFSET_MAX;
2628 lock.fl_owner = owner;
2629 lock.fl_pid = current->tgid;
2630 lock.fl_file = filp;
2631 lock.fl_ops = NULL;
2632 lock.fl_lmops = NULL;
2633
Jeff Layton18909102016-01-06 21:26:10 -05002634 error = vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2637 lock.fl_ops->fl_release_private(&lock);
Miklos Szeredic568d682016-09-16 12:44:20 +02002638 trace_locks_remove_posix(inode, &lock, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640EXPORT_SYMBOL(locks_remove_posix);
2641
Jeff Layton3d8e5602015-01-16 15:05:58 -05002642/* The i_flctx must be valid when calling into here */
Jeff Laytondd459bb2015-01-16 15:05:54 -05002643static void
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002644locks_remove_flock(struct file *filp, struct file_lock_context *flctx)
Jeff Laytondd459bb2015-01-16 15:05:54 -05002645{
NeilBrownd6367d62018-11-30 10:04:08 +11002646 struct file_lock fl;
Miklos Szeredic568d682016-09-16 12:44:20 +02002647 struct inode *inode = locks_inode(filp);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002648
Jeff Layton3d8e5602015-01-16 15:05:58 -05002649 if (list_empty(&flctx->flc_flock))
Jeff Laytondd459bb2015-01-16 15:05:54 -05002650 return;
2651
NeilBrownd6367d62018-11-30 10:04:08 +11002652 flock_make_lock(filp, LOCK_UN, &fl);
2653 fl.fl_flags |= FL_CLOSE;
2654
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002655 if (filp->f_op->flock)
Jeff Laytondd459bb2015-01-16 15:05:54 -05002656 filp->f_op->flock(filp, F_SETLKW, &fl);
2657 else
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04002658 flock_lock_inode(inode, &fl);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002659
2660 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2661 fl.fl_ops->fl_release_private(&fl);
2662}
2663
Jeff Layton3d8e5602015-01-16 15:05:58 -05002664/* The i_flctx must be valid when calling into here */
Jeff Layton8634b512015-01-16 15:05:55 -05002665static void
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002666locks_remove_lease(struct file *filp, struct file_lock_context *ctx)
Jeff Layton8634b512015-01-16 15:05:55 -05002667{
Jeff Layton8634b512015-01-16 15:05:55 -05002668 struct file_lock *fl, *tmp;
2669 LIST_HEAD(dispose);
2670
Jeff Layton3d8e5602015-01-16 15:05:58 -05002671 if (list_empty(&ctx->flc_lease))
Jeff Layton8634b512015-01-16 15:05:55 -05002672 return;
2673
Peter Zijlstra02e525b22019-02-21 15:38:40 +01002674 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05002675 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05002676 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list)
Jeff Laytonc4e136c2015-02-16 19:37:42 -05002677 if (filp == fl->fl_file)
2678 lease_modify(fl, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05002679 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01002680 percpu_up_read(&file_rwsem);
Peter Zijlstra5f430862016-10-08 10:12:28 +02002681
Jeff Layton8634b512015-01-16 15:05:55 -05002682 locks_dispose_list(&dispose);
2683}
2684
Linus Torvalds1da177e2005-04-16 15:20:36 -07002685/*
2686 * This function is called on the last close of an open file.
2687 */
Jeff Layton78ed8a12014-02-03 12:13:08 -05002688void locks_remove_file(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002689{
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002690 struct file_lock_context *ctx;
2691
Miklos Szeredic568d682016-09-16 12:44:20 +02002692 ctx = smp_load_acquire(&locks_inode(filp)->i_flctx);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002693 if (!ctx)
Jeff Layton3d8e5602015-01-16 15:05:58 -05002694 return;
2695
Jeff Laytondd459bb2015-01-16 15:05:54 -05002696 /* remove any OFD locks */
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002697 locks_remove_posix(filp, filp);
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002698
Jeff Laytondd459bb2015-01-16 15:05:54 -05002699 /* remove flock locks */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002700 locks_remove_flock(filp, ctx);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002701
Jeff Layton8634b512015-01-16 15:05:55 -05002702 /* remove any leases */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002703 locks_remove_lease(filp, ctx);
Benjamin Coddington39537042017-07-21 13:36:25 -04002704
2705 spin_lock(&ctx->flc_lock);
2706 locks_check_ctx_file_list(filp, &ctx->flc_posix, "POSIX");
2707 locks_check_ctx_file_list(filp, &ctx->flc_flock, "FLOCK");
2708 locks_check_ctx_file_list(filp, &ctx->flc_lease, "LEASE");
2709 spin_unlock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002710}
2711
2712/**
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002713 * vfs_cancel_lock - file byte range unblock lock
2714 * @filp: The file to apply the unblock to
2715 * @fl: The lock to be unblocked
2716 *
2717 * Used by lock managers to cancel blocked requests
2718 */
2719int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2720{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002721 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002722 return filp->f_op->lock(filp, F_CANCELLK, fl);
2723 return 0;
2724}
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002725EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2726
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002727#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002728#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002729#include <linux/seq_file.h>
2730
Jeff Layton7012b022013-06-21 08:58:22 -04002731struct locks_iterator {
2732 int li_cpu;
2733 loff_t li_pos;
2734};
2735
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002736static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002737 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002738{
2739 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002740 unsigned int fl_pid;
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002741 struct pid_namespace *proc_pidns = file_inode(f->file)->i_sb->s_fs_info;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002742
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002743 fl_pid = locks_translate_pid(fl, proc_pidns);
2744 /*
Konstantin Khorenko1cf8e5d2018-06-08 17:27:12 +03002745 * If lock owner is dead (and pid is freed) or not visible in current
2746 * pidns, zero is shown as a pid value. Check lock info from
2747 * init_pid_ns to get saved lock pid value.
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002748 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002749
2750 if (fl->fl_file != NULL)
Miklos Szeredic568d682016-09-16 12:44:20 +02002751 inode = locks_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002752
Jerome Marchand99dc8292010-10-26 14:22:33 -07002753 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002754 if (IS_POSIX(fl)) {
Jeff Laytonc918d422014-02-03 12:13:09 -05002755 if (fl->fl_flags & FL_ACCESS)
Fabian Frederick5315c262014-05-09 14:13:05 -04002756 seq_puts(f, "ACCESS");
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002757 else if (IS_OFDLCK(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002758 seq_puts(f, "OFDLCK");
Jeff Laytonc918d422014-02-03 12:13:09 -05002759 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002760 seq_puts(f, "POSIX ");
Jeff Laytonc918d422014-02-03 12:13:09 -05002761
2762 seq_printf(f, " %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002763 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002764 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002765 } else if (IS_FLOCK(fl)) {
2766 if (fl->fl_type & LOCK_MAND) {
Fabian Frederick5315c262014-05-09 14:13:05 -04002767 seq_puts(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002768 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002769 seq_puts(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002770 }
2771 } else if (IS_LEASE(fl)) {
Jeff Layton8144f1f2014-08-11 13:36:54 -04002772 if (fl->fl_flags & FL_DELEG)
2773 seq_puts(f, "DELEG ");
2774 else
2775 seq_puts(f, "LEASE ");
2776
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002777 if (lease_breaking(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002778 seq_puts(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002779 else if (fl->fl_file)
Fabian Frederick5315c262014-05-09 14:13:05 -04002780 seq_puts(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002782 seq_puts(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002783 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002784 seq_puts(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002785 }
2786 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002787 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002788 (fl->fl_type & LOCK_READ)
2789 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2790 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2791 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002792 seq_printf(f, "%s ",
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002793 (lease_breaking(fl))
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04002794 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2795 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002796 }
2797 if (inode) {
Jeff Layton36488882015-04-03 09:04:04 -04002798 /* userspace relies on this representation of dev_t */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002799 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800 MAJOR(inode->i_sb->s_dev),
2801 MINOR(inode->i_sb->s_dev), inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002802 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002803 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002804 }
2805 if (IS_POSIX(fl)) {
2806 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002807 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002808 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002809 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002810 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002811 seq_puts(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002812 }
2813}
2814
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002815static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002816{
Jeff Layton7012b022013-06-21 08:58:22 -04002817 struct locks_iterator *iter = f->private;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002818 struct file_lock *fl, *bfl;
Nikolay Borisovd67fd442016-08-17 16:18:46 -04002819 struct pid_namespace *proc_pidns = file_inode(f->file)->i_sb->s_fs_info;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002820
Jeff Layton139ca042013-06-21 08:58:17 -04002821 fl = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002822
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002823 if (locks_translate_pid(fl, proc_pidns) == 0)
Nikolay Borisovd67fd442016-08-17 16:18:46 -04002824 return 0;
2825
Jeff Layton7012b022013-06-21 08:58:22 -04002826 lock_get_status(f, fl, iter->li_pos, "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002827
NeilBrownada5c1d2018-11-30 10:04:08 +11002828 list_for_each_entry(bfl, &fl->fl_blocked_requests, fl_blocked_member)
Jeff Layton7012b022013-06-21 08:58:22 -04002829 lock_get_status(f, bfl, iter->li_pos, " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002830
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002831 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002832}
2833
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002834static void __show_fd_locks(struct seq_file *f,
2835 struct list_head *head, int *id,
2836 struct file *filp, struct files_struct *files)
2837{
2838 struct file_lock *fl;
2839
2840 list_for_each_entry(fl, head, fl_list) {
2841
2842 if (filp != fl->fl_file)
2843 continue;
2844 if (fl->fl_owner != files &&
2845 fl->fl_owner != filp)
2846 continue;
2847
2848 (*id)++;
2849 seq_puts(f, "lock:\t");
2850 lock_get_status(f, fl, *id, "");
2851 }
2852}
2853
2854void show_fd_locks(struct seq_file *f,
2855 struct file *filp, struct files_struct *files)
2856{
Miklos Szeredic568d682016-09-16 12:44:20 +02002857 struct inode *inode = locks_inode(filp);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002858 struct file_lock_context *ctx;
2859 int id = 0;
2860
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002861 ctx = smp_load_acquire(&inode->i_flctx);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002862 if (!ctx)
2863 return;
2864
2865 spin_lock(&ctx->flc_lock);
2866 __show_fd_locks(f, &ctx->flc_flock, &id, filp, files);
2867 __show_fd_locks(f, &ctx->flc_posix, &id, filp, files);
2868 __show_fd_locks(f, &ctx->flc_lease, &id, filp, files);
2869 spin_unlock(&ctx->flc_lock);
2870}
2871
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002872static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002873 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002874{
Jeff Layton7012b022013-06-21 08:58:22 -04002875 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002876
Jeff Layton7012b022013-06-21 08:58:22 -04002877 iter->li_pos = *pos + 1;
Peter Zijlstraaba37662015-06-22 14:16:33 +02002878 percpu_down_write(&file_rwsem);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002879 spin_lock(&blocked_lock_lock);
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002880 return seq_hlist_start_percpu(&file_lock_list.hlist, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002881}
2882
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002883static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2884{
Jeff Layton7012b022013-06-21 08:58:22 -04002885 struct locks_iterator *iter = f->private;
2886
2887 ++iter->li_pos;
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002888 return seq_hlist_next_percpu(v, &file_lock_list.hlist, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002889}
2890
2891static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002892 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002893{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002894 spin_unlock(&blocked_lock_lock);
Peter Zijlstraaba37662015-06-22 14:16:33 +02002895 percpu_up_write(&file_rwsem);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002896}
2897
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002898static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002899 .start = locks_start,
2900 .next = locks_next,
2901 .stop = locks_stop,
2902 .show = locks_show,
2903};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002904
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002905static int __init proc_locks_init(void)
2906{
Christoph Hellwig44414d82018-04-24 17:05:17 +02002907 proc_create_seq_private("locks", 0, NULL, &locks_seq_operations,
2908 sizeof(struct locks_iterator), NULL);
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002909 return 0;
2910}
Paul Gortmaker91899222015-12-17 14:11:03 -05002911fs_initcall(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002912#endif
2913
Linus Torvalds1da177e2005-04-16 15:20:36 -07002914static int __init filelock_init(void)
2915{
Jeff Layton7012b022013-06-21 08:58:22 -04002916 int i;
2917
Jeff Layton4a075e32015-01-16 15:05:54 -05002918 flctx_cache = kmem_cache_create("file_lock_ctx",
2919 sizeof(struct file_lock_context), 0, SLAB_PANIC, NULL);
2920
Linus Torvalds1da177e2005-04-16 15:20:36 -07002921 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002922 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2923
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002924 for_each_possible_cpu(i) {
2925 struct file_lock_list_struct *fll = per_cpu_ptr(&file_lock_list, i);
2926
2927 spin_lock_init(&fll->lock);
2928 INIT_HLIST_HEAD(&fll->hlist);
2929 }
Jeff Layton7012b022013-06-21 08:58:22 -04002930
Linus Torvalds1da177e2005-04-16 15:20:36 -07002931 return 0;
2932}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002933core_initcall(filelock_init);