blob: 8af49f89ac2f0d3974972a57ff8d1164459e697c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/fs/locks.c
3 *
4 * Provide support for fcntl()'s F_GETLK, F_SETLK, and F_SETLKW calls.
5 * Doug Evans (dje@spiff.uucp), August 07, 1992
6 *
7 * Deadlock detection added.
8 * FIXME: one thing isn't handled yet:
9 * - mandatory locks (requires lots of changes elsewhere)
10 * Kelly Carmichael (kelly@[142.24.8.65]), September 17, 1994.
11 *
12 * Miscellaneous edits, and a total rewrite of posix_lock_file() code.
13 * Kai Petzke (wpp@marie.physik.tu-berlin.de), 1994
NeilBrown7bbd1fc2018-11-30 10:04:08 +110014 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 * Converted file_lock_table to a linked list from an array, which eliminates
16 * the limits on how many active file locks are open.
17 * Chad Page (pageone@netcom.com), November 27, 1994
NeilBrown7bbd1fc2018-11-30 10:04:08 +110018 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 * Removed dependency on file descriptors. dup()'ed file descriptors now
20 * get the same locks as the original file descriptors, and a close() on
21 * any file descriptor removes ALL the locks on the file for the current
22 * process. Since locks still depend on the process id, locks are inherited
23 * after an exec() but not after a fork(). This agrees with POSIX, and both
24 * BSD and SVR4 practice.
25 * Andy Walker (andy@lysaker.kvaerner.no), February 14, 1995
26 *
27 * Scrapped free list which is redundant now that we allocate locks
28 * dynamically with kmalloc()/kfree().
29 * Andy Walker (andy@lysaker.kvaerner.no), February 21, 1995
30 *
31 * Implemented two lock personalities - FL_FLOCK and FL_POSIX.
32 *
33 * FL_POSIX locks are created with calls to fcntl() and lockf() through the
34 * fcntl() system call. They have the semantics described above.
35 *
36 * FL_FLOCK locks are created with calls to flock(), through the flock()
37 * system call, which is new. Old C libraries implement flock() via fcntl()
38 * and will continue to use the old, broken implementation.
39 *
40 * FL_FLOCK locks follow the 4.4 BSD flock() semantics. They are associated
41 * with a file pointer (filp). As a result they can be shared by a parent
42 * process and its children after a fork(). They are removed when the last
43 * file descriptor referring to the file pointer is closed (unless explicitly
NeilBrown7bbd1fc2018-11-30 10:04:08 +110044 * unlocked).
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 *
46 * FL_FLOCK locks never deadlock, an existing lock is always removed before
47 * upgrading from shared to exclusive (or vice versa). When this happens
48 * any processes blocked by the current lock are woken up and allowed to
49 * run before the new lock is applied.
50 * Andy Walker (andy@lysaker.kvaerner.no), June 09, 1995
51 *
52 * Removed some race conditions in flock_lock_file(), marked other possible
NeilBrown7bbd1fc2018-11-30 10:04:08 +110053 * races. Just grep for FIXME to see them.
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 * Dmitry Gorodchanin (pgmdsg@ibi.com), February 09, 1996.
55 *
56 * Addressed Dmitry's concerns. Deadlock checking no longer recursive.
57 * Lock allocation changed to GFP_ATOMIC as we can't afford to sleep
58 * once we've checked for blocking and deadlocking.
59 * Andy Walker (andy@lysaker.kvaerner.no), April 03, 1996.
60 *
61 * Initial implementation of mandatory locks. SunOS turned out to be
62 * a rotten model, so I implemented the "obvious" semantics.
Paul Bolle395cf962011-08-15 02:02:26 +020063 * See 'Documentation/filesystems/mandatory-locking.txt' for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 * Andy Walker (andy@lysaker.kvaerner.no), April 06, 1996.
65 *
66 * Don't allow mandatory locks on mmap()'ed files. Added simple functions to
67 * check if a file has mandatory locks, used by mmap(), open() and creat() to
68 * see if system call should be rejected. Ref. HP-UX/SunOS/Solaris Reference
69 * Manual, Section 2.
70 * Andy Walker (andy@lysaker.kvaerner.no), April 09, 1996.
71 *
72 * Tidied up block list handling. Added '/proc/locks' interface.
73 * Andy Walker (andy@lysaker.kvaerner.no), April 24, 1996.
74 *
75 * Fixed deadlock condition for pathological code that mixes calls to
76 * flock() and fcntl().
77 * Andy Walker (andy@lysaker.kvaerner.no), April 29, 1996.
78 *
79 * Allow only one type of locking scheme (FL_POSIX or FL_FLOCK) to be in use
80 * for a given file at a time. Changed the CONFIG_LOCK_MANDATORY scheme to
81 * guarantee sensible behaviour in the case where file system modules might
82 * be compiled with different options than the kernel itself.
83 * Andy Walker (andy@lysaker.kvaerner.no), May 15, 1996.
84 *
85 * Added a couple of missing wake_up() calls. Thanks to Thomas Meckel
86 * (Thomas.Meckel@mni.fh-giessen.de) for spotting this.
87 * Andy Walker (andy@lysaker.kvaerner.no), May 15, 1996.
88 *
89 * Changed FL_POSIX locks to use the block list in the same way as FL_FLOCK
90 * locks. Changed process synchronisation to avoid dereferencing locks that
91 * have already been freed.
92 * Andy Walker (andy@lysaker.kvaerner.no), Sep 21, 1996.
93 *
94 * Made the block list a circular list to minimise searching in the list.
95 * Andy Walker (andy@lysaker.kvaerner.no), Sep 25, 1996.
96 *
97 * Made mandatory locking a mount option. Default is not to allow mandatory
98 * locking.
99 * Andy Walker (andy@lysaker.kvaerner.no), Oct 04, 1996.
100 *
101 * Some adaptations for NFS support.
102 * Olaf Kirch (okir@monad.swb.de), Dec 1996,
103 *
104 * Fixed /proc/locks interface so that we can't overrun the buffer we are handed.
105 * Andy Walker (andy@lysaker.kvaerner.no), May 12, 1997.
106 *
107 * Use slab allocator instead of kmalloc/kfree.
108 * Use generic list implementation from <linux/list.h>.
109 * Sped up posix_locks_deadlock by only considering blocked locks.
110 * Matthew Wilcox <willy@debian.org>, March, 2000.
111 *
112 * Leases and LOCK_MAND
113 * Matthew Wilcox <willy@debian.org>, June, 2000.
114 * Stephen Rothwell <sfr@canb.auug.org.au>, June, 2000.
NeilBrownfd7732e2018-11-30 10:04:08 +1100115 *
116 * Locking conflicts and dependencies:
117 * If multiple threads attempt to lock the same byte (or flock the same file)
118 * only one can be granted the lock, and other must wait their turn.
119 * The first lock has been "applied" or "granted", the others are "waiting"
120 * and are "blocked" by the "applied" lock..
121 *
122 * Waiting and applied locks are all kept in trees whose properties are:
123 *
124 * - the root of a tree may be an applied or waiting lock.
125 * - every other node in the tree is a waiting lock that
126 * conflicts with every ancestor of that node.
127 *
128 * Every such tree begins life as a waiting singleton which obviously
129 * satisfies the above properties.
130 *
131 * The only ways we modify trees preserve these properties:
132 *
133 * 1. We may add a new leaf node, but only after first verifying that it
134 * conflicts with all of its ancestors.
135 * 2. We may remove the root of a tree, creating a new singleton
136 * tree from the root and N new trees rooted in the immediate
137 * children.
138 * 3. If the root of a tree is not currently an applied lock, we may
139 * apply it (if possible).
140 * 4. We may upgrade the root of the tree (either extend its range,
141 * or upgrade its entire range from read to write).
142 *
143 * When an applied lock is modified in a way that reduces or downgrades any
144 * part of its range, we remove all its children (2 above). This particularly
145 * happens when a lock is unlocked.
146 *
147 * For each of those child trees we "wake up" the thread which is
148 * waiting for the lock so it can continue handling as follows: if the
149 * root of the tree applies, we do so (3). If it doesn't, it must
150 * conflict with some applied lock. We remove (wake up) all of its children
151 * (2), and add it is a new leaf to the tree rooted in the applied
152 * lock (1). We then repeat the process recursively with those
153 * children.
154 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 */
156
157#include <linux/capability.h>
158#include <linux/file.h>
Al Viro9f3acc32008-04-24 07:44:08 -0400159#include <linux/fdtable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160#include <linux/fs.h>
161#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162#include <linux/security.h>
163#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164#include <linux/syscalls.h>
165#include <linux/time.h>
Dipankar Sarma4fb3a532005-09-16 19:28:13 -0700166#include <linux/rcupdate.h>
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000167#include <linux/pid_namespace.h>
Jeff Layton48f74182013-06-21 08:58:18 -0400168#include <linux/hashtable.h>
Jeff Layton7012b022013-06-21 08:58:22 -0400169#include <linux/percpu.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Jeff Layton62af4f12014-05-09 14:13:05 -0400171#define CREATE_TRACE_POINTS
172#include <trace/events/filelock.h>
173
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -0800174#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
176#define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
177#define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
Christoph Hellwig11afe9f2015-01-21 19:17:03 +0100178#define IS_LEASE(fl) (fl->fl_flags & (FL_LEASE|FL_DELEG|FL_LAYOUT))
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400179#define IS_OFDLCK(fl) (fl->fl_flags & FL_OFDLCK)
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -0400180#define IS_REMOTELCK(fl) (fl->fl_pid <= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400182static bool lease_breaking(struct file_lock *fl)
183{
J. Bruce Fields778fc542011-07-26 18:25:49 -0400184 return fl->fl_flags & (FL_UNLOCK_PENDING | FL_DOWNGRADE_PENDING);
185}
186
187static int target_leasetype(struct file_lock *fl)
188{
189 if (fl->fl_flags & FL_UNLOCK_PENDING)
190 return F_UNLCK;
191 if (fl->fl_flags & FL_DOWNGRADE_PENDING)
192 return F_RDLCK;
193 return fl->fl_type;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400194}
195
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196int leases_enable = 1;
197int lease_break_time = 45;
198
Jeff Layton1c8c6012013-06-21 08:58:15 -0400199/*
Jeff Layton7012b022013-06-21 08:58:22 -0400200 * The global file_lock_list is only used for displaying /proc/locks, so we
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200201 * keep a list on each CPU, with each list protected by its own spinlock.
202 * Global serialization is done using file_rwsem.
203 *
204 * Note that alterations to the list also require that the relevant flc_lock is
205 * held.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400206 */
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200207struct file_lock_list_struct {
208 spinlock_t lock;
209 struct hlist_head hlist;
210};
211static DEFINE_PER_CPU(struct file_lock_list_struct, file_lock_list);
Peter Zijlstraaba37662015-06-22 14:16:33 +0200212DEFINE_STATIC_PERCPU_RWSEM(file_rwsem);
Jeff Layton88974692013-06-21 08:58:14 -0400213
Jeff Layton1c8c6012013-06-21 08:58:15 -0400214/*
Jeff Layton48f74182013-06-21 08:58:18 -0400215 * The blocked_hash is used to find POSIX lock loops for deadlock detection.
Jeff Layton7b2296a2013-06-21 08:58:20 -0400216 * It is protected by blocked_lock_lock.
Jeff Layton48f74182013-06-21 08:58:18 -0400217 *
218 * We hash locks by lockowner in order to optimize searching for the lock a
219 * particular lockowner is waiting on.
220 *
221 * FIXME: make this value scale via some heuristic? We generally will want more
222 * buckets when we have more lockowners holding locks, but that's a little
223 * difficult to determine without knowing what the workload will look like.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400224 */
Jeff Layton48f74182013-06-21 08:58:18 -0400225#define BLOCKED_HASH_BITS 7
226static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
Jeff Layton88974692013-06-21 08:58:14 -0400227
Jeff Layton1c8c6012013-06-21 08:58:15 -0400228/*
Jeff Layton7b2296a2013-06-21 08:58:20 -0400229 * This lock protects the blocked_hash. Generally, if you're accessing it, you
230 * want to be holding this lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400231 *
NeilBrownada5c1d2018-11-30 10:04:08 +1100232 * In addition, it also protects the fl->fl_blocked_requests list, and the
233 * fl->fl_blocker pointer for file_lock structures that are acting as lock
234 * requests (in contrast to those that are acting as records of acquired locks).
Jeff Layton1c8c6012013-06-21 08:58:15 -0400235 *
236 * Note that when we acquire this lock in order to change the above fields,
Jeff Layton6109c852015-01-16 15:05:57 -0500237 * we often hold the flc_lock as well. In certain cases, when reading the fields
Jeff Layton1c8c6012013-06-21 08:58:15 -0400238 * protected by this lock, we can skip acquiring it iff we already hold the
Jeff Layton6109c852015-01-16 15:05:57 -0500239 * flc_lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400240 */
Jeff Layton7b2296a2013-06-21 08:58:20 -0400241static DEFINE_SPINLOCK(blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
Jeff Layton4a075e32015-01-16 15:05:54 -0500243static struct kmem_cache *flctx_cache __read_mostly;
Christoph Lametere18b8902006-12-06 20:33:20 -0800244static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
Jeff Layton4a075e32015-01-16 15:05:54 -0500246static struct file_lock_context *
Jeff Layton5c1c6692015-04-03 09:04:03 -0400247locks_get_lock_context(struct inode *inode, int type)
Jeff Layton4a075e32015-01-16 15:05:54 -0500248{
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200249 struct file_lock_context *ctx;
Jeff Layton4a075e32015-01-16 15:05:54 -0500250
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200251 /* paired with cmpxchg() below */
252 ctx = smp_load_acquire(&inode->i_flctx);
253 if (likely(ctx) || type == F_UNLCK)
Jeff Layton4a075e32015-01-16 15:05:54 -0500254 goto out;
255
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200256 ctx = kmem_cache_alloc(flctx_cache, GFP_KERNEL);
257 if (!ctx)
Jeff Layton4a075e32015-01-16 15:05:54 -0500258 goto out;
259
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200260 spin_lock_init(&ctx->flc_lock);
261 INIT_LIST_HEAD(&ctx->flc_flock);
262 INIT_LIST_HEAD(&ctx->flc_posix);
263 INIT_LIST_HEAD(&ctx->flc_lease);
Jeff Layton4a075e32015-01-16 15:05:54 -0500264
265 /*
266 * Assign the pointer if it's not already assigned. If it is, then
267 * free the context we just allocated.
268 */
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200269 if (cmpxchg(&inode->i_flctx, NULL, ctx)) {
270 kmem_cache_free(flctx_cache, ctx);
271 ctx = smp_load_acquire(&inode->i_flctx);
272 }
Jeff Layton4a075e32015-01-16 15:05:54 -0500273out:
Jeff Layton18909102016-01-06 21:26:10 -0500274 trace_locks_get_lock_context(inode, type, ctx);
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200275 return ctx;
Jeff Layton4a075e32015-01-16 15:05:54 -0500276}
277
Jeff Laytone24dada2016-01-06 21:28:41 -0500278static void
279locks_dump_ctx_list(struct list_head *list, char *list_type)
280{
281 struct file_lock *fl;
282
283 list_for_each_entry(fl, list, fl_list) {
284 pr_warn("%s: fl_owner=%p fl_flags=0x%x fl_type=0x%x fl_pid=%u\n", list_type, fl->fl_owner, fl->fl_flags, fl->fl_type, fl->fl_pid);
285 }
286}
287
288static void
289locks_check_ctx_lists(struct inode *inode)
290{
291 struct file_lock_context *ctx = inode->i_flctx;
292
293 if (unlikely(!list_empty(&ctx->flc_flock) ||
294 !list_empty(&ctx->flc_posix) ||
295 !list_empty(&ctx->flc_lease))) {
296 pr_warn("Leaked locks on dev=0x%x:0x%x ino=0x%lx:\n",
297 MAJOR(inode->i_sb->s_dev), MINOR(inode->i_sb->s_dev),
298 inode->i_ino);
299 locks_dump_ctx_list(&ctx->flc_flock, "FLOCK");
300 locks_dump_ctx_list(&ctx->flc_posix, "POSIX");
301 locks_dump_ctx_list(&ctx->flc_lease, "LEASE");
302 }
303}
304
Benjamin Coddington39537042017-07-21 13:36:25 -0400305static void
306locks_check_ctx_file_list(struct file *filp, struct list_head *list,
307 char *list_type)
308{
309 struct file_lock *fl;
310 struct inode *inode = locks_inode(filp);
311
312 list_for_each_entry(fl, list, fl_list)
313 if (fl->fl_file == filp)
314 pr_warn("Leaked %s lock on dev=0x%x:0x%x ino=0x%lx "
315 " fl_owner=%p fl_flags=0x%x fl_type=0x%x fl_pid=%u\n",
316 list_type, MAJOR(inode->i_sb->s_dev),
317 MINOR(inode->i_sb->s_dev), inode->i_ino,
318 fl->fl_owner, fl->fl_flags, fl->fl_type, fl->fl_pid);
319}
320
Jeff Layton4a075e32015-01-16 15:05:54 -0500321void
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500322locks_free_lock_context(struct inode *inode)
Jeff Layton4a075e32015-01-16 15:05:54 -0500323{
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500324 struct file_lock_context *ctx = inode->i_flctx;
325
Jeff Laytone24dada2016-01-06 21:28:41 -0500326 if (unlikely(ctx)) {
327 locks_check_ctx_lists(inode);
Jeff Layton4a075e32015-01-16 15:05:54 -0500328 kmem_cache_free(flctx_cache, ctx);
329 }
330}
331
Miklos Szerediee19cc42011-07-07 13:06:09 +0200332static void locks_init_lock_heads(struct file_lock *fl)
Miklos Szeredia51cb912011-07-06 12:33:55 +0200333{
Jeff Layton139ca042013-06-21 08:58:17 -0400334 INIT_HLIST_NODE(&fl->fl_link);
Jeff Layton6dee60f2015-01-16 15:05:54 -0500335 INIT_LIST_HEAD(&fl->fl_list);
NeilBrownada5c1d2018-11-30 10:04:08 +1100336 INIT_LIST_HEAD(&fl->fl_blocked_requests);
337 INIT_LIST_HEAD(&fl->fl_blocked_member);
Miklos Szerediee19cc42011-07-07 13:06:09 +0200338 init_waitqueue_head(&fl->fl_wait);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200339}
340
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200342struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200344 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200345
346 if (fl)
Miklos Szerediee19cc42011-07-07 13:06:09 +0200347 locks_init_lock_heads(fl);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200348
349 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200351EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500353void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500354{
NeilBrown59264592019-04-24 12:00:08 +1000355 BUG_ON(waitqueue_active(&fl->fl_wait));
356 BUG_ON(!list_empty(&fl->fl_list));
357 BUG_ON(!list_empty(&fl->fl_blocked_requests));
358 BUG_ON(!list_empty(&fl->fl_blocked_member));
359 BUG_ON(!hlist_unhashed(&fl->fl_link));
360
Trond Myklebust47831f32006-03-20 13:44:05 -0500361 if (fl->fl_ops) {
362 if (fl->fl_ops->fl_release_private)
363 fl->fl_ops->fl_release_private(fl);
364 fl->fl_ops = NULL;
365 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500366
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400367 if (fl->fl_lmops) {
Jeff Laytoncae80b32015-04-03 09:04:04 -0400368 if (fl->fl_lmops->lm_put_owner) {
369 fl->fl_lmops->lm_put_owner(fl->fl_owner);
370 fl->fl_owner = NULL;
371 }
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400372 fl->fl_lmops = NULL;
373 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500374}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500375EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500376
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377/* Free a lock which is not in use. */
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400378void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379{
Trond Myklebust47831f32006-03-20 13:44:05 -0500380 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 kmem_cache_free(filelock_cache, fl);
382}
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400383EXPORT_SYMBOL(locks_free_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
Jeff Laytoned9814d2014-08-11 14:20:31 -0400385static void
386locks_dispose_list(struct list_head *dispose)
387{
388 struct file_lock *fl;
389
390 while (!list_empty(dispose)) {
Jeff Layton6dee60f2015-01-16 15:05:54 -0500391 fl = list_first_entry(dispose, struct file_lock, fl_list);
392 list_del_init(&fl->fl_list);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400393 locks_free_lock(fl);
394 }
395}
396
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397void locks_init_lock(struct file_lock *fl)
398{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200399 memset(fl, 0, sizeof(struct file_lock));
400 locks_init_lock_heads(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402EXPORT_SYMBOL(locks_init_lock);
403
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404/*
405 * Initialize a new lock from an existing file_lock structure.
406 */
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400407void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408{
409 new->fl_owner = fl->fl_owner;
410 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500411 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 new->fl_flags = fl->fl_flags;
413 new->fl_type = fl->fl_type;
414 new->fl_start = fl->fl_start;
415 new->fl_end = fl->fl_end;
Kinglong Meef3282962014-08-22 10:18:43 -0400416 new->fl_lmops = fl->fl_lmops;
Trond Myklebust09969052006-03-20 13:44:38 -0500417 new->fl_ops = NULL;
Kinglong Meef3282962014-08-22 10:18:43 -0400418
419 if (fl->fl_lmops) {
420 if (fl->fl_lmops->lm_get_owner)
Jeff Laytoncae80b32015-04-03 09:04:04 -0400421 fl->fl_lmops->lm_get_owner(fl->fl_owner);
Kinglong Meef3282962014-08-22 10:18:43 -0400422 }
Trond Myklebust09969052006-03-20 13:44:38 -0500423}
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400424EXPORT_SYMBOL(locks_copy_conflock);
Trond Myklebust09969052006-03-20 13:44:38 -0500425
426void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
427{
Jeff Layton566709b2014-08-11 14:09:35 -0400428 /* "new" must be a freshly-initialized lock */
429 WARN_ON_ONCE(new->fl_ops);
Trond Myklebust09969052006-03-20 13:44:38 -0500430
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400431 locks_copy_conflock(new, fl);
Kinglong Meef3282962014-08-22 10:18:43 -0400432
Trond Myklebust09969052006-03-20 13:44:38 -0500433 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 new->fl_ops = fl->fl_ops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500435
Kinglong Meef3282962014-08-22 10:18:43 -0400436 if (fl->fl_ops) {
437 if (fl->fl_ops->fl_copy_lock)
438 fl->fl_ops->fl_copy_lock(new, fl);
439 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441EXPORT_SYMBOL(locks_copy_lock);
442
NeilBrown5946c432018-11-30 10:04:08 +1100443static void locks_move_blocks(struct file_lock *new, struct file_lock *fl)
444{
445 struct file_lock *f;
446
447 /*
448 * As ctx->flc_lock is held, new requests cannot be added to
449 * ->fl_blocked_requests, so we don't need a lock to check if it
450 * is empty.
451 */
452 if (list_empty(&fl->fl_blocked_requests))
453 return;
454 spin_lock(&blocked_lock_lock);
455 list_splice_init(&fl->fl_blocked_requests, &new->fl_blocked_requests);
NeilBrownbf77ae42019-01-03 11:04:08 +1100456 list_for_each_entry(f, &new->fl_blocked_requests, fl_blocked_member)
NeilBrown5946c432018-11-30 10:04:08 +1100457 f->fl_blocker = new;
458 spin_unlock(&blocked_lock_lock);
459}
460
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461static inline int flock_translate_cmd(int cmd) {
462 if (cmd & LOCK_MAND)
463 return cmd & (LOCK_MAND | LOCK_RW);
464 switch (cmd) {
465 case LOCK_SH:
466 return F_RDLCK;
467 case LOCK_EX:
468 return F_WRLCK;
469 case LOCK_UN:
470 return F_UNLCK;
471 }
472 return -EINVAL;
473}
474
475/* Fill in a file_lock structure with an appropriate FLOCK lock. */
Jeff Layton6e129d002014-09-04 10:25:06 -0400476static struct file_lock *
NeilBrownd6367d62018-11-30 10:04:08 +1100477flock_make_lock(struct file *filp, unsigned int cmd, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 int type = flock_translate_cmd(cmd);
Jeff Layton6e129d002014-09-04 10:25:06 -0400480
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 if (type < 0)
Jeff Layton6e129d002014-09-04 10:25:06 -0400482 return ERR_PTR(type);
NeilBrown7bbd1fc2018-11-30 10:04:08 +1100483
NeilBrownd6367d62018-11-30 10:04:08 +1100484 if (fl == NULL) {
485 fl = locks_alloc_lock();
486 if (fl == NULL)
487 return ERR_PTR(-ENOMEM);
488 } else {
489 locks_init_lock(fl);
490 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491
492 fl->fl_file = filp;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +0200493 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 fl->fl_pid = current->tgid;
495 fl->fl_flags = FL_FLOCK;
496 fl->fl_type = type;
497 fl->fl_end = OFFSET_MAX;
NeilBrown7bbd1fc2018-11-30 10:04:08 +1100498
Jeff Layton6e129d002014-09-04 10:25:06 -0400499 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500}
501
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400502static int assign_type(struct file_lock *fl, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503{
504 switch (type) {
505 case F_RDLCK:
506 case F_WRLCK:
507 case F_UNLCK:
508 fl->fl_type = type;
509 break;
510 default:
511 return -EINVAL;
512 }
513 return 0;
514}
515
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500516static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
517 struct flock64 *l)
518{
519 switch (l->l_whence) {
520 case SEEK_SET:
521 fl->fl_start = 0;
522 break;
523 case SEEK_CUR:
524 fl->fl_start = filp->f_pos;
525 break;
526 case SEEK_END:
527 fl->fl_start = i_size_read(file_inode(filp));
528 break;
529 default:
530 return -EINVAL;
531 }
532 if (l->l_start > OFFSET_MAX - fl->fl_start)
533 return -EOVERFLOW;
534 fl->fl_start += l->l_start;
535 if (fl->fl_start < 0)
536 return -EINVAL;
537
538 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
539 POSIX-2001 defines it. */
540 if (l->l_len > 0) {
541 if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
542 return -EOVERFLOW;
543 fl->fl_end = fl->fl_start + l->l_len - 1;
544
545 } else if (l->l_len < 0) {
546 if (fl->fl_start + l->l_len < 0)
547 return -EINVAL;
548 fl->fl_end = fl->fl_start - 1;
549 fl->fl_start += l->l_len;
550 } else
551 fl->fl_end = OFFSET_MAX;
552
553 fl->fl_owner = current->files;
554 fl->fl_pid = current->tgid;
555 fl->fl_file = filp;
556 fl->fl_flags = FL_POSIX;
557 fl->fl_ops = NULL;
558 fl->fl_lmops = NULL;
559
560 return assign_type(fl, l->l_type);
561}
562
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
564 * style lock.
565 */
566static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
567 struct flock *l)
568{
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500569 struct flock64 ll = {
570 .l_type = l->l_type,
571 .l_whence = l->l_whence,
572 .l_start = l->l_start,
573 .l_len = l->l_len,
574 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500576 return flock64_to_posix_lock(filp, fl, &ll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577}
578
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579/* default lease lock manager operations */
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400580static bool
581lease_break_callback(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582{
583 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400584 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585}
586
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400587static void
588lease_setup(struct file_lock *fl, void **priv)
589{
590 struct file *filp = fl->fl_file;
591 struct fasync_struct *fa = *priv;
592
593 /*
594 * fasync_insert_entry() returns the old entry if any. If there was no
595 * old entry, then it used "priv" and inserted it into the fasync list.
596 * Clear the pointer to indicate that it shouldn't be freed.
597 */
598 if (!fasync_insert_entry(fa->fa_fd, filp, &fl->fl_fasync, fa))
599 *priv = NULL;
600
Eric W. Biederman01919132017-07-16 22:05:57 -0500601 __f_setown(filp, task_pid(current), PIDTYPE_TGID, 0);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400602}
603
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700604static const struct lock_manager_operations lease_manager_ops = {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400605 .lm_break = lease_break_callback,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400606 .lm_change = lease_modify,
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400607 .lm_setup = lease_setup,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608};
609
610/*
611 * Initialize a lease, use the default lock manager operations
612 */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400613static int lease_init(struct file *filp, long type, struct file_lock *fl)
Joe Perches447a5642018-03-21 15:09:32 -0700614{
Trond Myklebust75dff552006-05-07 23:02:42 -0400615 if (assign_type(fl, type) != 0)
616 return -EINVAL;
617
Jeff Layton7ca76312014-09-01 19:04:48 -0400618 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 fl->fl_pid = current->tgid;
620
621 fl->fl_file = filp;
622 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 fl->fl_start = 0;
624 fl->fl_end = OFFSET_MAX;
625 fl->fl_ops = NULL;
626 fl->fl_lmops = &lease_manager_ops;
627 return 0;
628}
629
630/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400631static struct file_lock *lease_alloc(struct file *filp, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632{
633 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400634 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
636 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500637 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
639 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400640 if (error) {
641 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500642 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400643 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500644 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645}
646
647/* Check if two locks overlap each other.
648 */
649static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
650{
651 return ((fl1->fl_end >= fl2->fl_start) &&
652 (fl2->fl_end >= fl1->fl_start));
653}
654
655/*
656 * Check whether two locks have the same owner.
657 */
Matt Mackall33443c42006-01-08 01:05:22 -0800658static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659{
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400660 if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 return fl2->fl_lmops == fl1->fl_lmops &&
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400662 fl1->fl_lmops->lm_compare_owner(fl1, fl2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 return fl1->fl_owner == fl2->fl_owner;
664}
665
Jeff Layton6109c852015-01-16 15:05:57 -0500666/* Must be called with the flc_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500667static void locks_insert_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400668{
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200669 struct file_lock_list_struct *fll = this_cpu_ptr(&file_lock_list);
670
Peter Zijlstraaba37662015-06-22 14:16:33 +0200671 percpu_rwsem_assert_held(&file_rwsem);
672
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200673 spin_lock(&fll->lock);
Jeff Layton7012b022013-06-21 08:58:22 -0400674 fl->fl_link_cpu = smp_processor_id();
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200675 hlist_add_head(&fl->fl_link, &fll->hlist);
676 spin_unlock(&fll->lock);
Jeff Layton88974692013-06-21 08:58:14 -0400677}
678
Jeff Layton6109c852015-01-16 15:05:57 -0500679/* Must be called with the flc_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500680static void locks_delete_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400681{
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200682 struct file_lock_list_struct *fll;
683
Peter Zijlstraaba37662015-06-22 14:16:33 +0200684 percpu_rwsem_assert_held(&file_rwsem);
685
Jeff Layton7012b022013-06-21 08:58:22 -0400686 /*
687 * Avoid taking lock if already unhashed. This is safe since this check
Jeff Layton6109c852015-01-16 15:05:57 -0500688 * is done while holding the flc_lock, and new insertions into the list
Jeff Layton7012b022013-06-21 08:58:22 -0400689 * also require that it be held.
690 */
691 if (hlist_unhashed(&fl->fl_link))
692 return;
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200693
694 fll = per_cpu_ptr(&file_lock_list, fl->fl_link_cpu);
695 spin_lock(&fll->lock);
Jeff Layton139ca042013-06-21 08:58:17 -0400696 hlist_del_init(&fl->fl_link);
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200697 spin_unlock(&fll->lock);
Jeff Layton88974692013-06-21 08:58:14 -0400698}
699
Jeff Layton3999e492013-06-21 08:58:19 -0400700static unsigned long
701posix_owner_key(struct file_lock *fl)
702{
703 if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
704 return fl->fl_lmops->lm_owner_key(fl);
705 return (unsigned long)fl->fl_owner;
706}
707
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500708static void locks_insert_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400709{
Daniel Wagner663d5af2015-04-03 09:04:03 -0400710 lockdep_assert_held(&blocked_lock_lock);
711
Jeff Layton3999e492013-06-21 08:58:19 -0400712 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
Jeff Layton88974692013-06-21 08:58:14 -0400713}
714
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500715static void locks_delete_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400716{
Daniel Wagner663d5af2015-04-03 09:04:03 -0400717 lockdep_assert_held(&blocked_lock_lock);
718
Jeff Layton48f74182013-06-21 08:58:18 -0400719 hash_del(&waiter->fl_link);
Jeff Layton88974692013-06-21 08:58:14 -0400720}
721
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722/* Remove waiter from blocker's block list.
723 * When blocker ends up pointing to itself then the list is empty.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400724 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400725 * Must be called with blocked_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 */
Matt Mackall33443c42006-01-08 01:05:22 -0800727static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728{
Jeff Layton88974692013-06-21 08:58:14 -0400729 locks_delete_global_blocked(waiter);
NeilBrownada5c1d2018-11-30 10:04:08 +1100730 list_del_init(&waiter->fl_blocked_member);
731 waiter->fl_blocker = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732}
733
NeilBrownad6bbd82018-11-30 10:04:08 +1100734static void __locks_wake_up_blocks(struct file_lock *blocker)
735{
736 while (!list_empty(&blocker->fl_blocked_requests)) {
737 struct file_lock *waiter;
738
739 waiter = list_first_entry(&blocker->fl_blocked_requests,
740 struct file_lock, fl_blocked_member);
741 __locks_delete_block(waiter);
742 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
743 waiter->fl_lmops->lm_notify(waiter);
744 else
745 wake_up(&waiter->fl_wait);
746 }
747}
748
NeilBrowncb03f942018-11-30 10:04:08 +1100749/**
750 * locks_delete_lock - stop waiting for a file lock
751 * @waiter: the lock which was waiting
752 *
753 * lockd/nfsd need to disconnect the lock while working on it.
754 */
755int locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756{
NeilBrowncb03f942018-11-30 10:04:08 +1100757 int status = -ENOENT;
758
NeilBrown16306a62018-11-30 10:04:08 +1100759 /*
760 * If fl_blocker is NULL, it won't be set again as this thread
761 * "owns" the lock and is the only one that might try to claim
762 * the lock. So it is safe to test fl_blocker locklessly.
763 * Also if fl_blocker is NULL, this waiter is not listed on
764 * fl_blocked_requests for some lock, so no other request can
765 * be added to the list of fl_blocked_requests for this
766 * request. So if fl_blocker is NULL, it is safe to
767 * locklessly check if fl_blocked_requests is empty. If both
768 * of these checks succeed, there is no need to take the lock.
769 */
770 if (waiter->fl_blocker == NULL &&
771 list_empty(&waiter->fl_blocked_requests))
NeilBrowncb03f942018-11-30 10:04:08 +1100772 return status;
Jeff Layton7b2296a2013-06-21 08:58:20 -0400773 spin_lock(&blocked_lock_lock);
NeilBrowncb03f942018-11-30 10:04:08 +1100774 if (waiter->fl_blocker)
775 status = 0;
NeilBrown5946c432018-11-30 10:04:08 +1100776 __locks_wake_up_blocks(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 __locks_delete_block(waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400778 spin_unlock(&blocked_lock_lock);
NeilBrowncb03f942018-11-30 10:04:08 +1100779 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780}
NeilBrowncb03f942018-11-30 10:04:08 +1100781EXPORT_SYMBOL(locks_delete_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
783/* Insert waiter into blocker's block list.
784 * We use a circular list so that processes can be easily woken up in
785 * the order they blocked. The documentation doesn't require this but
786 * it seems like the reasonable thing to do.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400787 *
Jeff Layton6109c852015-01-16 15:05:57 -0500788 * Must be called with both the flc_lock and blocked_lock_lock held. The
NeilBrownada5c1d2018-11-30 10:04:08 +1100789 * fl_blocked_requests list itself is protected by the blocked_lock_lock,
790 * but by ensuring that the flc_lock is also held on insertions we can avoid
791 * taking the blocked_lock_lock in some cases when we see that the
792 * fl_blocked_requests list is empty.
NeilBrownfd7732e2018-11-30 10:04:08 +1100793 *
794 * Rather than just adding to the list, we check for conflicts with any existing
795 * waiters, and add beneath any waiter that blocks the new waiter.
796 * Thus wakeups don't happen until needed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400798static void __locks_insert_block(struct file_lock *blocker,
NeilBrownfd7732e2018-11-30 10:04:08 +1100799 struct file_lock *waiter,
800 bool conflict(struct file_lock *,
801 struct file_lock *))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802{
NeilBrownfd7732e2018-11-30 10:04:08 +1100803 struct file_lock *fl;
NeilBrownada5c1d2018-11-30 10:04:08 +1100804 BUG_ON(!list_empty(&waiter->fl_blocked_member));
NeilBrownfd7732e2018-11-30 10:04:08 +1100805
806new_blocker:
807 list_for_each_entry(fl, &blocker->fl_blocked_requests, fl_blocked_member)
808 if (conflict(fl, waiter)) {
809 blocker = fl;
810 goto new_blocker;
811 }
NeilBrownada5c1d2018-11-30 10:04:08 +1100812 waiter->fl_blocker = blocker;
813 list_add_tail(&waiter->fl_blocked_member, &blocker->fl_blocked_requests);
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400814 if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400815 locks_insert_global_blocked(waiter);
NeilBrown5946c432018-11-30 10:04:08 +1100816
817 /* The requests in waiter->fl_blocked are known to conflict with
818 * waiter, but might not conflict with blocker, or the requests
819 * and lock which block it. So they all need to be woken.
820 */
821 __locks_wake_up_blocks(waiter);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400822}
823
Jeff Layton6109c852015-01-16 15:05:57 -0500824/* Must be called with flc_lock held. */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400825static void locks_insert_block(struct file_lock *blocker,
NeilBrownfd7732e2018-11-30 10:04:08 +1100826 struct file_lock *waiter,
827 bool conflict(struct file_lock *,
828 struct file_lock *))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400829{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400830 spin_lock(&blocked_lock_lock);
NeilBrownfd7732e2018-11-30 10:04:08 +1100831 __locks_insert_block(blocker, waiter, conflict);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400832 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833}
834
Jeff Layton1cb36012013-06-21 08:58:12 -0400835/*
836 * Wake up processes blocked waiting for blocker.
837 *
Jeff Layton6109c852015-01-16 15:05:57 -0500838 * Must be called with the inode->flc_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 */
840static void locks_wake_up_blocks(struct file_lock *blocker)
841{
Jeff Layton4e8c7652013-06-21 08:58:16 -0400842 /*
843 * Avoid taking global lock if list is empty. This is safe since new
Jeff Layton6109c852015-01-16 15:05:57 -0500844 * blocked requests are only added to the list under the flc_lock, and
NeilBrownada5c1d2018-11-30 10:04:08 +1100845 * the flc_lock is always held here. Note that removal from the
846 * fl_blocked_requests list does not require the flc_lock, so we must
847 * recheck list_empty() after acquiring the blocked_lock_lock.
Jeff Layton4e8c7652013-06-21 08:58:16 -0400848 */
NeilBrownada5c1d2018-11-30 10:04:08 +1100849 if (list_empty(&blocker->fl_blocked_requests))
Jeff Layton4e8c7652013-06-21 08:58:16 -0400850 return;
851
Jeff Layton7b2296a2013-06-21 08:58:20 -0400852 spin_lock(&blocked_lock_lock);
NeilBrownad6bbd82018-11-30 10:04:08 +1100853 __locks_wake_up_blocks(blocker);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400854 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855}
856
Jeff Layton5263e312015-01-16 15:05:55 -0500857static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500858locks_insert_lock_ctx(struct file_lock *fl, struct list_head *before)
Jeff Layton5263e312015-01-16 15:05:55 -0500859{
Jeff Layton5263e312015-01-16 15:05:55 -0500860 list_add_tail(&fl->fl_list, before);
861 locks_insert_global_locks(fl);
862}
863
Jeff Layton8634b512015-01-16 15:05:55 -0500864static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500865locks_unlink_lock_ctx(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866{
Jeff Layton88974692013-06-21 08:58:14 -0400867 locks_delete_global_locks(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500868 list_del_init(&fl->fl_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 locks_wake_up_blocks(fl);
Jeff Layton24cbe782014-02-03 12:13:06 -0500870}
871
Jeff Layton5263e312015-01-16 15:05:55 -0500872static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500873locks_delete_lock_ctx(struct file_lock *fl, struct list_head *dispose)
Jeff Layton5263e312015-01-16 15:05:55 -0500874{
Jeff Laytone084c1b2015-02-16 14:32:03 -0500875 locks_unlink_lock_ctx(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500876 if (dispose)
877 list_add(&fl->fl_list, dispose);
878 else
879 locks_free_lock(fl);
Jeff Layton5263e312015-01-16 15:05:55 -0500880}
881
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
883 * checks for shared/exclusive status of overlapping locks.
884 */
NeilBrownc0e15902018-11-30 10:04:08 +1100885static bool locks_conflict(struct file_lock *caller_fl,
886 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887{
888 if (sys_fl->fl_type == F_WRLCK)
NeilBrownc0e15902018-11-30 10:04:08 +1100889 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 if (caller_fl->fl_type == F_WRLCK)
NeilBrownc0e15902018-11-30 10:04:08 +1100891 return true;
892 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893}
894
895/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
896 * checking before calling the locks_conflict().
897 */
NeilBrownc0e15902018-11-30 10:04:08 +1100898static bool posix_locks_conflict(struct file_lock *caller_fl,
899 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900{
901 /* POSIX locks owned by the same process do not conflict with
902 * each other.
903 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400904 if (posix_same_owner(caller_fl, sys_fl))
NeilBrownc0e15902018-11-30 10:04:08 +1100905 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906
907 /* Check whether they overlap */
908 if (!locks_overlap(caller_fl, sys_fl))
NeilBrownc0e15902018-11-30 10:04:08 +1100909 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910
NeilBrownc0e15902018-11-30 10:04:08 +1100911 return locks_conflict(caller_fl, sys_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912}
913
914/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
915 * checking before calling the locks_conflict().
916 */
NeilBrownc0e15902018-11-30 10:04:08 +1100917static bool flock_locks_conflict(struct file_lock *caller_fl,
918 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919{
920 /* FLOCK locks referring to the same filp do not conflict with
921 * each other.
922 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400923 if (caller_fl->fl_file == sys_fl->fl_file)
NeilBrownc0e15902018-11-30 10:04:08 +1100924 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
NeilBrownc0e15902018-11-30 10:04:08 +1100926 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927
NeilBrownc0e15902018-11-30 10:04:08 +1100928 return locks_conflict(caller_fl, sys_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929}
930
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400931void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500932posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933{
934 struct file_lock *cfl;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500935 struct file_lock_context *ctx;
Miklos Szeredic568d682016-09-16 12:44:20 +0200936 struct inode *inode = locks_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200938 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500939 if (!ctx || list_empty_careful(&ctx->flc_posix)) {
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400940 fl->fl_type = F_UNLCK;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500941 return;
942 }
943
Jeff Layton6109c852015-01-16 15:05:57 -0500944 spin_lock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500945 list_for_each_entry(cfl, &ctx->flc_posix, fl_list) {
946 if (posix_locks_conflict(fl, cfl)) {
947 locks_copy_conflock(fl, cfl);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500948 goto out;
949 }
950 }
951 fl->fl_type = F_UNLCK;
952out:
Jeff Layton6109c852015-01-16 15:05:57 -0500953 spin_unlock(&ctx->flc_lock);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400954 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956EXPORT_SYMBOL(posix_test_lock);
957
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400958/*
959 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400961 * We attempt to detect deadlocks that are due purely to posix file
962 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400964 * We assume that a task can be waiting for at most one lock at a time.
965 * So for any acquired lock, the process holding that lock may be
966 * waiting on at most one other lock. That lock in turns may be held by
967 * someone waiting for at most one other lock. Given a requested lock
968 * caller_fl which is about to wait for a conflicting lock block_fl, we
969 * follow this chain of waiters to ensure we are not about to create a
970 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400971 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400972 * Since we do this before we ever put a process to sleep on a lock, we
973 * are ensured that there is never a cycle; that is what guarantees that
974 * the while() loop in posix_locks_deadlock() eventually completes.
975 *
976 * Note: the above assumption may not be true when handling lock
977 * requests from a broken NFS client. It may also fail in the presence
978 * of tasks (such as posix threads) sharing the same open file table.
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400979 * To handle those cases, we just bail out after a few iterations.
Jeff Layton57b65322014-02-03 12:13:09 -0500980 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400981 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
Jeff Layton57b65322014-02-03 12:13:09 -0500982 * Because the owner is not even nominally tied to a thread of
983 * execution, the deadlock detection below can't reasonably work well. Just
984 * skip it for those.
985 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400986 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
Jeff Layton57b65322014-02-03 12:13:09 -0500987 * locks that just checks for the case where two tasks are attempting to
988 * upgrade from read to write locks on the same inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400990
991#define MAX_DEADLK_ITERATIONS 10
992
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400993/* Find a lock that the owner of the given block_fl is blocking on. */
994static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
995{
996 struct file_lock *fl;
997
Jeff Layton3999e492013-06-21 08:58:19 -0400998 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
NeilBrown5946c432018-11-30 10:04:08 +1100999 if (posix_same_owner(fl, block_fl)) {
1000 while (fl->fl_blocker)
1001 fl = fl->fl_blocker;
1002 return fl;
1003 }
J. Bruce Fieldsb5331842007-10-26 18:05:40 -04001004 }
1005 return NULL;
1006}
1007
Jeff Layton7b2296a2013-06-21 08:58:20 -04001008/* Must be called with the blocked_lock_lock held! */
Adrian Bunkb0904e12006-06-23 02:05:13 -07001009static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 struct file_lock *block_fl)
1011{
J. Bruce Fields97855b42007-10-30 11:20:02 -04001012 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013
Daniel Wagner663d5af2015-04-03 09:04:03 -04001014 lockdep_assert_held(&blocked_lock_lock);
1015
Jeff Layton57b65322014-02-03 12:13:09 -05001016 /*
1017 * This deadlock detector can't reasonably detect deadlocks with
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001018 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
Jeff Layton57b65322014-02-03 12:13:09 -05001019 */
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001020 if (IS_OFDLCK(caller_fl))
Jeff Layton57b65322014-02-03 12:13:09 -05001021 return 0;
1022
J. Bruce Fieldsb5331842007-10-26 18:05:40 -04001023 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
1024 if (i++ > MAX_DEADLK_ITERATIONS)
1025 return 0;
1026 if (posix_same_owner(caller_fl, block_fl))
1027 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 }
1029 return 0;
1030}
1031
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -04001033 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -04001034 *
1035 * Note that if called with an FL_EXISTS argument, the caller may determine
1036 * whether or not a lock was successfully freed by testing the return
1037 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 */
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04001039static int flock_lock_inode(struct inode *inode, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040{
Trond Myklebust993dfa82006-03-31 02:30:55 -08001041 struct file_lock *new_fl = NULL;
Jeff Layton5263e312015-01-16 15:05:55 -05001042 struct file_lock *fl;
1043 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 int error = 0;
Jeff Layton5263e312015-01-16 15:05:55 -05001045 bool found = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -04001046 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047
Jeff Layton5c1c6692015-04-03 09:04:03 -04001048 ctx = locks_get_lock_context(inode, request->fl_type);
1049 if (!ctx) {
1050 if (request->fl_type != F_UNLCK)
1051 return -ENOMEM;
1052 return (request->fl_flags & FL_EXISTS) ? -ENOENT : 0;
1053 }
Jeff Layton5263e312015-01-16 15:05:55 -05001054
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001055 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
1056 new_fl = locks_alloc_lock();
1057 if (!new_fl)
1058 return -ENOMEM;
1059 }
1060
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001061 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001062 spin_lock(&ctx->flc_lock);
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001063 if (request->fl_flags & FL_ACCESS)
1064 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +04001065
Jeff Layton5263e312015-01-16 15:05:55 -05001066 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04001067 if (request->fl_file != fl->fl_file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001069 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 goto out;
Jeff Layton5263e312015-01-16 15:05:55 -05001071 found = true;
Jeff Laytone084c1b2015-02-16 14:32:03 -05001072 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 break;
1074 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075
Trond Myklebustf475ae92006-06-29 16:38:32 -04001076 if (request->fl_type == F_UNLCK) {
1077 if ((request->fl_flags & FL_EXISTS) && !found)
1078 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001079 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001080 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001082find_conflict:
Jeff Layton5263e312015-01-16 15:05:55 -05001083 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Trond Myklebust993dfa82006-03-31 02:30:55 -08001084 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 continue;
1086 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -07001087 if (!(request->fl_flags & FL_SLEEP))
1088 goto out;
1089 error = FILE_LOCK_DEFERRED;
NeilBrownfd7732e2018-11-30 10:04:08 +11001090 locks_insert_block(fl, request, flock_locks_conflict);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 goto out;
1092 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001093 if (request->fl_flags & FL_ACCESS)
1094 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001095 locks_copy_lock(new_fl, request);
NeilBrown5946c432018-11-30 10:04:08 +11001096 locks_move_blocks(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001097 locks_insert_lock_ctx(new_fl, &ctx->flc_flock);
Trond Myklebust993dfa82006-03-31 02:30:55 -08001098 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +04001099 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100
1101out:
Jeff Layton6109c852015-01-16 15:05:57 -05001102 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001103 percpu_up_read(&file_rwsem);
Trond Myklebust993dfa82006-03-31 02:30:55 -08001104 if (new_fl)
1105 locks_free_lock(new_fl);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001106 locks_dispose_list(&dispose);
Jeff Laytonc883da32018-07-30 07:54:56 -04001107 trace_flock_lock_inode(inode, request, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 return error;
1109}
1110
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001111static int posix_lock_inode(struct inode *inode, struct file_lock *request,
1112 struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001114 struct file_lock *fl, *tmp;
Miklos Szeredi39005d02006-06-23 02:05:10 -07001115 struct file_lock *new_fl = NULL;
1116 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 struct file_lock *left = NULL;
1118 struct file_lock *right = NULL;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001119 struct file_lock_context *ctx;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001120 int error;
1121 bool added = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -04001122 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123
Jeff Layton5c1c6692015-04-03 09:04:03 -04001124 ctx = locks_get_lock_context(inode, request->fl_type);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001125 if (!ctx)
Jeff Layton5c1c6692015-04-03 09:04:03 -04001126 return (request->fl_type == F_UNLCK) ? 0 : -ENOMEM;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001127
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 /*
1129 * We may need two file_lock structures for this operation,
1130 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -07001131 *
1132 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 */
Miklos Szeredi39005d02006-06-23 02:05:10 -07001134 if (!(request->fl_flags & FL_ACCESS) &&
1135 (request->fl_type != F_UNLCK ||
1136 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
1137 new_fl = locks_alloc_lock();
1138 new_fl2 = locks_alloc_lock();
1139 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001141 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001142 spin_lock(&ctx->flc_lock);
Jeff Layton1cb36012013-06-21 08:58:12 -04001143 /*
1144 * New lock request. Walk all POSIX locks and look for conflicts. If
1145 * there are any, either return error or put the request on the
Jeff Layton48f74182013-06-21 08:58:18 -04001146 * blocker's list of waiters and the global blocked_hash.
Jeff Layton1cb36012013-06-21 08:58:12 -04001147 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148 if (request->fl_type != F_UNLCK) {
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001149 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 if (!posix_locks_conflict(request, fl))
1151 continue;
Andy Adamson5842add2006-03-26 01:37:26 -08001152 if (conflock)
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001153 locks_copy_conflock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 error = -EAGAIN;
1155 if (!(request->fl_flags & FL_SLEEP))
1156 goto out;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001157 /*
1158 * Deadlock detection and insertion into the blocked
1159 * locks list must be done while holding the same lock!
1160 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161 error = -EDEADLK;
Jeff Layton7b2296a2013-06-21 08:58:20 -04001162 spin_lock(&blocked_lock_lock);
Jeff Layton945ab8f2019-03-25 08:15:14 -04001163 /*
1164 * Ensure that we don't find any locks blocked on this
1165 * request during deadlock detection.
1166 */
1167 __locks_wake_up_blocks(request);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001168 if (likely(!posix_locks_deadlock(request, fl))) {
1169 error = FILE_LOCK_DEFERRED;
NeilBrownfd7732e2018-11-30 10:04:08 +11001170 __locks_insert_block(fl, request,
1171 posix_locks_conflict);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001172 }
Jeff Layton7b2296a2013-06-21 08:58:20 -04001173 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 goto out;
NeilBrown7bbd1fc2018-11-30 10:04:08 +11001175 }
1176 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177
1178 /* If we're just looking for a conflict, we're done. */
1179 error = 0;
1180 if (request->fl_flags & FL_ACCESS)
1181 goto out;
1182
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001183 /* Find the first old lock with the same owner as the new lock */
1184 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1185 if (posix_same_owner(request, fl))
1186 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 }
1188
Jeff Layton1cb36012013-06-21 08:58:12 -04001189 /* Process locks with this owner. */
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001190 list_for_each_entry_safe_from(fl, tmp, &ctx->flc_posix, fl_list) {
1191 if (!posix_same_owner(request, fl))
1192 break;
1193
1194 /* Detect adjacent or overlapping regions (if same lock type) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -07001196 /* In all comparisons of start vs end, use
1197 * "start - 1" rather than "end + 1". If end
1198 * is OFFSET_MAX, end + 1 will become negative.
1199 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 if (fl->fl_end < request->fl_start - 1)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001201 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 /* If the next lock in the list has entirely bigger
1203 * addresses than the new one, insert the lock here.
1204 */
Olaf Kirch449231d2005-08-25 16:25:35 -07001205 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 break;
1207
1208 /* If we come here, the new and old lock are of the
1209 * same type and adjacent or overlapping. Make one
1210 * lock yielding from the lower start address of both
1211 * locks to the higher end address.
1212 */
1213 if (fl->fl_start > request->fl_start)
1214 fl->fl_start = request->fl_start;
1215 else
1216 request->fl_start = fl->fl_start;
1217 if (fl->fl_end < request->fl_end)
1218 fl->fl_end = request->fl_end;
1219 else
1220 request->fl_end = fl->fl_end;
1221 if (added) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001222 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 continue;
1224 }
1225 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001226 added = true;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001227 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 /* Processing for different lock types is a bit
1229 * more complex.
1230 */
1231 if (fl->fl_end < request->fl_start)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001232 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 if (fl->fl_start > request->fl_end)
1234 break;
1235 if (request->fl_type == F_UNLCK)
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001236 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 if (fl->fl_start < request->fl_start)
1238 left = fl;
1239 /* If the next lock in the list has a higher end
1240 * address than the new one, insert the new one here.
1241 */
1242 if (fl->fl_end > request->fl_end) {
1243 right = fl;
1244 break;
1245 }
1246 if (fl->fl_start >= request->fl_start) {
1247 /* The new lock completely replaces an old
1248 * one (This may happen several times).
1249 */
1250 if (added) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001251 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 continue;
1253 }
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001254 /*
1255 * Replace the old lock with new_fl, and
1256 * remove the old one. It's safe to do the
1257 * insert here since we know that we won't be
1258 * using new_fl later, and that the lock is
1259 * just replacing an existing lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 */
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001261 error = -ENOLCK;
1262 if (!new_fl)
1263 goto out;
1264 locks_copy_lock(new_fl, request);
1265 request = new_fl;
1266 new_fl = NULL;
Jeff Laytone084c1b2015-02-16 14:32:03 -05001267 locks_insert_lock_ctx(request, &fl->fl_list);
1268 locks_delete_lock_ctx(fl, &dispose);
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001269 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 }
1271 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 }
1273
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001274 /*
Jeff Layton1cb36012013-06-21 08:58:12 -04001275 * The above code only modifies existing locks in case of merging or
1276 * replacing. If new lock(s) need to be inserted all modifications are
1277 * done below this, so it's safe yet to bail out.
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001278 */
1279 error = -ENOLCK; /* "no luck" */
1280 if (right && left == right && !new_fl2)
1281 goto out;
1282
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 error = 0;
1284 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -04001285 if (request->fl_type == F_UNLCK) {
1286 if (request->fl_flags & FL_EXISTS)
1287 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001289 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001290
1291 if (!new_fl) {
1292 error = -ENOLCK;
1293 goto out;
1294 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 locks_copy_lock(new_fl, request);
NeilBrown5946c432018-11-30 10:04:08 +11001296 locks_move_blocks(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001297 locks_insert_lock_ctx(new_fl, &fl->fl_list);
Jeff Layton2e2f756f2015-02-17 17:08:23 -05001298 fl = new_fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 new_fl = NULL;
1300 }
1301 if (right) {
1302 if (left == right) {
1303 /* The new lock breaks the old one in two pieces,
1304 * so we have to use the second new lock.
1305 */
1306 left = new_fl2;
1307 new_fl2 = NULL;
1308 locks_copy_lock(left, right);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001309 locks_insert_lock_ctx(left, &fl->fl_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310 }
1311 right->fl_start = request->fl_end + 1;
1312 locks_wake_up_blocks(right);
1313 }
1314 if (left) {
1315 left->fl_end = request->fl_start - 1;
1316 locks_wake_up_blocks(left);
1317 }
1318 out:
Jeff Layton6109c852015-01-16 15:05:57 -05001319 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001320 percpu_up_read(&file_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 /*
1322 * Free any unused locks.
1323 */
1324 if (new_fl)
1325 locks_free_lock(new_fl);
1326 if (new_fl2)
1327 locks_free_lock(new_fl2);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001328 locks_dispose_list(&dispose);
Jeff Layton18909102016-01-06 21:26:10 -05001329 trace_posix_lock_inode(inode, request, error);
1330
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 return error;
1332}
1333
1334/**
1335 * posix_lock_file - Apply a POSIX-style lock to a file
1336 * @filp: The file to apply the lock to
1337 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001338 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 *
1340 * Add a POSIX style lock to a file.
1341 * We merge adjacent & overlapping locks whenever possible.
1342 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001343 *
1344 * Note that if called with an FL_EXISTS argument, the caller may determine
1345 * whether or not a lock was successfully freed by testing the return
1346 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 */
Marc Eshel150b3932007-01-18 16:15:35 -05001348int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001349 struct file_lock *conflock)
1350{
Miklos Szeredic568d682016-09-16 12:44:20 +02001351 return posix_lock_inode(locks_inode(filp), fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001352}
Marc Eshel150b3932007-01-18 16:15:35 -05001353EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354
1355/**
Jeff Layton29d01b22015-07-11 06:43:02 -04001356 * posix_lock_inode_wait - Apply a POSIX-style lock to a file
1357 * @inode: inode of file to which lock request should be applied
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 * @fl: The lock to be applied
1359 *
Benjamin Coddington616fb382015-10-22 13:38:15 -04001360 * Apply a POSIX style lock request to an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 */
Benjamin Coddington616fb382015-10-22 13:38:15 -04001362static int posix_lock_inode_wait(struct inode *inode, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363{
1364 int error;
1365 might_sleep ();
1366 for (;;) {
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001367 error = posix_lock_inode(inode, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001368 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11001370 error = wait_event_interruptible(fl->fl_wait, !fl->fl_blocker);
NeilBrown16306a62018-11-30 10:04:08 +11001371 if (error)
1372 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 }
NeilBrown16306a62018-11-30 10:04:08 +11001374 locks_delete_block(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375 return error;
1376}
Jeff Layton29d01b22015-07-11 06:43:02 -04001377
Jeff Layton9e8925b2015-11-16 09:49:34 -05001378#ifdef CONFIG_MANDATORY_FILE_LOCKING
Jeff Layton29d01b22015-07-11 06:43:02 -04001379/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 * locks_mandatory_locked - Check for an active lock
Jeff Laytond7a06982014-03-10 09:54:15 -04001381 * @file: the file to check
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 *
1383 * Searches the inode's list of locks to find any POSIX locks which conflict.
1384 * This function is called from locks_verify_locked() only.
1385 */
Jeff Laytond7a06982014-03-10 09:54:15 -04001386int locks_mandatory_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001388 int ret;
Miklos Szeredic568d682016-09-16 12:44:20 +02001389 struct inode *inode = locks_inode(file);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001390 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 struct file_lock *fl;
1392
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001393 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001394 if (!ctx || list_empty_careful(&ctx->flc_posix))
1395 return 0;
1396
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 /*
1398 * Search the lock list for this inode for any POSIX locks.
1399 */
Jeff Layton6109c852015-01-16 15:05:57 -05001400 spin_lock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001401 ret = 0;
1402 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001403 if (fl->fl_owner != current->files &&
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001404 fl->fl_owner != file) {
1405 ret = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406 break;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001407 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 }
Jeff Layton6109c852015-01-16 15:05:57 -05001409 spin_unlock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001410 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411}
1412
1413/**
1414 * locks_mandatory_area - Check for a conflicting lock
Christoph Hellwigacc15572015-12-03 12:59:49 +01001415 * @inode: the file to check
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 * @filp: how the file was opened (if it was)
Christoph Hellwigacc15572015-12-03 12:59:49 +01001417 * @start: first byte in the file to check
1418 * @end: lastbyte in the file to check
1419 * @type: %F_WRLCK for a write lock, else %F_RDLCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420 *
1421 * Searches the inode's list of locks to find any POSIX locks which conflict.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 */
Christoph Hellwigacc15572015-12-03 12:59:49 +01001423int locks_mandatory_area(struct inode *inode, struct file *filp, loff_t start,
1424 loff_t end, unsigned char type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425{
1426 struct file_lock fl;
1427 int error;
Jeff Layton29723ad2014-03-10 09:54:19 -04001428 bool sleep = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429
1430 locks_init_lock(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 fl.fl_pid = current->tgid;
1432 fl.fl_file = filp;
1433 fl.fl_flags = FL_POSIX | FL_ACCESS;
1434 if (filp && !(filp->f_flags & O_NONBLOCK))
Jeff Layton29723ad2014-03-10 09:54:19 -04001435 sleep = true;
Christoph Hellwigacc15572015-12-03 12:59:49 +01001436 fl.fl_type = type;
1437 fl.fl_start = start;
1438 fl.fl_end = end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439
1440 for (;;) {
Jeff Layton29723ad2014-03-10 09:54:19 -04001441 if (filp) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001442 fl.fl_owner = filp;
Jeff Layton29723ad2014-03-10 09:54:19 -04001443 fl.fl_flags &= ~FL_SLEEP;
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001444 error = posix_lock_inode(inode, &fl, NULL);
Jeff Layton29723ad2014-03-10 09:54:19 -04001445 if (!error)
1446 break;
1447 }
1448
1449 if (sleep)
1450 fl.fl_flags |= FL_SLEEP;
1451 fl.fl_owner = current->files;
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001452 error = posix_lock_inode(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001453 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11001455 error = wait_event_interruptible(fl.fl_wait, !fl.fl_blocker);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 if (!error) {
1457 /*
1458 * If we've been sleeping someone might have
1459 * changed the permissions behind our back.
1460 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001461 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 continue;
1463 }
1464
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 break;
1466 }
NeilBrown16306a62018-11-30 10:04:08 +11001467 locks_delete_block(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468
1469 return error;
1470}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471EXPORT_SYMBOL(locks_mandatory_area);
Jeff Layton9e8925b2015-11-16 09:49:34 -05001472#endif /* CONFIG_MANDATORY_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473
J. Bruce Fields778fc542011-07-26 18:25:49 -04001474static void lease_clear_pending(struct file_lock *fl, int arg)
1475{
1476 switch (arg) {
1477 case F_UNLCK:
1478 fl->fl_flags &= ~FL_UNLOCK_PENDING;
Gustavo A. R. Silva0a4c9262019-01-23 02:48:28 -06001479 /* fall through */
J. Bruce Fields778fc542011-07-26 18:25:49 -04001480 case F_RDLCK:
1481 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1482 }
1483}
1484
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485/* We already had a lease on this file; just change its type */
Jeff Layton7448cc32015-01-16 15:05:57 -05001486int lease_modify(struct file_lock *fl, int arg, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 int error = assign_type(fl, arg);
1489
1490 if (error)
1491 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001492 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001494 if (arg == F_UNLCK) {
1495 struct file *filp = fl->fl_file;
1496
1497 f_delown(filp);
1498 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001499 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1500 if (fl->fl_fasync != NULL) {
1501 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1502 fl->fl_fasync = NULL;
1503 }
Jeff Laytone084c1b2015-02-16 14:32:03 -05001504 locks_delete_lock_ctx(fl, dispose);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001505 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 return 0;
1507}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508EXPORT_SYMBOL(lease_modify);
1509
J. Bruce Fields778fc542011-07-26 18:25:49 -04001510static bool past_time(unsigned long then)
1511{
1512 if (!then)
1513 /* 0 is a special value meaning "this never expires": */
1514 return false;
1515 return time_after(jiffies, then);
1516}
1517
Jeff Laytonc45198e2014-09-01 07:12:07 -04001518static void time_out_leases(struct inode *inode, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519{
Jeff Layton8634b512015-01-16 15:05:55 -05001520 struct file_lock_context *ctx = inode->i_flctx;
1521 struct file_lock *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522
Jeff Layton6109c852015-01-16 15:05:57 -05001523 lockdep_assert_held(&ctx->flc_lock);
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001524
Jeff Layton8634b512015-01-16 15:05:55 -05001525 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001526 trace_time_out_leases(inode, fl);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001527 if (past_time(fl->fl_downgrade_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001528 lease_modify(fl, F_RDLCK, dispose);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001529 if (past_time(fl->fl_break_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001530 lease_modify(fl, F_UNLCK, dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531 }
1532}
1533
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001534static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1535{
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001536 if ((breaker->fl_flags & FL_LAYOUT) != (lease->fl_flags & FL_LAYOUT))
1537 return false;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001538 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1539 return false;
1540 return locks_conflict(breaker, lease);
1541}
1542
Jeff Layton03d12dd2014-09-01 14:53:41 -04001543static bool
1544any_leases_conflict(struct inode *inode, struct file_lock *breaker)
1545{
Jeff Layton8634b512015-01-16 15:05:55 -05001546 struct file_lock_context *ctx = inode->i_flctx;
Jeff Layton03d12dd2014-09-01 14:53:41 -04001547 struct file_lock *fl;
1548
Jeff Layton6109c852015-01-16 15:05:57 -05001549 lockdep_assert_held(&ctx->flc_lock);
Jeff Layton03d12dd2014-09-01 14:53:41 -04001550
Jeff Layton8634b512015-01-16 15:05:55 -05001551 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Jeff Layton03d12dd2014-09-01 14:53:41 -04001552 if (leases_conflict(fl, breaker))
1553 return true;
1554 }
1555 return false;
1556}
1557
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558/**
1559 * __break_lease - revoke all outstanding leases on file
1560 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001561 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1562 * break all leases
1563 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1564 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 *
david m. richter87250dd2007-05-09 16:10:27 -04001566 * break_lease (inlined for speed) has checked there already is at least
1567 * some kind of lock (maybe a lease) on this file. Leases are broken on
1568 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 * specified %O_NONBLOCK to your open().
1570 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001571int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001573 int error = 0;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001574 struct file_lock_context *ctx;
Yan, Zhenga9011252015-03-27 10:34:20 +08001575 struct file_lock *new_fl, *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 unsigned long break_time;
Al Viro8737c932009-12-24 06:47:55 -05001577 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001578 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579
Al Viro8737c932009-12-24 06:47:55 -05001580 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001581 if (IS_ERR(new_fl))
1582 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001583 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584
Jeff Layton8634b512015-01-16 15:05:55 -05001585 /* typically we will check that ctx is non-NULL before calling */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001586 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001587 if (!ctx) {
1588 WARN_ON_ONCE(1);
1589 return error;
1590 }
1591
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001592 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001593 spin_lock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594
Jeff Laytonc45198e2014-09-01 07:12:07 -04001595 time_out_leases(inode, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596
Jeff Layton03d12dd2014-09-01 14:53:41 -04001597 if (!any_leases_conflict(inode, new_fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001598 goto out;
1599
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600 break_time = 0;
1601 if (lease_break_time > 0) {
1602 break_time = jiffies + lease_break_time * HZ;
1603 if (break_time == 0)
1604 break_time++; /* so that 0 means no break time */
1605 }
1606
Yan, Zhenga9011252015-03-27 10:34:20 +08001607 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001608 if (!leases_conflict(fl, new_fl))
1609 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001610 if (want_write) {
1611 if (fl->fl_flags & FL_UNLOCK_PENDING)
1612 continue;
1613 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001615 } else {
Jeff Layton8634b512015-01-16 15:05:55 -05001616 if (lease_breaking(fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001617 continue;
1618 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1619 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 }
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001621 if (fl->fl_lmops->lm_break(fl))
Jeff Laytone084c1b2015-02-16 14:32:03 -05001622 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623 }
1624
Jeff Layton8634b512015-01-16 15:05:55 -05001625 if (list_empty(&ctx->flc_lease))
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001626 goto out;
1627
Jeff Layton843c6b22014-09-01 14:27:43 -04001628 if (mode & O_NONBLOCK) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001629 trace_break_lease_noblock(inode, new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 error = -EWOULDBLOCK;
1631 goto out;
1632 }
1633
1634restart:
Jeff Layton8634b512015-01-16 15:05:55 -05001635 fl = list_first_entry(&ctx->flc_lease, struct file_lock, fl_list);
1636 break_time = fl->fl_break_time;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001637 if (break_time != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 break_time -= jiffies;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001639 if (break_time == 0)
1640 break_time++;
NeilBrownfd7732e2018-11-30 10:04:08 +11001641 locks_insert_block(fl, new_fl, leases_conflict);
Jeff Layton62af4f12014-05-09 14:13:05 -04001642 trace_break_lease_block(inode, new_fl);
Jeff Layton6109c852015-01-16 15:05:57 -05001643 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001644 percpu_up_read(&file_rwsem);
Peter Zijlstraaba37662015-06-22 14:16:33 +02001645
Jeff Laytonc45198e2014-09-01 07:12:07 -04001646 locks_dispose_list(&dispose);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001647 error = wait_event_interruptible_timeout(new_fl->fl_wait,
NeilBrownada5c1d2018-11-30 10:04:08 +11001648 !new_fl->fl_blocker, break_time);
Peter Zijlstraaba37662015-06-22 14:16:33 +02001649
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001650 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001651 spin_lock(&ctx->flc_lock);
Jeff Layton62af4f12014-05-09 14:13:05 -04001652 trace_break_lease_unblock(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001653 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 if (error >= 0) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001655 /*
1656 * Wait for the next conflicting lease that has not been
1657 * broken yet
1658 */
Jeff Layton03d12dd2014-09-01 14:53:41 -04001659 if (error == 0)
1660 time_out_leases(inode, &dispose);
1661 if (any_leases_conflict(inode, new_fl))
1662 goto restart;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 error = 0;
1664 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665out:
Jeff Layton6109c852015-01-16 15:05:57 -05001666 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001667 percpu_up_read(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001668 locks_dispose_list(&dispose);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001669 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 return error;
1671}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672EXPORT_SYMBOL(__break_lease);
1673
1674/**
Amir Goldstein76c47942018-01-03 17:14:34 +02001675 * lease_get_mtime - update modified time of an inode with exclusive lease
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 * @inode: the inode
Amir Goldstein76c47942018-01-03 17:14:34 +02001677 * @time: pointer to a timespec which contains the last modified time
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 *
1679 * This is to force NFS clients to flush their caches for files with
1680 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001681 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001683void lease_get_mtime(struct inode *inode, struct timespec64 *time)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684{
Jeff Laytonbfe86022014-08-22 10:18:44 -04001685 bool has_lease = false;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001686 struct file_lock_context *ctx;
Jeff Layton8634b512015-01-16 15:05:55 -05001687 struct file_lock *fl;
Jeff Laytonbfe86022014-08-22 10:18:44 -04001688
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001689 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001690 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Jeff Layton6109c852015-01-16 15:05:57 -05001691 spin_lock(&ctx->flc_lock);
Geliang Tang8ace5df2015-11-18 21:40:33 +08001692 fl = list_first_entry_or_null(&ctx->flc_lease,
1693 struct file_lock, fl_list);
1694 if (fl && (fl->fl_type == F_WRLCK))
1695 has_lease = true;
Jeff Layton6109c852015-01-16 15:05:57 -05001696 spin_unlock(&ctx->flc_lock);
Jeff Laytonbfe86022014-08-22 10:18:44 -04001697 }
1698
1699 if (has_lease)
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001700 *time = current_time(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702EXPORT_SYMBOL(lease_get_mtime);
1703
1704/**
1705 * fcntl_getlease - Enquire what lease is currently active
1706 * @filp: the file
1707 *
1708 * The value returned by this function will be one of
1709 * (if no lease break is pending):
1710 *
1711 * %F_RDLCK to indicate a shared lease is held.
1712 *
1713 * %F_WRLCK to indicate an exclusive lease is held.
1714 *
1715 * %F_UNLCK to indicate no lease is held.
1716 *
1717 * (if a lease break is pending):
1718 *
1719 * %F_RDLCK to indicate an exclusive lease needs to be
1720 * changed to a shared lease (or removed).
1721 *
1722 * %F_UNLCK to indicate the lease needs to be removed.
1723 *
1724 * XXX: sfr & willy disagree over whether F_INPROGRESS
1725 * should be returned to userspace.
1726 */
1727int fcntl_getlease(struct file *filp)
1728{
1729 struct file_lock *fl;
Miklos Szeredic568d682016-09-16 12:44:20 +02001730 struct inode *inode = locks_inode(filp);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001731 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732 int type = F_UNLCK;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001733 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001735 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001736 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001737 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001738 spin_lock(&ctx->flc_lock);
Miklos Szeredic568d682016-09-16 12:44:20 +02001739 time_out_leases(inode, &dispose);
Jeff Layton8634b512015-01-16 15:05:55 -05001740 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1741 if (fl->fl_file != filp)
1742 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001743 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744 break;
1745 }
Jeff Layton6109c852015-01-16 15:05:57 -05001746 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001747 percpu_up_read(&file_rwsem);
Peter Zijlstra5f430862016-10-08 10:12:28 +02001748
Jeff Layton8634b512015-01-16 15:05:55 -05001749 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 return type;
1752}
1753
Jeff Layton24cbe782014-02-03 12:13:06 -05001754/**
1755 * check_conflicting_open - see if the given dentry points to a file that has
NeilBrown7bbd1fc2018-11-30 10:04:08 +11001756 * an existing open that would conflict with the
1757 * desired lease.
Jeff Layton24cbe782014-02-03 12:13:06 -05001758 * @dentry: dentry to check
1759 * @arg: type of lease that we're trying to acquire
Randy Dunlap7fadc592015-08-09 18:43:17 -07001760 * @flags: current lock flags
Jeff Layton24cbe782014-02-03 12:13:06 -05001761 *
1762 * Check to see if there's an existing open fd on this file that would
1763 * conflict with the lease we're trying to set.
1764 */
1765static int
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001766check_conflicting_open(const struct dentry *dentry, const long arg, int flags)
Jeff Layton24cbe782014-02-03 12:13:06 -05001767{
1768 int ret = 0;
1769 struct inode *inode = dentry->d_inode;
1770
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001771 if (flags & FL_LAYOUT)
1772 return 0;
1773
Nikolay Borisov052b8cf2018-12-11 10:29:25 +02001774 if ((arg == F_RDLCK) && inode_is_open_for_write(inode))
Jeff Layton24cbe782014-02-03 12:13:06 -05001775 return -EAGAIN;
1776
1777 if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1778 (atomic_read(&inode->i_count) > 1)))
1779 ret = -EAGAIN;
1780
1781 return ret;
1782}
1783
Jeff Laytone6f5c782014-08-22 10:40:25 -04001784static int
1785generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786{
Jeff Layton8634b512015-01-16 15:05:55 -05001787 struct file_lock *fl, *my_fl = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001788 struct dentry *dentry = filp->f_path.dentry;
Miklos Szeredic568d682016-09-16 12:44:20 +02001789 struct inode *inode = dentry->d_inode;
Jeff Layton8634b512015-01-16 15:05:55 -05001790 struct file_lock_context *ctx;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001791 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001792 int error;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001793 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794
J. Bruce Fields096657b2010-10-30 17:31:14 -04001795 lease = *flp;
Jeff Layton62af4f12014-05-09 14:13:05 -04001796 trace_generic_add_lease(inode, lease);
1797
Jeff Layton5c1c6692015-04-03 09:04:03 -04001798 /* Note that arg is never F_UNLCK here */
1799 ctx = locks_get_lock_context(inode, arg);
Jeff Layton8634b512015-01-16 15:05:55 -05001800 if (!ctx)
1801 return -ENOMEM;
1802
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001803 /*
1804 * In the delegation case we need mutual exclusion with
1805 * a number of operations that take the i_mutex. We trylock
1806 * because delegations are an optional optimization, and if
1807 * there's some chance of a conflict--we'd rather not
1808 * bother, maybe that's a sign this just isn't a good file to
1809 * hand out a delegation on.
1810 */
Al Viro59551022016-01-22 15:40:57 -05001811 if (is_deleg && !inode_trylock(inode))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001812 return -EAGAIN;
1813
1814 if (is_deleg && arg == F_WRLCK) {
1815 /* Write delegations are not currently supported: */
Al Viro59551022016-01-22 15:40:57 -05001816 inode_unlock(inode);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001817 WARN_ON_ONCE(1);
1818 return -EINVAL;
1819 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001820
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001821 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001822 spin_lock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001823 time_out_leases(inode, &dispose);
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001824 error = check_conflicting_open(dentry, arg, lease->fl_flags);
Jeff Layton24cbe782014-02-03 12:13:06 -05001825 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001826 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001827
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 /*
1829 * At this point, we know that if there is an exclusive
1830 * lease on this file, then we hold it on this filp
1831 * (otherwise our open of this file would have blocked).
1832 * And if we are trying to acquire an exclusive lease,
1833 * then the file is not open by anyone (including us)
1834 * except for this filp.
1835 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001836 error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001837 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001838 if (fl->fl_file == filp &&
1839 fl->fl_owner == lease->fl_owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001840 my_fl = fl;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001841 continue;
1842 }
Jeff Layton8634b512015-01-16 15:05:55 -05001843
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001844 /*
1845 * No exclusive leases if someone else has a lease on
1846 * this file:
1847 */
1848 if (arg == F_WRLCK)
1849 goto out;
1850 /*
1851 * Modifying our existing lease is OK, but no getting a
1852 * new lease if someone else is opening for write:
1853 */
1854 if (fl->fl_flags & FL_UNLOCK_PENDING)
1855 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 }
1857
Jeff Layton8634b512015-01-16 15:05:55 -05001858 if (my_fl != NULL) {
Jeff Layton0164bf02015-03-04 17:34:32 -05001859 lease = my_fl;
1860 error = lease->fl_lmops->lm_change(lease, arg, &dispose);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001861 if (error)
1862 goto out;
1863 goto out_setup;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 }
1865
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 error = -EINVAL;
1867 if (!leases_enable)
1868 goto out;
1869
Jeff Laytone084c1b2015-02-16 14:32:03 -05001870 locks_insert_lock_ctx(lease, &ctx->flc_lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001871 /*
1872 * The check in break_lease() is lockless. It's possible for another
1873 * open to race in after we did the earlier check for a conflicting
1874 * open but before the lease was inserted. Check again for a
1875 * conflicting open and cancel the lease if there is one.
1876 *
1877 * We also add a barrier here to ensure that the insertion of the lock
1878 * precedes these checks.
1879 */
1880 smp_mb();
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001881 error = check_conflicting_open(dentry, arg, lease->fl_flags);
Jeff Layton8634b512015-01-16 15:05:55 -05001882 if (error) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001883 locks_unlink_lock_ctx(lease);
Jeff Layton8634b512015-01-16 15:05:55 -05001884 goto out;
1885 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001886
1887out_setup:
1888 if (lease->fl_lmops->lm_setup)
1889 lease->fl_lmops->lm_setup(lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890out:
Jeff Layton6109c852015-01-16 15:05:57 -05001891 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001892 percpu_up_read(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001893 locks_dispose_list(&dispose);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001894 if (is_deleg)
Al Viro59551022016-01-22 15:40:57 -05001895 inode_unlock(inode);
Jeff Layton8634b512015-01-16 15:05:55 -05001896 if (!error && !my_fl)
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001897 *flp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 return error;
1899}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001900
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001901static int generic_delete_lease(struct file *filp, void *owner)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001902{
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001903 int error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001904 struct file_lock *fl, *victim = NULL;
Miklos Szeredic568d682016-09-16 12:44:20 +02001905 struct inode *inode = locks_inode(filp);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001906 struct file_lock_context *ctx;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001907 LIST_HEAD(dispose);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001908
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001909 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001910 if (!ctx) {
1911 trace_generic_delete_lease(inode, NULL);
1912 return error;
1913 }
1914
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001915 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001916 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001917 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001918 if (fl->fl_file == filp &&
1919 fl->fl_owner == owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001920 victim = fl;
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001921 break;
Jeff Layton8634b512015-01-16 15:05:55 -05001922 }
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001923 }
Jeff Laytona9b1b452015-03-14 09:45:35 -04001924 trace_generic_delete_lease(inode, victim);
Jeff Layton8634b512015-01-16 15:05:55 -05001925 if (victim)
Jeff Layton7448cc32015-01-16 15:05:57 -05001926 error = fl->fl_lmops->lm_change(victim, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05001927 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01001928 percpu_up_read(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001929 locks_dispose_list(&dispose);
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001930 return error;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001931}
1932
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933/**
1934 * generic_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001935 * @filp: file pointer
1936 * @arg: type of lease to obtain
1937 * @flp: input - file_lock to use, output - file_lock inserted
1938 * @priv: private data for lm_setup (may be NULL if lm_setup
1939 * doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 *
1941 * The (input) flp->fl_lmops->lm_break function is required
1942 * by break_lease().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001944int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
1945 void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946{
Miklos Szeredic568d682016-09-16 12:44:20 +02001947 struct inode *inode = locks_inode(filp);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001948 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001950 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001951 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001953 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 error = security_file_lock(filp, arg);
1955 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001956 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001958 switch (arg) {
1959 case F_UNLCK:
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001960 return generic_delete_lease(filp, *priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001961 case F_RDLCK:
1962 case F_WRLCK:
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001963 if (!(*flp)->fl_lmops->lm_break) {
1964 WARN_ON_ONCE(1);
1965 return -ENOLCK;
1966 }
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001967
Jeff Laytone6f5c782014-08-22 10:40:25 -04001968 return generic_add_lease(filp, arg, flp, priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001969 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001970 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001973EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001975/**
Jeff Laytone51673a2014-08-22 18:13:28 -04001976 * vfs_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001977 * @filp: file pointer
1978 * @arg: type of lease to obtain
1979 * @lease: file_lock to use when adding a lease
1980 * @priv: private info for lm_setup when adding a lease (may be
NeilBrown7bbd1fc2018-11-30 10:04:08 +11001981 * NULL if lm_setup doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 *
Jeff Laytone51673a2014-08-22 18:13:28 -04001983 * Call this to establish a lease on the file. The "lease" argument is not
1984 * used for F_UNLCK requests and may be NULL. For commands that set or alter
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04001985 * an existing lease, the ``(*lease)->fl_lmops->lm_break`` operation must be
1986 * set; if not, this function will return -ENOLCK (and generate a scary-looking
Jeff Laytone51673a2014-08-22 18:13:28 -04001987 * stack trace).
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001988 *
1989 * The "priv" pointer is passed directly to the lm_setup function as-is. It
1990 * may be NULL if the lm_setup operation doesn't require it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001992int
1993vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02001995 if (filp->f_op->setlease)
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001996 return filp->f_op->setlease(filp, arg, lease, priv);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001997 else
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001998 return generic_setlease(filp, arg, lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04002000EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002002static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003{
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002004 struct file_lock *fl;
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002005 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006 int error;
2007
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02002008 fl = lease_alloc(filp, arg);
2009 if (IS_ERR(fl))
2010 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002012 new = fasync_alloc();
2013 if (!new) {
2014 locks_free_lock(fl);
2015 return -ENOMEM;
2016 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002017 new->fa_fd = fd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002019 error = vfs_setlease(filp, arg, &fl, (void **)&new);
Jeff Layton2dfb9282014-08-11 18:14:12 -04002020 if (fl)
2021 locks_free_lock(fl);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002022 if (new)
2023 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 return error;
2025}
2026
2027/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002028 * fcntl_setlease - sets a lease on an open file
2029 * @fd: open file descriptor
2030 * @filp: file pointer
2031 * @arg: type of lease to obtain
2032 *
2033 * Call this fcntl to establish a lease on the file.
2034 * Note that you also need to call %F_SETSIG to
2035 * receive a signal when the lease is broken.
2036 */
2037int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
2038{
2039 if (arg == F_UNLCK)
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01002040 return vfs_setlease(filp, F_UNLCK, NULL, (void **)&filp);
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002041 return do_fcntl_add_lease(fd, filp, arg);
2042}
2043
2044/**
Jeff Layton29d01b22015-07-11 06:43:02 -04002045 * flock_lock_inode_wait - Apply a FLOCK-style lock to a file
2046 * @inode: inode of the file to apply to
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047 * @fl: The lock to be applied
2048 *
Jeff Layton29d01b22015-07-11 06:43:02 -04002049 * Apply a FLOCK style lock request to an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050 */
Benjamin Coddington616fb382015-10-22 13:38:15 -04002051static int flock_lock_inode_wait(struct inode *inode, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052{
2053 int error;
2054 might_sleep();
2055 for (;;) {
Jeff Layton29d01b22015-07-11 06:43:02 -04002056 error = flock_lock_inode(inode, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07002057 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11002059 error = wait_event_interruptible(fl->fl_wait, !fl->fl_blocker);
NeilBrown16306a62018-11-30 10:04:08 +11002060 if (error)
2061 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062 }
NeilBrown16306a62018-11-30 10:04:08 +11002063 locks_delete_block(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 return error;
2065}
2066
Jeff Layton29d01b22015-07-11 06:43:02 -04002067/**
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04002068 * locks_lock_inode_wait - Apply a lock to an inode
2069 * @inode: inode of the file to apply to
2070 * @fl: The lock to be applied
2071 *
2072 * Apply a POSIX or FLOCK style lock request to an inode.
2073 */
2074int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
2075{
2076 int res = 0;
2077 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
2078 case FL_POSIX:
2079 res = posix_lock_inode_wait(inode, fl);
2080 break;
2081 case FL_FLOCK:
2082 res = flock_lock_inode_wait(inode, fl);
2083 break;
2084 default:
2085 BUG();
2086 }
2087 return res;
2088}
2089EXPORT_SYMBOL(locks_lock_inode_wait);
2090
2091/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 * sys_flock: - flock() system call.
2093 * @fd: the file descriptor to lock.
2094 * @cmd: the type of lock to apply.
2095 *
2096 * Apply a %FL_FLOCK style lock to an open file descriptor.
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04002097 * The @cmd can be one of:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 *
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04002099 * - %LOCK_SH -- a shared lock.
2100 * - %LOCK_EX -- an exclusive lock.
2101 * - %LOCK_UN -- remove an existing lock.
2102 * - %LOCK_MAND -- a 'mandatory' flock.
2103 * This exists to emulate Windows Share Modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 *
2105 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
2106 * processes read and write access respectively.
2107 */
Heiko Carstens002c8972009-01-14 14:14:18 +01002108SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109{
Al Viro2903ff02012-08-28 12:52:22 -04002110 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 struct file_lock *lock;
2112 int can_sleep, unlock;
2113 int error;
2114
2115 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04002116 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 goto out;
2118
2119 can_sleep = !(cmd & LOCK_NB);
2120 cmd &= ~LOCK_NB;
2121 unlock = (cmd == LOCK_UN);
2122
Al Viroaeb5d722008-09-02 15:28:45 -04002123 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04002124 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 goto out_putf;
2126
NeilBrownd6367d62018-11-30 10:04:08 +11002127 lock = flock_make_lock(f.file, cmd, NULL);
Jeff Layton6e129d002014-09-04 10:25:06 -04002128 if (IS_ERR(lock)) {
2129 error = PTR_ERR(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 goto out_putf;
Jeff Layton6e129d002014-09-04 10:25:06 -04002131 }
2132
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 if (can_sleep)
2134 lock->fl_flags |= FL_SLEEP;
2135
Al Viro2903ff02012-08-28 12:52:22 -04002136 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 if (error)
2138 goto out_free;
2139
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002140 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04002141 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 (can_sleep) ? F_SETLKW : F_SETLK,
2143 lock);
2144 else
Benjamin Coddington4f656362015-10-22 13:38:14 -04002145 error = locks_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146
2147 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08002148 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149
2150 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04002151 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 out:
2153 return error;
2154}
2155
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002156/**
2157 * vfs_test_lock - test file byte range lock
2158 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04002159 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002160 *
2161 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
2162 * setting conf->fl_type to something other than F_UNLCK.
2163 */
2164int vfs_test_lock(struct file *filp, struct file_lock *fl)
2165{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002166 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002167 return filp->f_op->lock(filp, F_GETLK, fl);
2168 posix_test_lock(filp, fl);
2169 return 0;
2170}
2171EXPORT_SYMBOL_GPL(vfs_test_lock);
2172
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002173/**
2174 * locks_translate_pid - translate a file_lock's fl_pid number into a namespace
2175 * @fl: The file_lock who's fl_pid should be translated
2176 * @ns: The namespace into which the pid should be translated
2177 *
2178 * Used to tranlate a fl_pid into a namespace virtual pid number
2179 */
2180static pid_t locks_translate_pid(struct file_lock *fl, struct pid_namespace *ns)
2181{
2182 pid_t vnr;
2183 struct pid *pid;
2184
2185 if (IS_OFDLCK(fl))
2186 return -1;
2187 if (IS_REMOTELCK(fl))
2188 return fl->fl_pid;
Konstantin Khorenko826d7bc2018-06-08 17:27:11 +03002189 /*
2190 * If the flock owner process is dead and its pid has been already
2191 * freed, the translation below won't work, but we still want to show
2192 * flock owner pid number in init pidns.
2193 */
2194 if (ns == &init_pid_ns)
2195 return (pid_t)fl->fl_pid;
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002196
2197 rcu_read_lock();
2198 pid = find_pid_ns(fl->fl_pid, &init_pid_ns);
2199 vnr = pid_nr_ns(pid, ns);
2200 rcu_read_unlock();
2201 return vnr;
2202}
2203
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002204static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
2205{
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002206 flock->l_pid = locks_translate_pid(fl, task_active_pid_ns(current));
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002207#if BITS_PER_LONG == 32
2208 /*
2209 * Make sure we can represent the posix lock via
2210 * legacy 32bit flock.
2211 */
2212 if (fl->fl_start > OFFT_OFFSET_MAX)
2213 return -EOVERFLOW;
2214 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
2215 return -EOVERFLOW;
2216#endif
2217 flock->l_start = fl->fl_start;
2218 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2219 fl->fl_end - fl->fl_start + 1;
2220 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04002221 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002222 return 0;
2223}
2224
2225#if BITS_PER_LONG == 32
2226static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
2227{
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002228 flock->l_pid = locks_translate_pid(fl, task_active_pid_ns(current));
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002229 flock->l_start = fl->fl_start;
2230 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2231 fl->fl_end - fl->fl_start + 1;
2232 flock->l_whence = 0;
2233 flock->l_type = fl->fl_type;
2234}
2235#endif
2236
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237/* Report the first existing lock that would conflict with l.
2238 * This implements the F_GETLK command of fcntl().
2239 */
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002240int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241{
Benjamin Coddington52306e82017-07-16 10:28:21 -04002242 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 int error;
2244
Benjamin Coddington52306e82017-07-16 10:28:21 -04002245 fl = locks_alloc_lock();
2246 if (fl == NULL)
2247 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002249 if (flock->l_type != F_RDLCK && flock->l_type != F_WRLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 goto out;
2251
Benjamin Coddington52306e82017-07-16 10:28:21 -04002252 error = flock_to_posix_lock(filp, fl, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 if (error)
2254 goto out;
2255
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002256 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002257 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002258 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002259 goto out;
2260
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002261 cmd = F_GETLK;
Benjamin Coddington52306e82017-07-16 10:28:21 -04002262 fl->fl_flags |= FL_OFDLCK;
2263 fl->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002264 }
2265
Benjamin Coddington52306e82017-07-16 10:28:21 -04002266 error = vfs_test_lock(filp, fl);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002267 if (error)
2268 goto out;
NeilBrown7bbd1fc2018-11-30 10:04:08 +11002269
Benjamin Coddington52306e82017-07-16 10:28:21 -04002270 flock->l_type = fl->fl_type;
2271 if (fl->fl_type != F_UNLCK) {
2272 error = posix_lock_to_flock(flock, fl);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002273 if (error)
Benjamin Coddington52306e82017-07-16 10:28:21 -04002274 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276out:
Benjamin Coddington52306e82017-07-16 10:28:21 -04002277 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 return error;
2279}
2280
Marc Eshel7723ec92007-01-18 15:08:55 -05002281/**
2282 * vfs_lock_file - file byte range lock
2283 * @filp: The file to apply the lock to
2284 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2285 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05002286 * @conf: Place to return a copy of the conflicting lock, if found.
2287 *
2288 * A caller that doesn't care about the conflicting lock may pass NULL
2289 * as the final argument.
2290 *
2291 * If the filesystem defines a private ->lock() method, then @conf will
2292 * be left unchanged; so a caller that cares should initialize it to
2293 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05002294 *
2295 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2296 * locks, the ->lock() interface may return asynchronously, before the lock has
2297 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002298 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05002299 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2300 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002301 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05002302 * request completes.
2303 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07002304 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2305 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05002306 * nonzero return code and the file system should release the lock. The file
2307 * system is also responsible to keep a corresponding posix lock when it
2308 * grants a lock so the VFS can find out which locks are locally held and do
2309 * the correct lock cleanup when required.
2310 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002311 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05002312 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05002313 */
Marc Eshel150b3932007-01-18 16:15:35 -05002314int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05002315{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002316 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05002317 return filp->f_op->lock(filp, cmd, fl);
2318 else
Marc Eshel150b3932007-01-18 16:15:35 -05002319 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05002320}
2321EXPORT_SYMBOL_GPL(vfs_lock_file);
2322
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002323static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2324 struct file_lock *fl)
2325{
2326 int error;
2327
2328 error = security_file_lock(filp, fl->fl_type);
2329 if (error)
2330 return error;
2331
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002332 for (;;) {
2333 error = vfs_lock_file(filp, cmd, fl, NULL);
2334 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002335 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11002336 error = wait_event_interruptible(fl->fl_wait, !fl->fl_blocker);
NeilBrown16306a62018-11-30 10:04:08 +11002337 if (error)
2338 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002339 }
NeilBrown16306a62018-11-30 10:04:08 +11002340 locks_delete_block(fl);
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002341
2342 return error;
2343}
2344
Benjamin Coddington6ca7d912015-10-15 09:07:07 -04002345/* Ensure that fl->fl_file has compatible f_mode for F_SETLK calls */
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002346static int
2347check_fmode_for_setlk(struct file_lock *fl)
2348{
2349 switch (fl->fl_type) {
2350 case F_RDLCK:
2351 if (!(fl->fl_file->f_mode & FMODE_READ))
2352 return -EBADF;
2353 break;
2354 case F_WRLCK:
2355 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2356 return -EBADF;
2357 }
2358 return 0;
2359}
2360
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361/* Apply the lock described by l to an open file descriptor.
2362 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2363 */
Peter Staubachc2936212005-07-27 11:45:09 -07002364int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002365 struct flock *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366{
2367 struct file_lock *file_lock = locks_alloc_lock();
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002368 struct inode *inode = locks_inode(filp);
Al Viro0b2bac22008-05-06 13:58:34 -04002369 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370 int error;
2371
2372 if (file_lock == NULL)
2373 return -ENOLCK;
2374
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375 /* Don't allow mandatory locks on files that may be memory mapped
2376 * and shared.
2377 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002378 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 error = -EAGAIN;
2380 goto out;
2381 }
2382
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002383 error = flock_to_posix_lock(filp, file_lock, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384 if (error)
2385 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002386
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002387 error = check_fmode_for_setlk(file_lock);
2388 if (error)
2389 goto out;
2390
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002391 /*
2392 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002393 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002394 */
2395 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002396 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002397 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002398 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002399 goto out;
2400
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002401 cmd = F_SETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002402 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002403 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002404 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002405 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002406 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002407 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002408 goto out;
2409
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002410 cmd = F_SETLKW;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002411 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002412 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002413 /* Fallthrough */
2414 case F_SETLKW:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415 file_lock->fl_flags |= FL_SLEEP;
2416 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002417
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002418 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419
Peter Staubachc2936212005-07-27 11:45:09 -07002420 /*
Jeff Layton0752ba82016-01-08 07:30:43 -05002421 * Attempt to detect a close/fcntl race and recover by releasing the
2422 * lock that was just acquired. There is no need to do that when we're
2423 * unlocking though, or for OFD locks.
Peter Staubachc2936212005-07-27 11:45:09 -07002424 */
Jeff Layton0752ba82016-01-08 07:30:43 -05002425 if (!error && file_lock->fl_type != F_UNLCK &&
2426 !(file_lock->fl_flags & FL_OFDLCK)) {
Jeff Layton7f3697e2016-01-07 16:38:10 -05002427 /*
2428 * We need that spin_lock here - it prevents reordering between
2429 * update of i_flctx->flc_posix and check for it done in
2430 * close(). rcu_read_lock() wouldn't do.
2431 */
2432 spin_lock(&current->files->file_lock);
2433 f = fcheck(fd);
2434 spin_unlock(&current->files->file_lock);
2435 if (f != filp) {
2436 file_lock->fl_type = F_UNLCK;
2437 error = do_lock_file_wait(filp, cmd, file_lock);
2438 WARN_ON_ONCE(error);
2439 error = -EBADF;
2440 }
Peter Staubachc2936212005-07-27 11:45:09 -07002441 }
Peter Staubachc2936212005-07-27 11:45:09 -07002442out:
Jeff Layton18909102016-01-06 21:26:10 -05002443 trace_fcntl_setlk(inode, file_lock, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 locks_free_lock(file_lock);
2445 return error;
2446}
2447
2448#if BITS_PER_LONG == 32
2449/* Report the first existing lock that would conflict with l.
2450 * This implements the F_GETLK command of fcntl().
2451 */
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002452int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453{
Benjamin Coddington52306e82017-07-16 10:28:21 -04002454 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 int error;
2456
Benjamin Coddington52306e82017-07-16 10:28:21 -04002457 fl = locks_alloc_lock();
2458 if (fl == NULL)
2459 return -ENOMEM;
2460
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002462 if (flock->l_type != F_RDLCK && flock->l_type != F_WRLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 goto out;
2464
Benjamin Coddington52306e82017-07-16 10:28:21 -04002465 error = flock64_to_posix_lock(filp, fl, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002466 if (error)
2467 goto out;
2468
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002469 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002470 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002471 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002472 goto out;
2473
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002474 cmd = F_GETLK64;
Benjamin Coddington52306e82017-07-16 10:28:21 -04002475 fl->fl_flags |= FL_OFDLCK;
2476 fl->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002477 }
2478
Benjamin Coddington52306e82017-07-16 10:28:21 -04002479 error = vfs_test_lock(filp, fl);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002480 if (error)
2481 goto out;
2482
Benjamin Coddington52306e82017-07-16 10:28:21 -04002483 flock->l_type = fl->fl_type;
2484 if (fl->fl_type != F_UNLCK)
2485 posix_lock_to_flock64(flock, fl);
Kinglong Meef3282962014-08-22 10:18:43 -04002486
Linus Torvalds1da177e2005-04-16 15:20:36 -07002487out:
Benjamin Coddington52306e82017-07-16 10:28:21 -04002488 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489 return error;
2490}
2491
2492/* Apply the lock described by l to an open file descriptor.
2493 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2494 */
Peter Staubachc2936212005-07-27 11:45:09 -07002495int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002496 struct flock64 *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497{
2498 struct file_lock *file_lock = locks_alloc_lock();
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002499 struct inode *inode = locks_inode(filp);
Al Viro0b2bac22008-05-06 13:58:34 -04002500 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501 int error;
2502
2503 if (file_lock == NULL)
2504 return -ENOLCK;
2505
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506 /* Don't allow mandatory locks on files that may be memory mapped
2507 * and shared.
2508 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002509 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510 error = -EAGAIN;
2511 goto out;
2512 }
2513
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002514 error = flock64_to_posix_lock(filp, file_lock, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515 if (error)
2516 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002517
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002518 error = check_fmode_for_setlk(file_lock);
2519 if (error)
2520 goto out;
2521
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002522 /*
2523 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002524 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002525 */
2526 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002527 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002528 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002529 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002530 goto out;
2531
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002532 cmd = F_SETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002533 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002534 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002535 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002536 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002537 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002538 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002539 goto out;
2540
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002541 cmd = F_SETLKW64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002542 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002543 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002544 /* Fallthrough */
2545 case F_SETLKW64:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002546 file_lock->fl_flags |= FL_SLEEP;
2547 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002548
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002549 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550
Peter Staubachc2936212005-07-27 11:45:09 -07002551 /*
Jeff Layton0752ba82016-01-08 07:30:43 -05002552 * Attempt to detect a close/fcntl race and recover by releasing the
2553 * lock that was just acquired. There is no need to do that when we're
2554 * unlocking though, or for OFD locks.
Peter Staubachc2936212005-07-27 11:45:09 -07002555 */
Jeff Layton0752ba82016-01-08 07:30:43 -05002556 if (!error && file_lock->fl_type != F_UNLCK &&
2557 !(file_lock->fl_flags & FL_OFDLCK)) {
Jeff Layton7f3697e2016-01-07 16:38:10 -05002558 /*
2559 * We need that spin_lock here - it prevents reordering between
2560 * update of i_flctx->flc_posix and check for it done in
2561 * close(). rcu_read_lock() wouldn't do.
2562 */
2563 spin_lock(&current->files->file_lock);
2564 f = fcheck(fd);
2565 spin_unlock(&current->files->file_lock);
2566 if (f != filp) {
2567 file_lock->fl_type = F_UNLCK;
2568 error = do_lock_file_wait(filp, cmd, file_lock);
2569 WARN_ON_ONCE(error);
2570 error = -EBADF;
2571 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573out:
2574 locks_free_lock(file_lock);
2575 return error;
2576}
2577#endif /* BITS_PER_LONG == 32 */
2578
2579/*
2580 * This function is called when the file is being removed
2581 * from the task's fd array. POSIX locks belonging to this task
2582 * are deleted at this time.
2583 */
2584void locks_remove_posix(struct file *filp, fl_owner_t owner)
2585{
Jeff Layton18909102016-01-06 21:26:10 -05002586 int error;
Miklos Szeredic568d682016-09-16 12:44:20 +02002587 struct inode *inode = locks_inode(filp);
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002588 struct file_lock lock;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002589 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002590
2591 /*
2592 * If there are no locks held on this file, we don't need to call
2593 * posix_lock_file(). Another process could be setting a lock on this
2594 * file at the same time, but we wouldn't remove that lock anyway.
2595 */
Miklos Szeredic568d682016-09-16 12:44:20 +02002596 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05002597 if (!ctx || list_empty(&ctx->flc_posix))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598 return;
2599
NeilBrownd6367d62018-11-30 10:04:08 +11002600 locks_init_lock(&lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002601 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002602 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 lock.fl_start = 0;
2604 lock.fl_end = OFFSET_MAX;
2605 lock.fl_owner = owner;
2606 lock.fl_pid = current->tgid;
2607 lock.fl_file = filp;
2608 lock.fl_ops = NULL;
2609 lock.fl_lmops = NULL;
2610
Jeff Layton18909102016-01-06 21:26:10 -05002611 error = vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2614 lock.fl_ops->fl_release_private(&lock);
Miklos Szeredic568d682016-09-16 12:44:20 +02002615 trace_locks_remove_posix(inode, &lock, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002616}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617EXPORT_SYMBOL(locks_remove_posix);
2618
Jeff Layton3d8e5602015-01-16 15:05:58 -05002619/* The i_flctx must be valid when calling into here */
Jeff Laytondd459bb2015-01-16 15:05:54 -05002620static void
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002621locks_remove_flock(struct file *filp, struct file_lock_context *flctx)
Jeff Laytondd459bb2015-01-16 15:05:54 -05002622{
NeilBrownd6367d62018-11-30 10:04:08 +11002623 struct file_lock fl;
Miklos Szeredic568d682016-09-16 12:44:20 +02002624 struct inode *inode = locks_inode(filp);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002625
Jeff Layton3d8e5602015-01-16 15:05:58 -05002626 if (list_empty(&flctx->flc_flock))
Jeff Laytondd459bb2015-01-16 15:05:54 -05002627 return;
2628
NeilBrownd6367d62018-11-30 10:04:08 +11002629 flock_make_lock(filp, LOCK_UN, &fl);
2630 fl.fl_flags |= FL_CLOSE;
2631
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002632 if (filp->f_op->flock)
Jeff Laytondd459bb2015-01-16 15:05:54 -05002633 filp->f_op->flock(filp, F_SETLKW, &fl);
2634 else
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04002635 flock_lock_inode(inode, &fl);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002636
2637 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2638 fl.fl_ops->fl_release_private(&fl);
2639}
2640
Jeff Layton3d8e5602015-01-16 15:05:58 -05002641/* The i_flctx must be valid when calling into here */
Jeff Layton8634b512015-01-16 15:05:55 -05002642static void
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002643locks_remove_lease(struct file *filp, struct file_lock_context *ctx)
Jeff Layton8634b512015-01-16 15:05:55 -05002644{
Jeff Layton8634b512015-01-16 15:05:55 -05002645 struct file_lock *fl, *tmp;
2646 LIST_HEAD(dispose);
2647
Jeff Layton3d8e5602015-01-16 15:05:58 -05002648 if (list_empty(&ctx->flc_lease))
Jeff Layton8634b512015-01-16 15:05:55 -05002649 return;
2650
Peter Zijlstra02e525b22019-02-21 15:38:40 +01002651 percpu_down_read(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05002652 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05002653 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list)
Jeff Laytonc4e136c2015-02-16 19:37:42 -05002654 if (filp == fl->fl_file)
2655 lease_modify(fl, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05002656 spin_unlock(&ctx->flc_lock);
Peter Zijlstra02e525b22019-02-21 15:38:40 +01002657 percpu_up_read(&file_rwsem);
Peter Zijlstra5f430862016-10-08 10:12:28 +02002658
Jeff Layton8634b512015-01-16 15:05:55 -05002659 locks_dispose_list(&dispose);
2660}
2661
Linus Torvalds1da177e2005-04-16 15:20:36 -07002662/*
2663 * This function is called on the last close of an open file.
2664 */
Jeff Layton78ed8a12014-02-03 12:13:08 -05002665void locks_remove_file(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002666{
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002667 struct file_lock_context *ctx;
2668
Miklos Szeredic568d682016-09-16 12:44:20 +02002669 ctx = smp_load_acquire(&locks_inode(filp)->i_flctx);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002670 if (!ctx)
Jeff Layton3d8e5602015-01-16 15:05:58 -05002671 return;
2672
Jeff Laytondd459bb2015-01-16 15:05:54 -05002673 /* remove any OFD locks */
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002674 locks_remove_posix(filp, filp);
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002675
Jeff Laytondd459bb2015-01-16 15:05:54 -05002676 /* remove flock locks */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002677 locks_remove_flock(filp, ctx);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002678
Jeff Layton8634b512015-01-16 15:05:55 -05002679 /* remove any leases */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002680 locks_remove_lease(filp, ctx);
Benjamin Coddington39537042017-07-21 13:36:25 -04002681
2682 spin_lock(&ctx->flc_lock);
2683 locks_check_ctx_file_list(filp, &ctx->flc_posix, "POSIX");
2684 locks_check_ctx_file_list(filp, &ctx->flc_flock, "FLOCK");
2685 locks_check_ctx_file_list(filp, &ctx->flc_lease, "LEASE");
2686 spin_unlock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002687}
2688
2689/**
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002690 * vfs_cancel_lock - file byte range unblock lock
2691 * @filp: The file to apply the unblock to
2692 * @fl: The lock to be unblocked
2693 *
2694 * Used by lock managers to cancel blocked requests
2695 */
2696int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2697{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002698 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002699 return filp->f_op->lock(filp, F_CANCELLK, fl);
2700 return 0;
2701}
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002702EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2703
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002704#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002705#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002706#include <linux/seq_file.h>
2707
Jeff Layton7012b022013-06-21 08:58:22 -04002708struct locks_iterator {
2709 int li_cpu;
2710 loff_t li_pos;
2711};
2712
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002713static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002714 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002715{
2716 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002717 unsigned int fl_pid;
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002718 struct pid_namespace *proc_pidns = file_inode(f->file)->i_sb->s_fs_info;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002719
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002720 fl_pid = locks_translate_pid(fl, proc_pidns);
2721 /*
Konstantin Khorenko1cf8e5d2018-06-08 17:27:12 +03002722 * If lock owner is dead (and pid is freed) or not visible in current
2723 * pidns, zero is shown as a pid value. Check lock info from
2724 * init_pid_ns to get saved lock pid value.
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002725 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002726
2727 if (fl->fl_file != NULL)
Miklos Szeredic568d682016-09-16 12:44:20 +02002728 inode = locks_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002729
Jerome Marchand99dc8292010-10-26 14:22:33 -07002730 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731 if (IS_POSIX(fl)) {
Jeff Laytonc918d422014-02-03 12:13:09 -05002732 if (fl->fl_flags & FL_ACCESS)
Fabian Frederick5315c262014-05-09 14:13:05 -04002733 seq_puts(f, "ACCESS");
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002734 else if (IS_OFDLCK(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002735 seq_puts(f, "OFDLCK");
Jeff Laytonc918d422014-02-03 12:13:09 -05002736 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002737 seq_puts(f, "POSIX ");
Jeff Laytonc918d422014-02-03 12:13:09 -05002738
2739 seq_printf(f, " %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002740 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002741 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002742 } else if (IS_FLOCK(fl)) {
2743 if (fl->fl_type & LOCK_MAND) {
Fabian Frederick5315c262014-05-09 14:13:05 -04002744 seq_puts(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002745 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002746 seq_puts(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002747 }
2748 } else if (IS_LEASE(fl)) {
Jeff Layton8144f1f2014-08-11 13:36:54 -04002749 if (fl->fl_flags & FL_DELEG)
2750 seq_puts(f, "DELEG ");
2751 else
2752 seq_puts(f, "LEASE ");
2753
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002754 if (lease_breaking(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002755 seq_puts(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002756 else if (fl->fl_file)
Fabian Frederick5315c262014-05-09 14:13:05 -04002757 seq_puts(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002758 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002759 seq_puts(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002760 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002761 seq_puts(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002762 }
2763 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002764 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002765 (fl->fl_type & LOCK_READ)
2766 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2767 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2768 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002769 seq_printf(f, "%s ",
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002770 (lease_breaking(fl))
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04002771 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2772 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773 }
2774 if (inode) {
Jeff Layton36488882015-04-03 09:04:04 -04002775 /* userspace relies on this representation of dev_t */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002776 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002777 MAJOR(inode->i_sb->s_dev),
2778 MINOR(inode->i_sb->s_dev), inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002779 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002780 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781 }
2782 if (IS_POSIX(fl)) {
2783 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002784 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002785 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002786 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002787 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002788 seq_puts(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789 }
2790}
2791
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002792static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793{
Jeff Layton7012b022013-06-21 08:58:22 -04002794 struct locks_iterator *iter = f->private;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002795 struct file_lock *fl, *bfl;
Nikolay Borisovd67fd442016-08-17 16:18:46 -04002796 struct pid_namespace *proc_pidns = file_inode(f->file)->i_sb->s_fs_info;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002797
Jeff Layton139ca042013-06-21 08:58:17 -04002798 fl = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002799
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002800 if (locks_translate_pid(fl, proc_pidns) == 0)
Nikolay Borisovd67fd442016-08-17 16:18:46 -04002801 return 0;
2802
Jeff Layton7012b022013-06-21 08:58:22 -04002803 lock_get_status(f, fl, iter->li_pos, "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002804
NeilBrownada5c1d2018-11-30 10:04:08 +11002805 list_for_each_entry(bfl, &fl->fl_blocked_requests, fl_blocked_member)
Jeff Layton7012b022013-06-21 08:58:22 -04002806 lock_get_status(f, bfl, iter->li_pos, " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002807
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002808 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809}
2810
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002811static void __show_fd_locks(struct seq_file *f,
2812 struct list_head *head, int *id,
2813 struct file *filp, struct files_struct *files)
2814{
2815 struct file_lock *fl;
2816
2817 list_for_each_entry(fl, head, fl_list) {
2818
2819 if (filp != fl->fl_file)
2820 continue;
2821 if (fl->fl_owner != files &&
2822 fl->fl_owner != filp)
2823 continue;
2824
2825 (*id)++;
2826 seq_puts(f, "lock:\t");
2827 lock_get_status(f, fl, *id, "");
2828 }
2829}
2830
2831void show_fd_locks(struct seq_file *f,
2832 struct file *filp, struct files_struct *files)
2833{
Miklos Szeredic568d682016-09-16 12:44:20 +02002834 struct inode *inode = locks_inode(filp);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002835 struct file_lock_context *ctx;
2836 int id = 0;
2837
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002838 ctx = smp_load_acquire(&inode->i_flctx);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002839 if (!ctx)
2840 return;
2841
2842 spin_lock(&ctx->flc_lock);
2843 __show_fd_locks(f, &ctx->flc_flock, &id, filp, files);
2844 __show_fd_locks(f, &ctx->flc_posix, &id, filp, files);
2845 __show_fd_locks(f, &ctx->flc_lease, &id, filp, files);
2846 spin_unlock(&ctx->flc_lock);
2847}
2848
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002849static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002850 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002851{
Jeff Layton7012b022013-06-21 08:58:22 -04002852 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002853
Jeff Layton7012b022013-06-21 08:58:22 -04002854 iter->li_pos = *pos + 1;
Peter Zijlstraaba37662015-06-22 14:16:33 +02002855 percpu_down_write(&file_rwsem);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002856 spin_lock(&blocked_lock_lock);
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002857 return seq_hlist_start_percpu(&file_lock_list.hlist, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002858}
2859
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002860static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2861{
Jeff Layton7012b022013-06-21 08:58:22 -04002862 struct locks_iterator *iter = f->private;
2863
2864 ++iter->li_pos;
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002865 return seq_hlist_next_percpu(v, &file_lock_list.hlist, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002866}
2867
2868static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002869 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002870{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002871 spin_unlock(&blocked_lock_lock);
Peter Zijlstraaba37662015-06-22 14:16:33 +02002872 percpu_up_write(&file_rwsem);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002873}
2874
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002875static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002876 .start = locks_start,
2877 .next = locks_next,
2878 .stop = locks_stop,
2879 .show = locks_show,
2880};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002881
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002882static int __init proc_locks_init(void)
2883{
Christoph Hellwig44414d82018-04-24 17:05:17 +02002884 proc_create_seq_private("locks", 0, NULL, &locks_seq_operations,
2885 sizeof(struct locks_iterator), NULL);
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002886 return 0;
2887}
Paul Gortmaker91899222015-12-17 14:11:03 -05002888fs_initcall(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002889#endif
2890
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891static int __init filelock_init(void)
2892{
Jeff Layton7012b022013-06-21 08:58:22 -04002893 int i;
2894
Jeff Layton4a075e32015-01-16 15:05:54 -05002895 flctx_cache = kmem_cache_create("file_lock_ctx",
2896 sizeof(struct file_lock_context), 0, SLAB_PANIC, NULL);
2897
Linus Torvalds1da177e2005-04-16 15:20:36 -07002898 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002899 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2900
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002901 for_each_possible_cpu(i) {
2902 struct file_lock_list_struct *fll = per_cpu_ptr(&file_lock_list, i);
2903
2904 spin_lock_init(&fll->lock);
2905 INIT_HLIST_HEAD(&fll->hlist);
2906 }
Jeff Layton7012b022013-06-21 08:58:22 -04002907
Linus Torvalds1da177e2005-04-16 15:20:36 -07002908 return 0;
2909}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002910core_initcall(filelock_init);