blob: c263aff793bc8c7ed264a870fd428a323a494021 [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
14 *
15 * 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
18 *
19 * 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
44 * unlocked).
45 *
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
53 * races. Just grep for FIXME to see them.
54 * 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.
115 */
116
117#include <linux/capability.h>
118#include <linux/file.h>
Al Viro9f3acc32008-04-24 07:44:08 -0400119#include <linux/fdtable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120#include <linux/fs.h>
121#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122#include <linux/security.h>
123#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124#include <linux/syscalls.h>
125#include <linux/time.h>
Dipankar Sarma4fb3a532005-09-16 19:28:13 -0700126#include <linux/rcupdate.h>
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000127#include <linux/pid_namespace.h>
Jeff Layton48f74182013-06-21 08:58:18 -0400128#include <linux/hashtable.h>
Jeff Layton7012b022013-06-21 08:58:22 -0400129#include <linux/percpu.h>
130#include <linux/lglock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
Jeff Layton62af4f12014-05-09 14:13:05 -0400132#define CREATE_TRACE_POINTS
133#include <trace/events/filelock.h>
134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135#include <asm/uaccess.h>
136
137#define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
138#define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
Christoph Hellwig11afe9f2015-01-21 19:17:03 +0100139#define IS_LEASE(fl) (fl->fl_flags & (FL_LEASE|FL_DELEG|FL_LAYOUT))
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400140#define IS_OFDLCK(fl) (fl->fl_flags & FL_OFDLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400142static bool lease_breaking(struct file_lock *fl)
143{
J. Bruce Fields778fc542011-07-26 18:25:49 -0400144 return fl->fl_flags & (FL_UNLOCK_PENDING | FL_DOWNGRADE_PENDING);
145}
146
147static int target_leasetype(struct file_lock *fl)
148{
149 if (fl->fl_flags & FL_UNLOCK_PENDING)
150 return F_UNLCK;
151 if (fl->fl_flags & FL_DOWNGRADE_PENDING)
152 return F_RDLCK;
153 return fl->fl_type;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400154}
155
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156int leases_enable = 1;
157int lease_break_time = 45;
158
Jeff Layton1c8c6012013-06-21 08:58:15 -0400159/*
Jeff Layton7012b022013-06-21 08:58:22 -0400160 * The global file_lock_list is only used for displaying /proc/locks, so we
161 * keep a list on each CPU, with each list protected by its own spinlock via
162 * the file_lock_lglock. Note that alterations to the list also require that
Jeff Layton6109c852015-01-16 15:05:57 -0500163 * the relevant flc_lock is held.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400164 */
Jeff Layton7012b022013-06-21 08:58:22 -0400165DEFINE_STATIC_LGLOCK(file_lock_lglock);
166static DEFINE_PER_CPU(struct hlist_head, file_lock_list);
Jeff Layton88974692013-06-21 08:58:14 -0400167
Jeff Layton1c8c6012013-06-21 08:58:15 -0400168/*
Jeff Layton48f74182013-06-21 08:58:18 -0400169 * The blocked_hash is used to find POSIX lock loops for deadlock detection.
Jeff Layton7b2296a2013-06-21 08:58:20 -0400170 * It is protected by blocked_lock_lock.
Jeff Layton48f74182013-06-21 08:58:18 -0400171 *
172 * We hash locks by lockowner in order to optimize searching for the lock a
173 * particular lockowner is waiting on.
174 *
175 * FIXME: make this value scale via some heuristic? We generally will want more
176 * buckets when we have more lockowners holding locks, but that's a little
177 * difficult to determine without knowing what the workload will look like.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400178 */
Jeff Layton48f74182013-06-21 08:58:18 -0400179#define BLOCKED_HASH_BITS 7
180static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
Jeff Layton88974692013-06-21 08:58:14 -0400181
Jeff Layton1c8c6012013-06-21 08:58:15 -0400182/*
Jeff Layton7b2296a2013-06-21 08:58:20 -0400183 * This lock protects the blocked_hash. Generally, if you're accessing it, you
184 * want to be holding this lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400185 *
186 * In addition, it also protects the fl->fl_block list, and the fl->fl_next
187 * pointer for file_lock structures that are acting as lock requests (in
188 * contrast to those that are acting as records of acquired locks).
189 *
190 * Note that when we acquire this lock in order to change the above fields,
Jeff Layton6109c852015-01-16 15:05:57 -0500191 * we often hold the flc_lock as well. In certain cases, when reading the fields
Jeff Layton1c8c6012013-06-21 08:58:15 -0400192 * protected by this lock, we can skip acquiring it iff we already hold the
Jeff Layton6109c852015-01-16 15:05:57 -0500193 * flc_lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400194 *
195 * In particular, adding an entry to the fl_block list requires that you hold
Jeff Layton6109c852015-01-16 15:05:57 -0500196 * both the flc_lock and the blocked_lock_lock (acquired in that order).
197 * Deleting an entry from the list however only requires the file_lock_lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400198 */
Jeff Layton7b2296a2013-06-21 08:58:20 -0400199static DEFINE_SPINLOCK(blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Jeff Layton4a075e32015-01-16 15:05:54 -0500201static struct kmem_cache *flctx_cache __read_mostly;
Christoph Lametere18b8902006-12-06 20:33:20 -0800202static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
Jeff Layton4a075e32015-01-16 15:05:54 -0500204static struct file_lock_context *
Jeff Layton5c1c6692015-04-03 09:04:03 -0400205locks_get_lock_context(struct inode *inode, int type)
Jeff Layton4a075e32015-01-16 15:05:54 -0500206{
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200207 struct file_lock_context *ctx;
Jeff Layton4a075e32015-01-16 15:05:54 -0500208
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200209 /* paired with cmpxchg() below */
210 ctx = smp_load_acquire(&inode->i_flctx);
211 if (likely(ctx) || type == F_UNLCK)
Jeff Layton4a075e32015-01-16 15:05:54 -0500212 goto out;
213
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200214 ctx = kmem_cache_alloc(flctx_cache, GFP_KERNEL);
215 if (!ctx)
Jeff Layton4a075e32015-01-16 15:05:54 -0500216 goto out;
217
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200218 spin_lock_init(&ctx->flc_lock);
219 INIT_LIST_HEAD(&ctx->flc_flock);
220 INIT_LIST_HEAD(&ctx->flc_posix);
221 INIT_LIST_HEAD(&ctx->flc_lease);
Jeff Layton4a075e32015-01-16 15:05:54 -0500222
223 /*
224 * Assign the pointer if it's not already assigned. If it is, then
225 * free the context we just allocated.
226 */
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200227 if (cmpxchg(&inode->i_flctx, NULL, ctx)) {
228 kmem_cache_free(flctx_cache, ctx);
229 ctx = smp_load_acquire(&inode->i_flctx);
230 }
Jeff Layton4a075e32015-01-16 15:05:54 -0500231out:
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200232 return ctx;
Jeff Layton4a075e32015-01-16 15:05:54 -0500233}
234
235void
236locks_free_lock_context(struct file_lock_context *ctx)
237{
238 if (ctx) {
239 WARN_ON_ONCE(!list_empty(&ctx->flc_flock));
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500240 WARN_ON_ONCE(!list_empty(&ctx->flc_posix));
Jeff Layton8634b512015-01-16 15:05:55 -0500241 WARN_ON_ONCE(!list_empty(&ctx->flc_lease));
Jeff Layton4a075e32015-01-16 15:05:54 -0500242 kmem_cache_free(flctx_cache, ctx);
243 }
244}
245
Miklos Szerediee19cc42011-07-07 13:06:09 +0200246static void locks_init_lock_heads(struct file_lock *fl)
Miklos Szeredia51cb912011-07-06 12:33:55 +0200247{
Jeff Layton139ca042013-06-21 08:58:17 -0400248 INIT_HLIST_NODE(&fl->fl_link);
Jeff Layton6dee60f2015-01-16 15:05:54 -0500249 INIT_LIST_HEAD(&fl->fl_list);
Miklos Szerediee19cc42011-07-07 13:06:09 +0200250 INIT_LIST_HEAD(&fl->fl_block);
251 init_waitqueue_head(&fl->fl_wait);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200252}
253
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200255struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200257 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200258
259 if (fl)
Miklos Szerediee19cc42011-07-07 13:06:09 +0200260 locks_init_lock_heads(fl);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200261
262 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200264EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500266void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500267{
268 if (fl->fl_ops) {
269 if (fl->fl_ops->fl_release_private)
270 fl->fl_ops->fl_release_private(fl);
271 fl->fl_ops = NULL;
272 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500273
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400274 if (fl->fl_lmops) {
Jeff Laytoncae80b32015-04-03 09:04:04 -0400275 if (fl->fl_lmops->lm_put_owner) {
276 fl->fl_lmops->lm_put_owner(fl->fl_owner);
277 fl->fl_owner = NULL;
278 }
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400279 fl->fl_lmops = NULL;
280 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500281}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500282EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284/* Free a lock which is not in use. */
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400285void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286{
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800287 BUG_ON(waitqueue_active(&fl->fl_wait));
Jeff Layton6dee60f2015-01-16 15:05:54 -0500288 BUG_ON(!list_empty(&fl->fl_list));
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800289 BUG_ON(!list_empty(&fl->fl_block));
Jeff Layton139ca042013-06-21 08:58:17 -0400290 BUG_ON(!hlist_unhashed(&fl->fl_link));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
Trond Myklebust47831f32006-03-20 13:44:05 -0500292 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 kmem_cache_free(filelock_cache, fl);
294}
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400295EXPORT_SYMBOL(locks_free_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
Jeff Laytoned9814d2014-08-11 14:20:31 -0400297static void
298locks_dispose_list(struct list_head *dispose)
299{
300 struct file_lock *fl;
301
302 while (!list_empty(dispose)) {
Jeff Layton6dee60f2015-01-16 15:05:54 -0500303 fl = list_first_entry(dispose, struct file_lock, fl_list);
304 list_del_init(&fl->fl_list);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400305 locks_free_lock(fl);
306 }
307}
308
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309void locks_init_lock(struct file_lock *fl)
310{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200311 memset(fl, 0, sizeof(struct file_lock));
312 locks_init_lock_heads(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313}
314
315EXPORT_SYMBOL(locks_init_lock);
316
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317/*
318 * Initialize a new lock from an existing file_lock structure.
319 */
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400320void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321{
322 new->fl_owner = fl->fl_owner;
323 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500324 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 new->fl_flags = fl->fl_flags;
326 new->fl_type = fl->fl_type;
327 new->fl_start = fl->fl_start;
328 new->fl_end = fl->fl_end;
Kinglong Meef3282962014-08-22 10:18:43 -0400329 new->fl_lmops = fl->fl_lmops;
Trond Myklebust09969052006-03-20 13:44:38 -0500330 new->fl_ops = NULL;
Kinglong Meef3282962014-08-22 10:18:43 -0400331
332 if (fl->fl_lmops) {
333 if (fl->fl_lmops->lm_get_owner)
Jeff Laytoncae80b32015-04-03 09:04:04 -0400334 fl->fl_lmops->lm_get_owner(fl->fl_owner);
Kinglong Meef3282962014-08-22 10:18:43 -0400335 }
Trond Myklebust09969052006-03-20 13:44:38 -0500336}
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400337EXPORT_SYMBOL(locks_copy_conflock);
Trond Myklebust09969052006-03-20 13:44:38 -0500338
339void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
340{
Jeff Layton566709b2014-08-11 14:09:35 -0400341 /* "new" must be a freshly-initialized lock */
342 WARN_ON_ONCE(new->fl_ops);
Trond Myklebust09969052006-03-20 13:44:38 -0500343
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400344 locks_copy_conflock(new, fl);
Kinglong Meef3282962014-08-22 10:18:43 -0400345
Trond Myklebust09969052006-03-20 13:44:38 -0500346 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 new->fl_ops = fl->fl_ops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500348
Kinglong Meef3282962014-08-22 10:18:43 -0400349 if (fl->fl_ops) {
350 if (fl->fl_ops->fl_copy_lock)
351 fl->fl_ops->fl_copy_lock(new, fl);
352 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353}
354
355EXPORT_SYMBOL(locks_copy_lock);
356
357static inline int flock_translate_cmd(int cmd) {
358 if (cmd & LOCK_MAND)
359 return cmd & (LOCK_MAND | LOCK_RW);
360 switch (cmd) {
361 case LOCK_SH:
362 return F_RDLCK;
363 case LOCK_EX:
364 return F_WRLCK;
365 case LOCK_UN:
366 return F_UNLCK;
367 }
368 return -EINVAL;
369}
370
371/* Fill in a file_lock structure with an appropriate FLOCK lock. */
Jeff Layton6e129d002014-09-04 10:25:06 -0400372static struct file_lock *
373flock_make_lock(struct file *filp, unsigned int cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374{
375 struct file_lock *fl;
376 int type = flock_translate_cmd(cmd);
Jeff Layton6e129d002014-09-04 10:25:06 -0400377
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 if (type < 0)
Jeff Layton6e129d002014-09-04 10:25:06 -0400379 return ERR_PTR(type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
381 fl = locks_alloc_lock();
382 if (fl == NULL)
Jeff Layton6e129d002014-09-04 10:25:06 -0400383 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
385 fl->fl_file = filp;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +0200386 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 fl->fl_pid = current->tgid;
388 fl->fl_flags = FL_FLOCK;
389 fl->fl_type = type;
390 fl->fl_end = OFFSET_MAX;
391
Jeff Layton6e129d002014-09-04 10:25:06 -0400392 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393}
394
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400395static int assign_type(struct file_lock *fl, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396{
397 switch (type) {
398 case F_RDLCK:
399 case F_WRLCK:
400 case F_UNLCK:
401 fl->fl_type = type;
402 break;
403 default:
404 return -EINVAL;
405 }
406 return 0;
407}
408
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500409static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
410 struct flock64 *l)
411{
412 switch (l->l_whence) {
413 case SEEK_SET:
414 fl->fl_start = 0;
415 break;
416 case SEEK_CUR:
417 fl->fl_start = filp->f_pos;
418 break;
419 case SEEK_END:
420 fl->fl_start = i_size_read(file_inode(filp));
421 break;
422 default:
423 return -EINVAL;
424 }
425 if (l->l_start > OFFSET_MAX - fl->fl_start)
426 return -EOVERFLOW;
427 fl->fl_start += l->l_start;
428 if (fl->fl_start < 0)
429 return -EINVAL;
430
431 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
432 POSIX-2001 defines it. */
433 if (l->l_len > 0) {
434 if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
435 return -EOVERFLOW;
436 fl->fl_end = fl->fl_start + l->l_len - 1;
437
438 } else if (l->l_len < 0) {
439 if (fl->fl_start + l->l_len < 0)
440 return -EINVAL;
441 fl->fl_end = fl->fl_start - 1;
442 fl->fl_start += l->l_len;
443 } else
444 fl->fl_end = OFFSET_MAX;
445
446 fl->fl_owner = current->files;
447 fl->fl_pid = current->tgid;
448 fl->fl_file = filp;
449 fl->fl_flags = FL_POSIX;
450 fl->fl_ops = NULL;
451 fl->fl_lmops = NULL;
452
453 return assign_type(fl, l->l_type);
454}
455
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
457 * style lock.
458 */
459static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
460 struct flock *l)
461{
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500462 struct flock64 ll = {
463 .l_type = l->l_type,
464 .l_whence = l->l_whence,
465 .l_start = l->l_start,
466 .l_len = l->l_len,
467 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500469 return flock64_to_posix_lock(filp, fl, &ll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470}
471
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472/* default lease lock manager operations */
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400473static bool
474lease_break_callback(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475{
476 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400477 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478}
479
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400480static void
481lease_setup(struct file_lock *fl, void **priv)
482{
483 struct file *filp = fl->fl_file;
484 struct fasync_struct *fa = *priv;
485
486 /*
487 * fasync_insert_entry() returns the old entry if any. If there was no
488 * old entry, then it used "priv" and inserted it into the fasync list.
489 * Clear the pointer to indicate that it shouldn't be freed.
490 */
491 if (!fasync_insert_entry(fa->fa_fd, filp, &fl->fl_fasync, fa))
492 *priv = NULL;
493
494 __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
495}
496
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700497static const struct lock_manager_operations lease_manager_ops = {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400498 .lm_break = lease_break_callback,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400499 .lm_change = lease_modify,
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400500 .lm_setup = lease_setup,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501};
502
503/*
504 * Initialize a lease, use the default lock manager operations
505 */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400506static int lease_init(struct file *filp, long type, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 {
Trond Myklebust75dff552006-05-07 23:02:42 -0400508 if (assign_type(fl, type) != 0)
509 return -EINVAL;
510
Jeff Layton7ca76312014-09-01 19:04:48 -0400511 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 fl->fl_pid = current->tgid;
513
514 fl->fl_file = filp;
515 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 fl->fl_start = 0;
517 fl->fl_end = OFFSET_MAX;
518 fl->fl_ops = NULL;
519 fl->fl_lmops = &lease_manager_ops;
520 return 0;
521}
522
523/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400524static struct file_lock *lease_alloc(struct file *filp, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525{
526 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400527 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
529 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500530 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531
532 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400533 if (error) {
534 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500535 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400536 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500537 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538}
539
540/* Check if two locks overlap each other.
541 */
542static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
543{
544 return ((fl1->fl_end >= fl2->fl_start) &&
545 (fl2->fl_end >= fl1->fl_start));
546}
547
548/*
549 * Check whether two locks have the same owner.
550 */
Matt Mackall33443c42006-01-08 01:05:22 -0800551static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552{
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400553 if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 return fl2->fl_lmops == fl1->fl_lmops &&
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400555 fl1->fl_lmops->lm_compare_owner(fl1, fl2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 return fl1->fl_owner == fl2->fl_owner;
557}
558
Jeff Layton6109c852015-01-16 15:05:57 -0500559/* Must be called with the flc_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500560static void locks_insert_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400561{
Jeff Layton7012b022013-06-21 08:58:22 -0400562 lg_local_lock(&file_lock_lglock);
563 fl->fl_link_cpu = smp_processor_id();
564 hlist_add_head(&fl->fl_link, this_cpu_ptr(&file_lock_list));
565 lg_local_unlock(&file_lock_lglock);
Jeff Layton88974692013-06-21 08:58:14 -0400566}
567
Jeff Layton6109c852015-01-16 15:05:57 -0500568/* Must be called with the flc_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500569static void locks_delete_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400570{
Jeff Layton7012b022013-06-21 08:58:22 -0400571 /*
572 * Avoid taking lock if already unhashed. This is safe since this check
Jeff Layton6109c852015-01-16 15:05:57 -0500573 * is done while holding the flc_lock, and new insertions into the list
Jeff Layton7012b022013-06-21 08:58:22 -0400574 * also require that it be held.
575 */
576 if (hlist_unhashed(&fl->fl_link))
577 return;
578 lg_local_lock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton139ca042013-06-21 08:58:17 -0400579 hlist_del_init(&fl->fl_link);
Jeff Layton7012b022013-06-21 08:58:22 -0400580 lg_local_unlock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton88974692013-06-21 08:58:14 -0400581}
582
Jeff Layton3999e492013-06-21 08:58:19 -0400583static unsigned long
584posix_owner_key(struct file_lock *fl)
585{
586 if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
587 return fl->fl_lmops->lm_owner_key(fl);
588 return (unsigned long)fl->fl_owner;
589}
590
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500591static void locks_insert_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400592{
Daniel Wagner663d5af2015-04-03 09:04:03 -0400593 lockdep_assert_held(&blocked_lock_lock);
594
Jeff Layton3999e492013-06-21 08:58:19 -0400595 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
Jeff Layton88974692013-06-21 08:58:14 -0400596}
597
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500598static void locks_delete_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400599{
Daniel Wagner663d5af2015-04-03 09:04:03 -0400600 lockdep_assert_held(&blocked_lock_lock);
601
Jeff Layton48f74182013-06-21 08:58:18 -0400602 hash_del(&waiter->fl_link);
Jeff Layton88974692013-06-21 08:58:14 -0400603}
604
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605/* Remove waiter from blocker's block list.
606 * When blocker ends up pointing to itself then the list is empty.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400607 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400608 * Must be called with blocked_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 */
Matt Mackall33443c42006-01-08 01:05:22 -0800610static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611{
Jeff Layton88974692013-06-21 08:58:14 -0400612 locks_delete_global_blocked(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 list_del_init(&waiter->fl_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 waiter->fl_next = NULL;
615}
616
Jeff Layton1a9e64a2013-06-21 08:58:10 -0400617static void locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400619 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 __locks_delete_block(waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400621 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622}
623
624/* Insert waiter into blocker's block list.
625 * We use a circular list so that processes can be easily woken up in
626 * the order they blocked. The documentation doesn't require this but
627 * it seems like the reasonable thing to do.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400628 *
Jeff Layton6109c852015-01-16 15:05:57 -0500629 * Must be called with both the flc_lock and blocked_lock_lock held. The
630 * fl_block list itself is protected by the blocked_lock_lock, but by ensuring
631 * that the flc_lock is also held on insertions we can avoid taking the
632 * blocked_lock_lock in some cases when we see that the fl_block list is empty.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400634static void __locks_insert_block(struct file_lock *blocker,
635 struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636{
J. Bruce Fields6dc0fe82006-03-26 01:37:24 -0800637 BUG_ON(!list_empty(&waiter->fl_block));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 waiter->fl_next = blocker;
Jeff Layton88974692013-06-21 08:58:14 -0400639 list_add_tail(&waiter->fl_block, &blocker->fl_block);
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400640 if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400641 locks_insert_global_blocked(waiter);
642}
643
Jeff Layton6109c852015-01-16 15:05:57 -0500644/* Must be called with flc_lock held. */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400645static void locks_insert_block(struct file_lock *blocker,
646 struct file_lock *waiter)
647{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400648 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400649 __locks_insert_block(blocker, waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400650 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651}
652
Jeff Layton1cb36012013-06-21 08:58:12 -0400653/*
654 * Wake up processes blocked waiting for blocker.
655 *
Jeff Layton6109c852015-01-16 15:05:57 -0500656 * Must be called with the inode->flc_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 */
658static void locks_wake_up_blocks(struct file_lock *blocker)
659{
Jeff Layton4e8c7652013-06-21 08:58:16 -0400660 /*
661 * Avoid taking global lock if list is empty. This is safe since new
Jeff Layton6109c852015-01-16 15:05:57 -0500662 * blocked requests are only added to the list under the flc_lock, and
663 * the flc_lock is always held here. Note that removal from the fl_block
664 * list does not require the flc_lock, so we must recheck list_empty()
Jeff Layton7b2296a2013-06-21 08:58:20 -0400665 * after acquiring the blocked_lock_lock.
Jeff Layton4e8c7652013-06-21 08:58:16 -0400666 */
667 if (list_empty(&blocker->fl_block))
668 return;
669
Jeff Layton7b2296a2013-06-21 08:58:20 -0400670 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 while (!list_empty(&blocker->fl_block)) {
Pavel Emelyanovf0c1cd02007-09-19 16:44:07 +0400672 struct file_lock *waiter;
673
674 waiter = list_first_entry(&blocker->fl_block,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 struct file_lock, fl_block);
676 __locks_delete_block(waiter);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400677 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
678 waiter->fl_lmops->lm_notify(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 else
680 wake_up(&waiter->fl_wait);
681 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400682 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683}
684
Jeff Layton5263e312015-01-16 15:05:55 -0500685static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500686locks_insert_lock_ctx(struct file_lock *fl, struct list_head *before)
Jeff Layton5263e312015-01-16 15:05:55 -0500687{
688 fl->fl_nspid = get_pid(task_tgid(current));
689 list_add_tail(&fl->fl_list, before);
690 locks_insert_global_locks(fl);
691}
692
Jeff Layton8634b512015-01-16 15:05:55 -0500693static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500694locks_unlink_lock_ctx(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695{
Jeff Layton88974692013-06-21 08:58:14 -0400696 locks_delete_global_locks(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500697 list_del_init(&fl->fl_list);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000698 if (fl->fl_nspid) {
699 put_pid(fl->fl_nspid);
700 fl->fl_nspid = NULL;
701 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 locks_wake_up_blocks(fl);
Jeff Layton24cbe782014-02-03 12:13:06 -0500703}
704
Jeff Layton5263e312015-01-16 15:05:55 -0500705static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500706locks_delete_lock_ctx(struct file_lock *fl, struct list_head *dispose)
Jeff Layton5263e312015-01-16 15:05:55 -0500707{
Jeff Laytone084c1b2015-02-16 14:32:03 -0500708 locks_unlink_lock_ctx(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500709 if (dispose)
710 list_add(&fl->fl_list, dispose);
711 else
712 locks_free_lock(fl);
Jeff Layton5263e312015-01-16 15:05:55 -0500713}
714
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
716 * checks for shared/exclusive status of overlapping locks.
717 */
718static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
719{
720 if (sys_fl->fl_type == F_WRLCK)
721 return 1;
722 if (caller_fl->fl_type == F_WRLCK)
723 return 1;
724 return 0;
725}
726
727/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
728 * checking before calling the locks_conflict().
729 */
730static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
731{
732 /* POSIX locks owned by the same process do not conflict with
733 * each other.
734 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400735 if (posix_same_owner(caller_fl, sys_fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 return (0);
737
738 /* Check whether they overlap */
739 if (!locks_overlap(caller_fl, sys_fl))
740 return 0;
741
742 return (locks_conflict(caller_fl, sys_fl));
743}
744
745/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
746 * checking before calling the locks_conflict().
747 */
748static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
749{
750 /* FLOCK locks referring to the same filp do not conflict with
751 * each other.
752 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400753 if (caller_fl->fl_file == sys_fl->fl_file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 return (0);
755 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
756 return 0;
757
758 return (locks_conflict(caller_fl, sys_fl));
759}
760
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400761void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500762posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763{
764 struct file_lock *cfl;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500765 struct file_lock_context *ctx;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400766 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200768 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500769 if (!ctx || list_empty_careful(&ctx->flc_posix)) {
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400770 fl->fl_type = F_UNLCK;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500771 return;
772 }
773
Jeff Layton6109c852015-01-16 15:05:57 -0500774 spin_lock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500775 list_for_each_entry(cfl, &ctx->flc_posix, fl_list) {
776 if (posix_locks_conflict(fl, cfl)) {
777 locks_copy_conflock(fl, cfl);
778 if (cfl->fl_nspid)
779 fl->fl_pid = pid_vnr(cfl->fl_nspid);
780 goto out;
781 }
782 }
783 fl->fl_type = F_UNLCK;
784out:
Jeff Layton6109c852015-01-16 15:05:57 -0500785 spin_unlock(&ctx->flc_lock);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400786 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788EXPORT_SYMBOL(posix_test_lock);
789
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400790/*
791 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400793 * We attempt to detect deadlocks that are due purely to posix file
794 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400796 * We assume that a task can be waiting for at most one lock at a time.
797 * So for any acquired lock, the process holding that lock may be
798 * waiting on at most one other lock. That lock in turns may be held by
799 * someone waiting for at most one other lock. Given a requested lock
800 * caller_fl which is about to wait for a conflicting lock block_fl, we
801 * follow this chain of waiters to ensure we are not about to create a
802 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400803 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400804 * Since we do this before we ever put a process to sleep on a lock, we
805 * are ensured that there is never a cycle; that is what guarantees that
806 * the while() loop in posix_locks_deadlock() eventually completes.
807 *
808 * Note: the above assumption may not be true when handling lock
809 * requests from a broken NFS client. It may also fail in the presence
810 * of tasks (such as posix threads) sharing the same open file table.
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400811 * To handle those cases, we just bail out after a few iterations.
Jeff Layton57b65322014-02-03 12:13:09 -0500812 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400813 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
Jeff Layton57b65322014-02-03 12:13:09 -0500814 * Because the owner is not even nominally tied to a thread of
815 * execution, the deadlock detection below can't reasonably work well. Just
816 * skip it for those.
817 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400818 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
Jeff Layton57b65322014-02-03 12:13:09 -0500819 * locks that just checks for the case where two tasks are attempting to
820 * upgrade from read to write locks on the same inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400822
823#define MAX_DEADLK_ITERATIONS 10
824
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400825/* Find a lock that the owner of the given block_fl is blocking on. */
826static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
827{
828 struct file_lock *fl;
829
Jeff Layton3999e492013-06-21 08:58:19 -0400830 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400831 if (posix_same_owner(fl, block_fl))
832 return fl->fl_next;
833 }
834 return NULL;
835}
836
Jeff Layton7b2296a2013-06-21 08:58:20 -0400837/* Must be called with the blocked_lock_lock held! */
Adrian Bunkb0904e12006-06-23 02:05:13 -0700838static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 struct file_lock *block_fl)
840{
J. Bruce Fields97855b42007-10-30 11:20:02 -0400841 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842
Daniel Wagner663d5af2015-04-03 09:04:03 -0400843 lockdep_assert_held(&blocked_lock_lock);
844
Jeff Layton57b65322014-02-03 12:13:09 -0500845 /*
846 * This deadlock detector can't reasonably detect deadlocks with
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400847 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
Jeff Layton57b65322014-02-03 12:13:09 -0500848 */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400849 if (IS_OFDLCK(caller_fl))
Jeff Layton57b65322014-02-03 12:13:09 -0500850 return 0;
851
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400852 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
853 if (i++ > MAX_DEADLK_ITERATIONS)
854 return 0;
855 if (posix_same_owner(caller_fl, block_fl))
856 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 }
858 return 0;
859}
860
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -0400862 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -0400863 *
864 * Note that if called with an FL_EXISTS argument, the caller may determine
865 * whether or not a lock was successfully freed by testing the return
866 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 */
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -0400868static int flock_lock_inode(struct inode *inode, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869{
Trond Myklebust993dfa82006-03-31 02:30:55 -0800870 struct file_lock *new_fl = NULL;
Jeff Layton5263e312015-01-16 15:05:55 -0500871 struct file_lock *fl;
872 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 int error = 0;
Jeff Layton5263e312015-01-16 15:05:55 -0500874 bool found = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -0400875 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876
Jeff Layton5c1c6692015-04-03 09:04:03 -0400877 ctx = locks_get_lock_context(inode, request->fl_type);
878 if (!ctx) {
879 if (request->fl_type != F_UNLCK)
880 return -ENOMEM;
881 return (request->fl_flags & FL_EXISTS) ? -ENOENT : 0;
882 }
Jeff Layton5263e312015-01-16 15:05:55 -0500883
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200884 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
885 new_fl = locks_alloc_lock();
886 if (!new_fl)
887 return -ENOMEM;
888 }
889
Jeff Layton6109c852015-01-16 15:05:57 -0500890 spin_lock(&ctx->flc_lock);
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400891 if (request->fl_flags & FL_ACCESS)
892 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +0400893
Jeff Layton5263e312015-01-16 15:05:55 -0500894 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -0400895 if (request->fl_file != fl->fl_file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800897 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 goto out;
Jeff Layton5263e312015-01-16 15:05:55 -0500899 found = true;
Jeff Laytone084c1b2015-02-16 14:32:03 -0500900 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 break;
902 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903
Trond Myklebustf475ae92006-06-29 16:38:32 -0400904 if (request->fl_type == F_UNLCK) {
905 if ((request->fl_flags & FL_EXISTS) && !found)
906 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800907 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400908 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400910find_conflict:
Jeff Layton5263e312015-01-16 15:05:55 -0500911 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Trond Myklebust993dfa82006-03-31 02:30:55 -0800912 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 continue;
914 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700915 if (!(request->fl_flags & FL_SLEEP))
916 goto out;
917 error = FILE_LOCK_DEFERRED;
918 locks_insert_block(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 goto out;
920 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400921 if (request->fl_flags & FL_ACCESS)
922 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800923 locks_copy_lock(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -0500924 locks_insert_lock_ctx(new_fl, &ctx->flc_flock);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800925 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +0400926 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927
928out:
Jeff Layton6109c852015-01-16 15:05:57 -0500929 spin_unlock(&ctx->flc_lock);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800930 if (new_fl)
931 locks_free_lock(new_fl);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400932 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 return error;
934}
935
Marc Eshel150b3932007-01-18 16:15:35 -0500936static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500938 struct file_lock *fl, *tmp;
Miklos Szeredi39005d02006-06-23 02:05:10 -0700939 struct file_lock *new_fl = NULL;
940 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 struct file_lock *left = NULL;
942 struct file_lock *right = NULL;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500943 struct file_lock_context *ctx;
Jeff Laytonb9746ef2013-06-21 08:58:13 -0400944 int error;
945 bool added = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -0400946 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947
Jeff Layton5c1c6692015-04-03 09:04:03 -0400948 ctx = locks_get_lock_context(inode, request->fl_type);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500949 if (!ctx)
Jeff Layton5c1c6692015-04-03 09:04:03 -0400950 return (request->fl_type == F_UNLCK) ? 0 : -ENOMEM;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500951
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 /*
953 * We may need two file_lock structures for this operation,
954 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -0700955 *
956 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 */
Miklos Szeredi39005d02006-06-23 02:05:10 -0700958 if (!(request->fl_flags & FL_ACCESS) &&
959 (request->fl_type != F_UNLCK ||
960 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
961 new_fl = locks_alloc_lock();
962 new_fl2 = locks_alloc_lock();
963 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964
Jeff Layton6109c852015-01-16 15:05:57 -0500965 spin_lock(&ctx->flc_lock);
Jeff Layton1cb36012013-06-21 08:58:12 -0400966 /*
967 * New lock request. Walk all POSIX locks and look for conflicts. If
968 * there are any, either return error or put the request on the
Jeff Layton48f74182013-06-21 08:58:18 -0400969 * blocker's list of waiters and the global blocked_hash.
Jeff Layton1cb36012013-06-21 08:58:12 -0400970 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 if (request->fl_type != F_UNLCK) {
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500972 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 if (!posix_locks_conflict(request, fl))
974 continue;
Andy Adamson5842add2006-03-26 01:37:26 -0800975 if (conflock)
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400976 locks_copy_conflock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 error = -EAGAIN;
978 if (!(request->fl_flags & FL_SLEEP))
979 goto out;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400980 /*
981 * Deadlock detection and insertion into the blocked
982 * locks list must be done while holding the same lock!
983 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 error = -EDEADLK;
Jeff Layton7b2296a2013-06-21 08:58:20 -0400985 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400986 if (likely(!posix_locks_deadlock(request, fl))) {
987 error = FILE_LOCK_DEFERRED;
988 __locks_insert_block(fl, request);
989 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400990 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 goto out;
992 }
993 }
994
995 /* If we're just looking for a conflict, we're done. */
996 error = 0;
997 if (request->fl_flags & FL_ACCESS)
998 goto out;
999
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001000 /* Find the first old lock with the same owner as the new lock */
1001 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1002 if (posix_same_owner(request, fl))
1003 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 }
1005
Jeff Layton1cb36012013-06-21 08:58:12 -04001006 /* Process locks with this owner. */
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001007 list_for_each_entry_safe_from(fl, tmp, &ctx->flc_posix, fl_list) {
1008 if (!posix_same_owner(request, fl))
1009 break;
1010
1011 /* Detect adjacent or overlapping regions (if same lock type) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -07001013 /* In all comparisons of start vs end, use
1014 * "start - 1" rather than "end + 1". If end
1015 * is OFFSET_MAX, end + 1 will become negative.
1016 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 if (fl->fl_end < request->fl_start - 1)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001018 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 /* If the next lock in the list has entirely bigger
1020 * addresses than the new one, insert the lock here.
1021 */
Olaf Kirch449231d2005-08-25 16:25:35 -07001022 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 break;
1024
1025 /* If we come here, the new and old lock are of the
1026 * same type and adjacent or overlapping. Make one
1027 * lock yielding from the lower start address of both
1028 * locks to the higher end address.
1029 */
1030 if (fl->fl_start > request->fl_start)
1031 fl->fl_start = request->fl_start;
1032 else
1033 request->fl_start = fl->fl_start;
1034 if (fl->fl_end < request->fl_end)
1035 fl->fl_end = request->fl_end;
1036 else
1037 request->fl_end = fl->fl_end;
1038 if (added) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001039 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 continue;
1041 }
1042 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001043 added = true;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001044 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 /* Processing for different lock types is a bit
1046 * more complex.
1047 */
1048 if (fl->fl_end < request->fl_start)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001049 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 if (fl->fl_start > request->fl_end)
1051 break;
1052 if (request->fl_type == F_UNLCK)
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001053 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 if (fl->fl_start < request->fl_start)
1055 left = fl;
1056 /* If the next lock in the list has a higher end
1057 * address than the new one, insert the new one here.
1058 */
1059 if (fl->fl_end > request->fl_end) {
1060 right = fl;
1061 break;
1062 }
1063 if (fl->fl_start >= request->fl_start) {
1064 /* The new lock completely replaces an old
1065 * one (This may happen several times).
1066 */
1067 if (added) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001068 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 continue;
1070 }
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001071 /*
1072 * Replace the old lock with new_fl, and
1073 * remove the old one. It's safe to do the
1074 * insert here since we know that we won't be
1075 * using new_fl later, and that the lock is
1076 * just replacing an existing lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 */
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001078 error = -ENOLCK;
1079 if (!new_fl)
1080 goto out;
1081 locks_copy_lock(new_fl, request);
1082 request = new_fl;
1083 new_fl = NULL;
Jeff Laytone084c1b2015-02-16 14:32:03 -05001084 locks_insert_lock_ctx(request, &fl->fl_list);
1085 locks_delete_lock_ctx(fl, &dispose);
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001086 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 }
1088 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 }
1090
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001091 /*
Jeff Layton1cb36012013-06-21 08:58:12 -04001092 * The above code only modifies existing locks in case of merging or
1093 * replacing. If new lock(s) need to be inserted all modifications are
1094 * done below this, so it's safe yet to bail out.
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001095 */
1096 error = -ENOLCK; /* "no luck" */
1097 if (right && left == right && !new_fl2)
1098 goto out;
1099
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 error = 0;
1101 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -04001102 if (request->fl_type == F_UNLCK) {
1103 if (request->fl_flags & FL_EXISTS)
1104 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001106 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001107
1108 if (!new_fl) {
1109 error = -ENOLCK;
1110 goto out;
1111 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 locks_copy_lock(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001113 locks_insert_lock_ctx(new_fl, &fl->fl_list);
Jeff Layton2e2f756f2015-02-17 17:08:23 -05001114 fl = new_fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 new_fl = NULL;
1116 }
1117 if (right) {
1118 if (left == right) {
1119 /* The new lock breaks the old one in two pieces,
1120 * so we have to use the second new lock.
1121 */
1122 left = new_fl2;
1123 new_fl2 = NULL;
1124 locks_copy_lock(left, right);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001125 locks_insert_lock_ctx(left, &fl->fl_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 }
1127 right->fl_start = request->fl_end + 1;
1128 locks_wake_up_blocks(right);
1129 }
1130 if (left) {
1131 left->fl_end = request->fl_start - 1;
1132 locks_wake_up_blocks(left);
1133 }
1134 out:
Jeff Layton6109c852015-01-16 15:05:57 -05001135 spin_unlock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 /*
1137 * Free any unused locks.
1138 */
1139 if (new_fl)
1140 locks_free_lock(new_fl);
1141 if (new_fl2)
1142 locks_free_lock(new_fl2);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001143 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 return error;
1145}
1146
1147/**
1148 * posix_lock_file - Apply a POSIX-style lock to a file
1149 * @filp: The file to apply the lock to
1150 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001151 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 *
1153 * Add a POSIX style lock to a file.
1154 * We merge adjacent & overlapping locks whenever possible.
1155 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001156 *
1157 * Note that if called with an FL_EXISTS argument, the caller may determine
1158 * whether or not a lock was successfully freed by testing the return
1159 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 */
Marc Eshel150b3932007-01-18 16:15:35 -05001161int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001162 struct file_lock *conflock)
1163{
Al Viro496ad9a2013-01-23 17:07:38 -05001164 return __posix_lock_file(file_inode(filp), fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001165}
Marc Eshel150b3932007-01-18 16:15:35 -05001166EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167
1168/**
Jeff Layton29d01b22015-07-11 06:43:02 -04001169 * posix_lock_inode_wait - Apply a POSIX-style lock to a file
1170 * @inode: inode of file to which lock request should be applied
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 * @fl: The lock to be applied
1172 *
Benjamin Coddington616fb382015-10-22 13:38:15 -04001173 * Apply a POSIX style lock request to an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 */
Benjamin Coddington616fb382015-10-22 13:38:15 -04001175static int posix_lock_inode_wait(struct inode *inode, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176{
1177 int error;
1178 might_sleep ();
1179 for (;;) {
Jeff Layton29d01b22015-07-11 06:43:02 -04001180 error = __posix_lock_file(inode, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001181 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 break;
1183 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1184 if (!error)
1185 continue;
1186
1187 locks_delete_block(fl);
1188 break;
1189 }
1190 return error;
1191}
Jeff Layton29d01b22015-07-11 06:43:02 -04001192
Jeff Layton9e8925b2015-11-16 09:49:34 -05001193#ifdef CONFIG_MANDATORY_FILE_LOCKING
Jeff Layton29d01b22015-07-11 06:43:02 -04001194/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195 * locks_mandatory_locked - Check for an active lock
Jeff Laytond7a06982014-03-10 09:54:15 -04001196 * @file: the file to check
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 *
1198 * Searches the inode's list of locks to find any POSIX locks which conflict.
1199 * This function is called from locks_verify_locked() only.
1200 */
Jeff Laytond7a06982014-03-10 09:54:15 -04001201int locks_mandatory_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001203 int ret;
Jeff Laytond7a06982014-03-10 09:54:15 -04001204 struct inode *inode = file_inode(file);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001205 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 struct file_lock *fl;
1207
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001208 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001209 if (!ctx || list_empty_careful(&ctx->flc_posix))
1210 return 0;
1211
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212 /*
1213 * Search the lock list for this inode for any POSIX locks.
1214 */
Jeff Layton6109c852015-01-16 15:05:57 -05001215 spin_lock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001216 ret = 0;
1217 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001218 if (fl->fl_owner != current->files &&
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001219 fl->fl_owner != file) {
1220 ret = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 break;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001222 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 }
Jeff Layton6109c852015-01-16 15:05:57 -05001224 spin_unlock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001225 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226}
1227
1228/**
1229 * locks_mandatory_area - Check for a conflicting lock
1230 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1231 * for shared
1232 * @inode: the file to check
1233 * @filp: how the file was opened (if it was)
1234 * @offset: start of area to check
1235 * @count: length of area to check
1236 *
1237 * Searches the inode's list of locks to find any POSIX locks which conflict.
1238 * This function is called from rw_verify_area() and
1239 * locks_verify_truncate().
1240 */
1241int locks_mandatory_area(int read_write, struct inode *inode,
1242 struct file *filp, loff_t offset,
1243 size_t count)
1244{
1245 struct file_lock fl;
1246 int error;
Jeff Layton29723ad2014-03-10 09:54:19 -04001247 bool sleep = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248
1249 locks_init_lock(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 fl.fl_pid = current->tgid;
1251 fl.fl_file = filp;
1252 fl.fl_flags = FL_POSIX | FL_ACCESS;
1253 if (filp && !(filp->f_flags & O_NONBLOCK))
Jeff Layton29723ad2014-03-10 09:54:19 -04001254 sleep = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1256 fl.fl_start = offset;
1257 fl.fl_end = offset + count - 1;
1258
1259 for (;;) {
Jeff Layton29723ad2014-03-10 09:54:19 -04001260 if (filp) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001261 fl.fl_owner = filp;
Jeff Layton29723ad2014-03-10 09:54:19 -04001262 fl.fl_flags &= ~FL_SLEEP;
1263 error = __posix_lock_file(inode, &fl, NULL);
1264 if (!error)
1265 break;
1266 }
1267
1268 if (sleep)
1269 fl.fl_flags |= FL_SLEEP;
1270 fl.fl_owner = current->files;
Marc Eshel150b3932007-01-18 16:15:35 -05001271 error = __posix_lock_file(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001272 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 break;
1274 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1275 if (!error) {
1276 /*
1277 * If we've been sleeping someone might have
1278 * changed the permissions behind our back.
1279 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001280 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 continue;
1282 }
1283
1284 locks_delete_block(&fl);
1285 break;
1286 }
1287
1288 return error;
1289}
1290
1291EXPORT_SYMBOL(locks_mandatory_area);
Jeff Layton9e8925b2015-11-16 09:49:34 -05001292#endif /* CONFIG_MANDATORY_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293
J. Bruce Fields778fc542011-07-26 18:25:49 -04001294static void lease_clear_pending(struct file_lock *fl, int arg)
1295{
1296 switch (arg) {
1297 case F_UNLCK:
1298 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1299 /* fall through: */
1300 case F_RDLCK:
1301 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1302 }
1303}
1304
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305/* We already had a lease on this file; just change its type */
Jeff Layton7448cc32015-01-16 15:05:57 -05001306int lease_modify(struct file_lock *fl, int arg, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 int error = assign_type(fl, arg);
1309
1310 if (error)
1311 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001312 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001314 if (arg == F_UNLCK) {
1315 struct file *filp = fl->fl_file;
1316
1317 f_delown(filp);
1318 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001319 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1320 if (fl->fl_fasync != NULL) {
1321 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1322 fl->fl_fasync = NULL;
1323 }
Jeff Laytone084c1b2015-02-16 14:32:03 -05001324 locks_delete_lock_ctx(fl, dispose);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001325 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 return 0;
1327}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328EXPORT_SYMBOL(lease_modify);
1329
J. Bruce Fields778fc542011-07-26 18:25:49 -04001330static bool past_time(unsigned long then)
1331{
1332 if (!then)
1333 /* 0 is a special value meaning "this never expires": */
1334 return false;
1335 return time_after(jiffies, then);
1336}
1337
Jeff Laytonc45198e2014-09-01 07:12:07 -04001338static void time_out_leases(struct inode *inode, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339{
Jeff Layton8634b512015-01-16 15:05:55 -05001340 struct file_lock_context *ctx = inode->i_flctx;
1341 struct file_lock *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342
Jeff Layton6109c852015-01-16 15:05:57 -05001343 lockdep_assert_held(&ctx->flc_lock);
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001344
Jeff Layton8634b512015-01-16 15:05:55 -05001345 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001346 trace_time_out_leases(inode, fl);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001347 if (past_time(fl->fl_downgrade_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001348 lease_modify(fl, F_RDLCK, dispose);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001349 if (past_time(fl->fl_break_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001350 lease_modify(fl, F_UNLCK, dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 }
1352}
1353
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001354static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1355{
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001356 if ((breaker->fl_flags & FL_LAYOUT) != (lease->fl_flags & FL_LAYOUT))
1357 return false;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001358 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1359 return false;
1360 return locks_conflict(breaker, lease);
1361}
1362
Jeff Layton03d12dd2014-09-01 14:53:41 -04001363static bool
1364any_leases_conflict(struct inode *inode, struct file_lock *breaker)
1365{
Jeff Layton8634b512015-01-16 15:05:55 -05001366 struct file_lock_context *ctx = inode->i_flctx;
Jeff Layton03d12dd2014-09-01 14:53:41 -04001367 struct file_lock *fl;
1368
Jeff Layton6109c852015-01-16 15:05:57 -05001369 lockdep_assert_held(&ctx->flc_lock);
Jeff Layton03d12dd2014-09-01 14:53:41 -04001370
Jeff Layton8634b512015-01-16 15:05:55 -05001371 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Jeff Layton03d12dd2014-09-01 14:53:41 -04001372 if (leases_conflict(fl, breaker))
1373 return true;
1374 }
1375 return false;
1376}
1377
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378/**
1379 * __break_lease - revoke all outstanding leases on file
1380 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001381 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1382 * break all leases
1383 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1384 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 *
david m. richter87250dd2007-05-09 16:10:27 -04001386 * break_lease (inlined for speed) has checked there already is at least
1387 * some kind of lock (maybe a lease) on this file. Leases are broken on
1388 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 * specified %O_NONBLOCK to your open().
1390 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001391int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001393 int error = 0;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001394 struct file_lock_context *ctx;
Yan, Zhenga9011252015-03-27 10:34:20 +08001395 struct file_lock *new_fl, *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 unsigned long break_time;
Al Viro8737c932009-12-24 06:47:55 -05001397 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001398 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399
Al Viro8737c932009-12-24 06:47:55 -05001400 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001401 if (IS_ERR(new_fl))
1402 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001403 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404
Jeff Layton8634b512015-01-16 15:05:55 -05001405 /* typically we will check that ctx is non-NULL before calling */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001406 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001407 if (!ctx) {
1408 WARN_ON_ONCE(1);
1409 return error;
1410 }
1411
Jeff Layton6109c852015-01-16 15:05:57 -05001412 spin_lock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413
Jeff Laytonc45198e2014-09-01 07:12:07 -04001414 time_out_leases(inode, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
Jeff Layton03d12dd2014-09-01 14:53:41 -04001416 if (!any_leases_conflict(inode, new_fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001417 goto out;
1418
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 break_time = 0;
1420 if (lease_break_time > 0) {
1421 break_time = jiffies + lease_break_time * HZ;
1422 if (break_time == 0)
1423 break_time++; /* so that 0 means no break time */
1424 }
1425
Yan, Zhenga9011252015-03-27 10:34:20 +08001426 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001427 if (!leases_conflict(fl, new_fl))
1428 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001429 if (want_write) {
1430 if (fl->fl_flags & FL_UNLOCK_PENDING)
1431 continue;
1432 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001434 } else {
Jeff Layton8634b512015-01-16 15:05:55 -05001435 if (lease_breaking(fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001436 continue;
1437 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1438 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 }
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001440 if (fl->fl_lmops->lm_break(fl))
Jeff Laytone084c1b2015-02-16 14:32:03 -05001441 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 }
1443
Jeff Layton8634b512015-01-16 15:05:55 -05001444 if (list_empty(&ctx->flc_lease))
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001445 goto out;
1446
Jeff Layton843c6b22014-09-01 14:27:43 -04001447 if (mode & O_NONBLOCK) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001448 trace_break_lease_noblock(inode, new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 error = -EWOULDBLOCK;
1450 goto out;
1451 }
1452
1453restart:
Jeff Layton8634b512015-01-16 15:05:55 -05001454 fl = list_first_entry(&ctx->flc_lease, struct file_lock, fl_list);
1455 break_time = fl->fl_break_time;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001456 if (break_time != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 break_time -= jiffies;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001458 if (break_time == 0)
1459 break_time++;
Jeff Layton8634b512015-01-16 15:05:55 -05001460 locks_insert_block(fl, new_fl);
Jeff Layton62af4f12014-05-09 14:13:05 -04001461 trace_break_lease_block(inode, new_fl);
Jeff Layton6109c852015-01-16 15:05:57 -05001462 spin_unlock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001463 locks_dispose_list(&dispose);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001464 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1465 !new_fl->fl_next, break_time);
Jeff Layton6109c852015-01-16 15:05:57 -05001466 spin_lock(&ctx->flc_lock);
Jeff Layton62af4f12014-05-09 14:13:05 -04001467 trace_break_lease_unblock(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001468 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 if (error >= 0) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001470 /*
1471 * Wait for the next conflicting lease that has not been
1472 * broken yet
1473 */
Jeff Layton03d12dd2014-09-01 14:53:41 -04001474 if (error == 0)
1475 time_out_leases(inode, &dispose);
1476 if (any_leases_conflict(inode, new_fl))
1477 goto restart;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 error = 0;
1479 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480out:
Jeff Layton6109c852015-01-16 15:05:57 -05001481 spin_unlock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001482 locks_dispose_list(&dispose);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001483 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 return error;
1485}
1486
1487EXPORT_SYMBOL(__break_lease);
1488
1489/**
Randy Dunlapa6b91912008-03-19 17:01:00 -07001490 * lease_get_mtime - get the last modified time of an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491 * @inode: the inode
1492 * @time: pointer to a timespec which will contain the last modified time
1493 *
1494 * This is to force NFS clients to flush their caches for files with
1495 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001496 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 */
1498void lease_get_mtime(struct inode *inode, struct timespec *time)
1499{
Jeff Laytonbfe86022014-08-22 10:18:44 -04001500 bool has_lease = false;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001501 struct file_lock_context *ctx;
Jeff Layton8634b512015-01-16 15:05:55 -05001502 struct file_lock *fl;
Jeff Laytonbfe86022014-08-22 10:18:44 -04001503
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001504 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001505 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Jeff Layton6109c852015-01-16 15:05:57 -05001506 spin_lock(&ctx->flc_lock);
Geliang Tang8ace5df2015-11-18 21:40:33 +08001507 fl = list_first_entry_or_null(&ctx->flc_lease,
1508 struct file_lock, fl_list);
1509 if (fl && (fl->fl_type == F_WRLCK))
1510 has_lease = true;
Jeff Layton6109c852015-01-16 15:05:57 -05001511 spin_unlock(&ctx->flc_lock);
Jeff Laytonbfe86022014-08-22 10:18:44 -04001512 }
1513
1514 if (has_lease)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 *time = current_fs_time(inode->i_sb);
1516 else
1517 *time = inode->i_mtime;
1518}
1519
1520EXPORT_SYMBOL(lease_get_mtime);
1521
1522/**
1523 * fcntl_getlease - Enquire what lease is currently active
1524 * @filp: the file
1525 *
1526 * The value returned by this function will be one of
1527 * (if no lease break is pending):
1528 *
1529 * %F_RDLCK to indicate a shared lease is held.
1530 *
1531 * %F_WRLCK to indicate an exclusive lease is held.
1532 *
1533 * %F_UNLCK to indicate no lease is held.
1534 *
1535 * (if a lease break is pending):
1536 *
1537 * %F_RDLCK to indicate an exclusive lease needs to be
1538 * changed to a shared lease (or removed).
1539 *
1540 * %F_UNLCK to indicate the lease needs to be removed.
1541 *
1542 * XXX: sfr & willy disagree over whether F_INPROGRESS
1543 * should be returned to userspace.
1544 */
1545int fcntl_getlease(struct file *filp)
1546{
1547 struct file_lock *fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001548 struct inode *inode = file_inode(filp);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001549 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 int type = F_UNLCK;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001551 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001553 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001554 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Jeff Layton6109c852015-01-16 15:05:57 -05001555 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001556 time_out_leases(file_inode(filp), &dispose);
1557 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1558 if (fl->fl_file != filp)
1559 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001560 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 break;
1562 }
Jeff Layton6109c852015-01-16 15:05:57 -05001563 spin_unlock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001564 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 return type;
1567}
1568
Jeff Layton24cbe782014-02-03 12:13:06 -05001569/**
1570 * check_conflicting_open - see if the given dentry points to a file that has
1571 * an existing open that would conflict with the
1572 * desired lease.
1573 * @dentry: dentry to check
1574 * @arg: type of lease that we're trying to acquire
Randy Dunlap7fadc592015-08-09 18:43:17 -07001575 * @flags: current lock flags
Jeff Layton24cbe782014-02-03 12:13:06 -05001576 *
1577 * Check to see if there's an existing open fd on this file that would
1578 * conflict with the lease we're trying to set.
1579 */
1580static int
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001581check_conflicting_open(const struct dentry *dentry, const long arg, int flags)
Jeff Layton24cbe782014-02-03 12:13:06 -05001582{
1583 int ret = 0;
1584 struct inode *inode = dentry->d_inode;
1585
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001586 if (flags & FL_LAYOUT)
1587 return 0;
1588
Jeff Layton24cbe782014-02-03 12:13:06 -05001589 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1590 return -EAGAIN;
1591
1592 if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1593 (atomic_read(&inode->i_count) > 1)))
1594 ret = -EAGAIN;
1595
1596 return ret;
1597}
1598
Jeff Laytone6f5c782014-08-22 10:40:25 -04001599static int
1600generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601{
Jeff Layton8634b512015-01-16 15:05:55 -05001602 struct file_lock *fl, *my_fl = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001603 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 struct inode *inode = dentry->d_inode;
Jeff Layton8634b512015-01-16 15:05:55 -05001605 struct file_lock_context *ctx;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001606 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001607 int error;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001608 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609
J. Bruce Fields096657b2010-10-30 17:31:14 -04001610 lease = *flp;
Jeff Layton62af4f12014-05-09 14:13:05 -04001611 trace_generic_add_lease(inode, lease);
1612
Jeff Layton5c1c6692015-04-03 09:04:03 -04001613 /* Note that arg is never F_UNLCK here */
1614 ctx = locks_get_lock_context(inode, arg);
Jeff Layton8634b512015-01-16 15:05:55 -05001615 if (!ctx)
1616 return -ENOMEM;
1617
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001618 /*
1619 * In the delegation case we need mutual exclusion with
1620 * a number of operations that take the i_mutex. We trylock
1621 * because delegations are an optional optimization, and if
1622 * there's some chance of a conflict--we'd rather not
1623 * bother, maybe that's a sign this just isn't a good file to
1624 * hand out a delegation on.
1625 */
1626 if (is_deleg && !mutex_trylock(&inode->i_mutex))
1627 return -EAGAIN;
1628
1629 if (is_deleg && arg == F_WRLCK) {
1630 /* Write delegations are not currently supported: */
Dan Carpenter4fdb7932013-11-13 10:56:27 +03001631 mutex_unlock(&inode->i_mutex);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001632 WARN_ON_ONCE(1);
1633 return -EINVAL;
1634 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001635
Jeff Layton6109c852015-01-16 15:05:57 -05001636 spin_lock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001637 time_out_leases(inode, &dispose);
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001638 error = check_conflicting_open(dentry, arg, lease->fl_flags);
Jeff Layton24cbe782014-02-03 12:13:06 -05001639 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001640 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001641
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642 /*
1643 * At this point, we know that if there is an exclusive
1644 * lease on this file, then we hold it on this filp
1645 * (otherwise our open of this file would have blocked).
1646 * And if we are trying to acquire an exclusive lease,
1647 * then the file is not open by anyone (including us)
1648 * except for this filp.
1649 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001650 error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001651 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001652 if (fl->fl_file == filp &&
1653 fl->fl_owner == lease->fl_owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001654 my_fl = fl;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001655 continue;
1656 }
Jeff Layton8634b512015-01-16 15:05:55 -05001657
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001658 /*
1659 * No exclusive leases if someone else has a lease on
1660 * this file:
1661 */
1662 if (arg == F_WRLCK)
1663 goto out;
1664 /*
1665 * Modifying our existing lease is OK, but no getting a
1666 * new lease if someone else is opening for write:
1667 */
1668 if (fl->fl_flags & FL_UNLOCK_PENDING)
1669 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 }
1671
Jeff Layton8634b512015-01-16 15:05:55 -05001672 if (my_fl != NULL) {
Jeff Layton0164bf02015-03-04 17:34:32 -05001673 lease = my_fl;
1674 error = lease->fl_lmops->lm_change(lease, arg, &dispose);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001675 if (error)
1676 goto out;
1677 goto out_setup;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 }
1679
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 error = -EINVAL;
1681 if (!leases_enable)
1682 goto out;
1683
Jeff Laytone084c1b2015-02-16 14:32:03 -05001684 locks_insert_lock_ctx(lease, &ctx->flc_lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001685 /*
1686 * The check in break_lease() is lockless. It's possible for another
1687 * open to race in after we did the earlier check for a conflicting
1688 * open but before the lease was inserted. Check again for a
1689 * conflicting open and cancel the lease if there is one.
1690 *
1691 * We also add a barrier here to ensure that the insertion of the lock
1692 * precedes these checks.
1693 */
1694 smp_mb();
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001695 error = check_conflicting_open(dentry, arg, lease->fl_flags);
Jeff Layton8634b512015-01-16 15:05:55 -05001696 if (error) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001697 locks_unlink_lock_ctx(lease);
Jeff Layton8634b512015-01-16 15:05:55 -05001698 goto out;
1699 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001700
1701out_setup:
1702 if (lease->fl_lmops->lm_setup)
1703 lease->fl_lmops->lm_setup(lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704out:
Jeff Layton6109c852015-01-16 15:05:57 -05001705 spin_unlock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001706 locks_dispose_list(&dispose);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001707 if (is_deleg)
1708 mutex_unlock(&inode->i_mutex);
Jeff Layton8634b512015-01-16 15:05:55 -05001709 if (!error && !my_fl)
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001710 *flp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711 return error;
1712}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001713
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001714static int generic_delete_lease(struct file *filp, void *owner)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001715{
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001716 int error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001717 struct file_lock *fl, *victim = NULL;
Benjamin Coddington6ca7d912015-10-15 09:07:07 -04001718 struct inode *inode = file_inode(filp);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001719 struct file_lock_context *ctx;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001720 LIST_HEAD(dispose);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001721
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001722 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001723 if (!ctx) {
1724 trace_generic_delete_lease(inode, NULL);
1725 return error;
1726 }
1727
Jeff Layton6109c852015-01-16 15:05:57 -05001728 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001729 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001730 if (fl->fl_file == filp &&
1731 fl->fl_owner == owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001732 victim = fl;
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001733 break;
Jeff Layton8634b512015-01-16 15:05:55 -05001734 }
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001735 }
Jeff Laytona9b1b452015-03-14 09:45:35 -04001736 trace_generic_delete_lease(inode, victim);
Jeff Layton8634b512015-01-16 15:05:55 -05001737 if (victim)
Jeff Layton7448cc32015-01-16 15:05:57 -05001738 error = fl->fl_lmops->lm_change(victim, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05001739 spin_unlock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001740 locks_dispose_list(&dispose);
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001741 return error;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001742}
1743
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744/**
1745 * generic_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001746 * @filp: file pointer
1747 * @arg: type of lease to obtain
1748 * @flp: input - file_lock to use, output - file_lock inserted
1749 * @priv: private data for lm_setup (may be NULL if lm_setup
1750 * doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 *
1752 * The (input) flp->fl_lmops->lm_break function is required
1753 * by break_lease().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001755int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
1756 void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757{
Benjamin Coddington6ca7d912015-10-15 09:07:07 -04001758 struct inode *inode = file_inode(filp);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001759 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001761 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001762 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001764 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765 error = security_file_lock(filp, arg);
1766 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001767 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001769 switch (arg) {
1770 case F_UNLCK:
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001771 return generic_delete_lease(filp, *priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001772 case F_RDLCK:
1773 case F_WRLCK:
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001774 if (!(*flp)->fl_lmops->lm_break) {
1775 WARN_ON_ONCE(1);
1776 return -ENOLCK;
1777 }
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001778
Jeff Laytone6f5c782014-08-22 10:40:25 -04001779 return generic_add_lease(filp, arg, flp, priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001780 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001781 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001784EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001786/**
Jeff Laytone51673a2014-08-22 18:13:28 -04001787 * vfs_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001788 * @filp: file pointer
1789 * @arg: type of lease to obtain
1790 * @lease: file_lock to use when adding a lease
1791 * @priv: private info for lm_setup when adding a lease (may be
1792 * NULL if lm_setup doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 *
Jeff Laytone51673a2014-08-22 18:13:28 -04001794 * Call this to establish a lease on the file. The "lease" argument is not
1795 * used for F_UNLCK requests and may be NULL. For commands that set or alter
1796 * an existing lease, the (*lease)->fl_lmops->lm_break operation must be set;
1797 * if not, this function will return -ENOLCK (and generate a scary-looking
1798 * stack trace).
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001799 *
1800 * The "priv" pointer is passed directly to the lm_setup function as-is. It
1801 * may be NULL if the lm_setup operation doesn't require it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001803int
1804vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805{
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001806 if (filp->f_op->setlease)
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001807 return filp->f_op->setlease(filp, arg, lease, priv);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001808 else
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001809 return generic_setlease(filp, arg, lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001811EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001813static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814{
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001815 struct file_lock *fl;
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001816 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817 int error;
1818
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001819 fl = lease_alloc(filp, arg);
1820 if (IS_ERR(fl))
1821 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001823 new = fasync_alloc();
1824 if (!new) {
1825 locks_free_lock(fl);
1826 return -ENOMEM;
1827 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001828 new->fa_fd = fd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001830 error = vfs_setlease(filp, arg, &fl, (void **)&new);
Jeff Layton2dfb9282014-08-11 18:14:12 -04001831 if (fl)
1832 locks_free_lock(fl);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001833 if (new)
1834 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835 return error;
1836}
1837
1838/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001839 * fcntl_setlease - sets a lease on an open file
1840 * @fd: open file descriptor
1841 * @filp: file pointer
1842 * @arg: type of lease to obtain
1843 *
1844 * Call this fcntl to establish a lease on the file.
1845 * Note that you also need to call %F_SETSIG to
1846 * receive a signal when the lease is broken.
1847 */
1848int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1849{
1850 if (arg == F_UNLCK)
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001851 return vfs_setlease(filp, F_UNLCK, NULL, (void **)&filp);
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001852 return do_fcntl_add_lease(fd, filp, arg);
1853}
1854
1855/**
Jeff Layton29d01b22015-07-11 06:43:02 -04001856 * flock_lock_inode_wait - Apply a FLOCK-style lock to a file
1857 * @inode: inode of the file to apply to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 * @fl: The lock to be applied
1859 *
Jeff Layton29d01b22015-07-11 06:43:02 -04001860 * Apply a FLOCK style lock request to an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861 */
Benjamin Coddington616fb382015-10-22 13:38:15 -04001862static int flock_lock_inode_wait(struct inode *inode, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863{
1864 int error;
1865 might_sleep();
1866 for (;;) {
Jeff Layton29d01b22015-07-11 06:43:02 -04001867 error = flock_lock_inode(inode, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001868 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869 break;
1870 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1871 if (!error)
1872 continue;
1873
1874 locks_delete_block(fl);
1875 break;
1876 }
1877 return error;
1878}
1879
Jeff Layton29d01b22015-07-11 06:43:02 -04001880/**
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001881 * locks_lock_inode_wait - Apply a lock to an inode
1882 * @inode: inode of the file to apply to
1883 * @fl: The lock to be applied
1884 *
1885 * Apply a POSIX or FLOCK style lock request to an inode.
1886 */
1887int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1888{
1889 int res = 0;
1890 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
1891 case FL_POSIX:
1892 res = posix_lock_inode_wait(inode, fl);
1893 break;
1894 case FL_FLOCK:
1895 res = flock_lock_inode_wait(inode, fl);
1896 break;
1897 default:
1898 BUG();
1899 }
1900 return res;
1901}
1902EXPORT_SYMBOL(locks_lock_inode_wait);
1903
1904/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905 * sys_flock: - flock() system call.
1906 * @fd: the file descriptor to lock.
1907 * @cmd: the type of lock to apply.
1908 *
1909 * Apply a %FL_FLOCK style lock to an open file descriptor.
1910 * The @cmd can be one of
1911 *
1912 * %LOCK_SH -- a shared lock.
1913 *
1914 * %LOCK_EX -- an exclusive lock.
1915 *
1916 * %LOCK_UN -- remove an existing lock.
1917 *
1918 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1919 *
1920 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1921 * processes read and write access respectively.
1922 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001923SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924{
Al Viro2903ff02012-08-28 12:52:22 -04001925 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 struct file_lock *lock;
1927 int can_sleep, unlock;
1928 int error;
1929
1930 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001931 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932 goto out;
1933
1934 can_sleep = !(cmd & LOCK_NB);
1935 cmd &= ~LOCK_NB;
1936 unlock = (cmd == LOCK_UN);
1937
Al Viroaeb5d722008-09-02 15:28:45 -04001938 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04001939 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 goto out_putf;
1941
Jeff Layton6e129d002014-09-04 10:25:06 -04001942 lock = flock_make_lock(f.file, cmd);
1943 if (IS_ERR(lock)) {
1944 error = PTR_ERR(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945 goto out_putf;
Jeff Layton6e129d002014-09-04 10:25:06 -04001946 }
1947
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 if (can_sleep)
1949 lock->fl_flags |= FL_SLEEP;
1950
Al Viro2903ff02012-08-28 12:52:22 -04001951 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 if (error)
1953 goto out_free;
1954
Al Viro72c2d532013-09-22 16:27:52 -04001955 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04001956 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 (can_sleep) ? F_SETLKW : F_SETLK,
1958 lock);
1959 else
Benjamin Coddington4f656362015-10-22 13:38:14 -04001960 error = locks_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961
1962 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08001963 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964
1965 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04001966 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 out:
1968 return error;
1969}
1970
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001971/**
1972 * vfs_test_lock - test file byte range lock
1973 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04001974 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001975 *
1976 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1977 * setting conf->fl_type to something other than F_UNLCK.
1978 */
1979int vfs_test_lock(struct file *filp, struct file_lock *fl)
1980{
Al Viro72c2d532013-09-22 16:27:52 -04001981 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001982 return filp->f_op->lock(filp, F_GETLK, fl);
1983 posix_test_lock(filp, fl);
1984 return 0;
1985}
1986EXPORT_SYMBOL_GPL(vfs_test_lock);
1987
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001988static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1989{
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001990 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001991#if BITS_PER_LONG == 32
1992 /*
1993 * Make sure we can represent the posix lock via
1994 * legacy 32bit flock.
1995 */
1996 if (fl->fl_start > OFFT_OFFSET_MAX)
1997 return -EOVERFLOW;
1998 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1999 return -EOVERFLOW;
2000#endif
2001 flock->l_start = fl->fl_start;
2002 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2003 fl->fl_end - fl->fl_start + 1;
2004 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04002005 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002006 return 0;
2007}
2008
2009#if BITS_PER_LONG == 32
2010static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
2011{
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002012 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002013 flock->l_start = fl->fl_start;
2014 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2015 fl->fl_end - fl->fl_start + 1;
2016 flock->l_whence = 0;
2017 flock->l_type = fl->fl_type;
2018}
2019#endif
2020
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021/* Report the first existing lock that would conflict with l.
2022 * This implements the F_GETLK command of fcntl().
2023 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05002024int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002026 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027 struct flock flock;
2028 int error;
2029
2030 error = -EFAULT;
2031 if (copy_from_user(&flock, l, sizeof(flock)))
2032 goto out;
2033 error = -EINVAL;
2034 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2035 goto out;
2036
2037 error = flock_to_posix_lock(filp, &file_lock, &flock);
2038 if (error)
2039 goto out;
2040
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002041 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002042 error = -EINVAL;
2043 if (flock.l_pid != 0)
2044 goto out;
2045
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002046 cmd = F_GETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002047 file_lock.fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002048 file_lock.fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002049 }
2050
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002051 error = vfs_test_lock(filp, &file_lock);
2052 if (error)
2053 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002055 flock.l_type = file_lock.fl_type;
2056 if (file_lock.fl_type != F_UNLCK) {
2057 error = posix_lock_to_flock(&flock, &file_lock);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002058 if (error)
Kinglong Meef3282962014-08-22 10:18:43 -04002059 goto rel_priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 }
2061 error = -EFAULT;
2062 if (!copy_to_user(l, &flock, sizeof(flock)))
2063 error = 0;
Kinglong Meef3282962014-08-22 10:18:43 -04002064rel_priv:
2065 locks_release_private(&file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066out:
2067 return error;
2068}
2069
Marc Eshel7723ec92007-01-18 15:08:55 -05002070/**
2071 * vfs_lock_file - file byte range lock
2072 * @filp: The file to apply the lock to
2073 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2074 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05002075 * @conf: Place to return a copy of the conflicting lock, if found.
2076 *
2077 * A caller that doesn't care about the conflicting lock may pass NULL
2078 * as the final argument.
2079 *
2080 * If the filesystem defines a private ->lock() method, then @conf will
2081 * be left unchanged; so a caller that cares should initialize it to
2082 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05002083 *
2084 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2085 * locks, the ->lock() interface may return asynchronously, before the lock has
2086 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002087 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05002088 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2089 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002090 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05002091 * request completes.
2092 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07002093 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2094 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05002095 * nonzero return code and the file system should release the lock. The file
2096 * system is also responsible to keep a corresponding posix lock when it
2097 * grants a lock so the VFS can find out which locks are locally held and do
2098 * the correct lock cleanup when required.
2099 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002100 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05002101 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05002102 */
Marc Eshel150b3932007-01-18 16:15:35 -05002103int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05002104{
Al Viro72c2d532013-09-22 16:27:52 -04002105 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05002106 return filp->f_op->lock(filp, cmd, fl);
2107 else
Marc Eshel150b3932007-01-18 16:15:35 -05002108 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05002109}
2110EXPORT_SYMBOL_GPL(vfs_lock_file);
2111
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002112static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2113 struct file_lock *fl)
2114{
2115 int error;
2116
2117 error = security_file_lock(filp, fl->fl_type);
2118 if (error)
2119 return error;
2120
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002121 for (;;) {
2122 error = vfs_lock_file(filp, cmd, fl, NULL);
2123 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002124 break;
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002125 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
2126 if (!error)
2127 continue;
2128
2129 locks_delete_block(fl);
2130 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002131 }
2132
2133 return error;
2134}
2135
Benjamin Coddington6ca7d912015-10-15 09:07:07 -04002136/* Ensure that fl->fl_file has compatible f_mode for F_SETLK calls */
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002137static int
2138check_fmode_for_setlk(struct file_lock *fl)
2139{
2140 switch (fl->fl_type) {
2141 case F_RDLCK:
2142 if (!(fl->fl_file->f_mode & FMODE_READ))
2143 return -EBADF;
2144 break;
2145 case F_WRLCK:
2146 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2147 return -EBADF;
2148 }
2149 return 0;
2150}
2151
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152/* Apply the lock described by l to an open file descriptor.
2153 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2154 */
Peter Staubachc2936212005-07-27 11:45:09 -07002155int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
2156 struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157{
2158 struct file_lock *file_lock = locks_alloc_lock();
2159 struct flock flock;
2160 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002161 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 int error;
2163
2164 if (file_lock == NULL)
2165 return -ENOLCK;
2166
2167 /*
2168 * This might block, so we do it before checking the inode.
2169 */
2170 error = -EFAULT;
2171 if (copy_from_user(&flock, l, sizeof(flock)))
2172 goto out;
2173
Al Viro496ad9a2013-01-23 17:07:38 -05002174 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175
2176 /* Don't allow mandatory locks on files that may be memory mapped
2177 * and shared.
2178 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002179 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 error = -EAGAIN;
2181 goto out;
2182 }
2183
2184 error = flock_to_posix_lock(filp, file_lock, &flock);
2185 if (error)
2186 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002187
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002188 error = check_fmode_for_setlk(file_lock);
2189 if (error)
2190 goto out;
2191
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002192 /*
2193 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002194 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002195 */
2196 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002197 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002198 error = -EINVAL;
2199 if (flock.l_pid != 0)
2200 goto out;
2201
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002202 cmd = F_SETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002203 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002204 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002205 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002206 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002207 error = -EINVAL;
2208 if (flock.l_pid != 0)
2209 goto out;
2210
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002211 cmd = F_SETLKW;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002212 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002213 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002214 /* Fallthrough */
2215 case F_SETLKW:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 file_lock->fl_flags |= FL_SLEEP;
2217 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002218
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002219 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220
Peter Staubachc2936212005-07-27 11:45:09 -07002221 /*
2222 * Attempt to detect a close/fcntl race and recover by
2223 * releasing the lock that was just acquired.
2224 */
Jeff Layton7f3697e2016-01-07 16:38:10 -05002225 if (!error && file_lock->fl_type != F_UNLCK) {
2226 /*
2227 * We need that spin_lock here - it prevents reordering between
2228 * update of i_flctx->flc_posix and check for it done in
2229 * close(). rcu_read_lock() wouldn't do.
2230 */
2231 spin_lock(&current->files->file_lock);
2232 f = fcheck(fd);
2233 spin_unlock(&current->files->file_lock);
2234 if (f != filp) {
2235 file_lock->fl_type = F_UNLCK;
2236 error = do_lock_file_wait(filp, cmd, file_lock);
2237 WARN_ON_ONCE(error);
2238 error = -EBADF;
2239 }
Peter Staubachc2936212005-07-27 11:45:09 -07002240 }
Peter Staubachc2936212005-07-27 11:45:09 -07002241out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 locks_free_lock(file_lock);
2243 return error;
2244}
2245
2246#if BITS_PER_LONG == 32
2247/* Report the first existing lock that would conflict with l.
2248 * This implements the F_GETLK command of fcntl().
2249 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05002250int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002252 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 struct flock64 flock;
2254 int error;
2255
2256 error = -EFAULT;
2257 if (copy_from_user(&flock, l, sizeof(flock)))
2258 goto out;
2259 error = -EINVAL;
2260 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2261 goto out;
2262
2263 error = flock64_to_posix_lock(filp, &file_lock, &flock);
2264 if (error)
2265 goto out;
2266
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002267 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002268 error = -EINVAL;
2269 if (flock.l_pid != 0)
2270 goto out;
2271
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002272 cmd = F_GETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002273 file_lock.fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002274 file_lock.fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002275 }
2276
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002277 error = vfs_test_lock(filp, &file_lock);
2278 if (error)
2279 goto out;
2280
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002281 flock.l_type = file_lock.fl_type;
2282 if (file_lock.fl_type != F_UNLCK)
2283 posix_lock_to_flock64(&flock, &file_lock);
2284
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285 error = -EFAULT;
2286 if (!copy_to_user(l, &flock, sizeof(flock)))
2287 error = 0;
Kinglong Meef3282962014-08-22 10:18:43 -04002288
2289 locks_release_private(&file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002290out:
2291 return error;
2292}
2293
2294/* Apply the lock described by l to an open file descriptor.
2295 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2296 */
Peter Staubachc2936212005-07-27 11:45:09 -07002297int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2298 struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299{
2300 struct file_lock *file_lock = locks_alloc_lock();
2301 struct flock64 flock;
2302 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002303 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304 int error;
2305
2306 if (file_lock == NULL)
2307 return -ENOLCK;
2308
2309 /*
2310 * This might block, so we do it before checking the inode.
2311 */
2312 error = -EFAULT;
2313 if (copy_from_user(&flock, l, sizeof(flock)))
2314 goto out;
2315
Al Viro496ad9a2013-01-23 17:07:38 -05002316 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317
2318 /* Don't allow mandatory locks on files that may be memory mapped
2319 * and shared.
2320 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002321 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 error = -EAGAIN;
2323 goto out;
2324 }
2325
2326 error = flock64_to_posix_lock(filp, file_lock, &flock);
2327 if (error)
2328 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002329
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002330 error = check_fmode_for_setlk(file_lock);
2331 if (error)
2332 goto out;
2333
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002334 /*
2335 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002336 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002337 */
2338 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002339 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002340 error = -EINVAL;
2341 if (flock.l_pid != 0)
2342 goto out;
2343
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002344 cmd = F_SETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002345 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002346 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002347 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002348 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002349 error = -EINVAL;
2350 if (flock.l_pid != 0)
2351 goto out;
2352
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002353 cmd = F_SETLKW64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002354 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002355 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002356 /* Fallthrough */
2357 case F_SETLKW64:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358 file_lock->fl_flags |= FL_SLEEP;
2359 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002360
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002361 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362
Peter Staubachc2936212005-07-27 11:45:09 -07002363 /*
2364 * Attempt to detect a close/fcntl race and recover by
2365 * releasing the lock that was just acquired.
2366 */
Jeff Layton7f3697e2016-01-07 16:38:10 -05002367 if (!error && file_lock->fl_type != F_UNLCK) {
2368 /*
2369 * We need that spin_lock here - it prevents reordering between
2370 * update of i_flctx->flc_posix and check for it done in
2371 * close(). rcu_read_lock() wouldn't do.
2372 */
2373 spin_lock(&current->files->file_lock);
2374 f = fcheck(fd);
2375 spin_unlock(&current->files->file_lock);
2376 if (f != filp) {
2377 file_lock->fl_type = F_UNLCK;
2378 error = do_lock_file_wait(filp, cmd, file_lock);
2379 WARN_ON_ONCE(error);
2380 error = -EBADF;
2381 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383out:
2384 locks_free_lock(file_lock);
2385 return error;
2386}
2387#endif /* BITS_PER_LONG == 32 */
2388
2389/*
2390 * This function is called when the file is being removed
2391 * from the task's fd array. POSIX locks belonging to this task
2392 * are deleted at this time.
2393 */
2394void locks_remove_posix(struct file *filp, fl_owner_t owner)
2395{
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002396 struct file_lock lock;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002397 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398
2399 /*
2400 * If there are no locks held on this file, we don't need to call
2401 * posix_lock_file(). Another process could be setting a lock on this
2402 * file at the same time, but we wouldn't remove that lock anyway.
2403 */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002404 ctx = smp_load_acquire(&file_inode(filp)->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05002405 if (!ctx || list_empty(&ctx->flc_posix))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002406 return;
2407
2408 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002409 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002410 lock.fl_start = 0;
2411 lock.fl_end = OFFSET_MAX;
2412 lock.fl_owner = owner;
2413 lock.fl_pid = current->tgid;
2414 lock.fl_file = filp;
2415 lock.fl_ops = NULL;
2416 lock.fl_lmops = NULL;
2417
Marc Eshel150b3932007-01-18 16:15:35 -05002418 vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419
Linus Torvalds1da177e2005-04-16 15:20:36 -07002420 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2421 lock.fl_ops->fl_release_private(&lock);
2422}
2423
2424EXPORT_SYMBOL(locks_remove_posix);
2425
Jeff Layton3d8e5602015-01-16 15:05:58 -05002426/* The i_flctx must be valid when calling into here */
Jeff Laytondd459bb2015-01-16 15:05:54 -05002427static void
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002428locks_remove_flock(struct file *filp, struct file_lock_context *flctx)
Jeff Laytondd459bb2015-01-16 15:05:54 -05002429{
2430 struct file_lock fl = {
2431 .fl_owner = filp,
2432 .fl_pid = current->tgid,
2433 .fl_file = filp,
2434 .fl_flags = FL_FLOCK,
2435 .fl_type = F_UNLCK,
2436 .fl_end = OFFSET_MAX,
2437 };
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04002438 struct inode *inode = file_inode(filp);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002439
Jeff Layton3d8e5602015-01-16 15:05:58 -05002440 if (list_empty(&flctx->flc_flock))
Jeff Laytondd459bb2015-01-16 15:05:54 -05002441 return;
2442
2443 if (filp->f_op->flock)
2444 filp->f_op->flock(filp, F_SETLKW, &fl);
2445 else
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04002446 flock_lock_inode(inode, &fl);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002447
2448 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2449 fl.fl_ops->fl_release_private(&fl);
2450}
2451
Jeff Layton3d8e5602015-01-16 15:05:58 -05002452/* The i_flctx must be valid when calling into here */
Jeff Layton8634b512015-01-16 15:05:55 -05002453static void
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002454locks_remove_lease(struct file *filp, struct file_lock_context *ctx)
Jeff Layton8634b512015-01-16 15:05:55 -05002455{
Jeff Layton8634b512015-01-16 15:05:55 -05002456 struct file_lock *fl, *tmp;
2457 LIST_HEAD(dispose);
2458
Jeff Layton3d8e5602015-01-16 15:05:58 -05002459 if (list_empty(&ctx->flc_lease))
Jeff Layton8634b512015-01-16 15:05:55 -05002460 return;
2461
Jeff Layton6109c852015-01-16 15:05:57 -05002462 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05002463 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list)
Jeff Laytonc4e136c2015-02-16 19:37:42 -05002464 if (filp == fl->fl_file)
2465 lease_modify(fl, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05002466 spin_unlock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05002467 locks_dispose_list(&dispose);
2468}
2469
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470/*
2471 * This function is called on the last close of an open file.
2472 */
Jeff Layton78ed8a12014-02-03 12:13:08 -05002473void locks_remove_file(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474{
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002475 struct file_lock_context *ctx;
2476
2477 ctx = smp_load_acquire(&file_inode(filp)->i_flctx);
2478 if (!ctx)
Jeff Layton3d8e5602015-01-16 15:05:58 -05002479 return;
2480
Jeff Laytondd459bb2015-01-16 15:05:54 -05002481 /* remove any OFD locks */
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002482 locks_remove_posix(filp, filp);
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002483
Jeff Laytondd459bb2015-01-16 15:05:54 -05002484 /* remove flock locks */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002485 locks_remove_flock(filp, ctx);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002486
Jeff Layton8634b512015-01-16 15:05:55 -05002487 /* remove any leases */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002488 locks_remove_lease(filp, ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489}
2490
2491/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492 * posix_unblock_lock - stop waiting for a file lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493 * @waiter: the lock which was waiting
2494 *
2495 * lockd needs to block waiting for locks.
2496 */
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002497int
Jeff Laytonf891a292013-06-21 08:58:09 -04002498posix_unblock_lock(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002499{
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002500 int status = 0;
2501
Jeff Layton7b2296a2013-06-21 08:58:20 -04002502 spin_lock(&blocked_lock_lock);
J. Bruce Fields5996a292006-01-03 09:55:44 +01002503 if (waiter->fl_next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504 __locks_delete_block(waiter);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002505 else
2506 status = -ENOENT;
Jeff Layton7b2296a2013-06-21 08:58:20 -04002507 spin_unlock(&blocked_lock_lock);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002508 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510EXPORT_SYMBOL(posix_unblock_lock);
2511
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002512/**
2513 * vfs_cancel_lock - file byte range unblock lock
2514 * @filp: The file to apply the unblock to
2515 * @fl: The lock to be unblocked
2516 *
2517 * Used by lock managers to cancel blocked requests
2518 */
2519int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2520{
Al Viro72c2d532013-09-22 16:27:52 -04002521 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002522 return filp->f_op->lock(filp, F_CANCELLK, fl);
2523 return 0;
2524}
2525
2526EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2527
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002528#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002529#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002530#include <linux/seq_file.h>
2531
Jeff Layton7012b022013-06-21 08:58:22 -04002532struct locks_iterator {
2533 int li_cpu;
2534 loff_t li_pos;
2535};
2536
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002537static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002538 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539{
2540 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002541 unsigned int fl_pid;
2542
2543 if (fl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -08002544 fl_pid = pid_vnr(fl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002545 else
2546 fl_pid = fl->fl_pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547
2548 if (fl->fl_file != NULL)
Al Viro496ad9a2013-01-23 17:07:38 -05002549 inode = file_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550
Jerome Marchand99dc8292010-10-26 14:22:33 -07002551 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002552 if (IS_POSIX(fl)) {
Jeff Laytonc918d422014-02-03 12:13:09 -05002553 if (fl->fl_flags & FL_ACCESS)
Fabian Frederick5315c262014-05-09 14:13:05 -04002554 seq_puts(f, "ACCESS");
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002555 else if (IS_OFDLCK(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002556 seq_puts(f, "OFDLCK");
Jeff Laytonc918d422014-02-03 12:13:09 -05002557 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002558 seq_puts(f, "POSIX ");
Jeff Laytonc918d422014-02-03 12:13:09 -05002559
2560 seq_printf(f, " %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002561 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002562 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563 } else if (IS_FLOCK(fl)) {
2564 if (fl->fl_type & LOCK_MAND) {
Fabian Frederick5315c262014-05-09 14:13:05 -04002565 seq_puts(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002567 seq_puts(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568 }
2569 } else if (IS_LEASE(fl)) {
Jeff Layton8144f1f2014-08-11 13:36:54 -04002570 if (fl->fl_flags & FL_DELEG)
2571 seq_puts(f, "DELEG ");
2572 else
2573 seq_puts(f, "LEASE ");
2574
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002575 if (lease_breaking(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002576 seq_puts(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002577 else if (fl->fl_file)
Fabian Frederick5315c262014-05-09 14:13:05 -04002578 seq_puts(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002579 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002580 seq_puts(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002581 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002582 seq_puts(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583 }
2584 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002585 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002586 (fl->fl_type & LOCK_READ)
2587 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2588 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2589 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002590 seq_printf(f, "%s ",
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002591 (lease_breaking(fl))
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04002592 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2593 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002594 }
2595 if (inode) {
Jeff Layton36488882015-04-03 09:04:04 -04002596 /* userspace relies on this representation of dev_t */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002597 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598 MAJOR(inode->i_sb->s_dev),
2599 MINOR(inode->i_sb->s_dev), inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002601 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002602 }
2603 if (IS_POSIX(fl)) {
2604 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002605 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002606 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002607 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002608 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002609 seq_puts(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002610 }
2611}
2612
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002613static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002614{
Jeff Layton7012b022013-06-21 08:58:22 -04002615 struct locks_iterator *iter = f->private;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002616 struct file_lock *fl, *bfl;
2617
Jeff Layton139ca042013-06-21 08:58:17 -04002618 fl = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002619
Jeff Layton7012b022013-06-21 08:58:22 -04002620 lock_get_status(f, fl, iter->li_pos, "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002621
2622 list_for_each_entry(bfl, &fl->fl_block, fl_block)
Jeff Layton7012b022013-06-21 08:58:22 -04002623 lock_get_status(f, bfl, iter->li_pos, " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002624
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002625 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626}
2627
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002628static void __show_fd_locks(struct seq_file *f,
2629 struct list_head *head, int *id,
2630 struct file *filp, struct files_struct *files)
2631{
2632 struct file_lock *fl;
2633
2634 list_for_each_entry(fl, head, fl_list) {
2635
2636 if (filp != fl->fl_file)
2637 continue;
2638 if (fl->fl_owner != files &&
2639 fl->fl_owner != filp)
2640 continue;
2641
2642 (*id)++;
2643 seq_puts(f, "lock:\t");
2644 lock_get_status(f, fl, *id, "");
2645 }
2646}
2647
2648void show_fd_locks(struct seq_file *f,
2649 struct file *filp, struct files_struct *files)
2650{
2651 struct inode *inode = file_inode(filp);
2652 struct file_lock_context *ctx;
2653 int id = 0;
2654
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002655 ctx = smp_load_acquire(&inode->i_flctx);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002656 if (!ctx)
2657 return;
2658
2659 spin_lock(&ctx->flc_lock);
2660 __show_fd_locks(f, &ctx->flc_flock, &id, filp, files);
2661 __show_fd_locks(f, &ctx->flc_posix, &id, filp, files);
2662 __show_fd_locks(f, &ctx->flc_lease, &id, filp, files);
2663 spin_unlock(&ctx->flc_lock);
2664}
2665
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002666static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002667 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002668{
Jeff Layton7012b022013-06-21 08:58:22 -04002669 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002670
Jeff Layton7012b022013-06-21 08:58:22 -04002671 iter->li_pos = *pos + 1;
2672 lg_global_lock(&file_lock_lglock);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002673 spin_lock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002674 return seq_hlist_start_percpu(&file_lock_list, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002675}
2676
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002677static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2678{
Jeff Layton7012b022013-06-21 08:58:22 -04002679 struct locks_iterator *iter = f->private;
2680
2681 ++iter->li_pos;
2682 return seq_hlist_next_percpu(v, &file_lock_list, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002683}
2684
2685static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002686 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002687{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002688 spin_unlock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002689 lg_global_unlock(&file_lock_lglock);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002690}
2691
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002692static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002693 .start = locks_start,
2694 .next = locks_next,
2695 .stop = locks_stop,
2696 .show = locks_show,
2697};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002698
2699static int locks_open(struct inode *inode, struct file *filp)
2700{
Jeff Layton7012b022013-06-21 08:58:22 -04002701 return seq_open_private(filp, &locks_seq_operations,
2702 sizeof(struct locks_iterator));
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002703}
2704
2705static const struct file_operations proc_locks_operations = {
2706 .open = locks_open,
2707 .read = seq_read,
2708 .llseek = seq_lseek,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002709 .release = seq_release_private,
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002710};
2711
2712static int __init proc_locks_init(void)
2713{
2714 proc_create("locks", 0, NULL, &proc_locks_operations);
2715 return 0;
2716}
Paul Gortmaker91899222015-12-17 14:11:03 -05002717fs_initcall(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002718#endif
2719
Linus Torvalds1da177e2005-04-16 15:20:36 -07002720static int __init filelock_init(void)
2721{
Jeff Layton7012b022013-06-21 08:58:22 -04002722 int i;
2723
Jeff Layton4a075e32015-01-16 15:05:54 -05002724 flctx_cache = kmem_cache_create("file_lock_ctx",
2725 sizeof(struct file_lock_context), 0, SLAB_PANIC, NULL);
2726
Linus Torvalds1da177e2005-04-16 15:20:36 -07002727 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002728 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2729
Jeff Layton7012b022013-06-21 08:58:22 -04002730 lg_lock_init(&file_lock_lglock, "file_lock_lglock");
2731
2732 for_each_possible_cpu(i)
2733 INIT_HLIST_HEAD(per_cpu_ptr(&file_lock_list, i));
2734
Linus Torvalds1da177e2005-04-16 15:20:36 -07002735 return 0;
2736}
2737
2738core_initcall(filelock_init);