blob: 653faabb07f46b70f4d414519ae6093e2d52e5cf [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>
122#include <linux/module.h>
123#include <linux/security.h>
124#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125#include <linux/syscalls.h>
126#include <linux/time.h>
Dipankar Sarma4fb3a532005-09-16 19:28:13 -0700127#include <linux/rcupdate.h>
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000128#include <linux/pid_namespace.h>
Jeff Layton48f74182013-06-21 08:58:18 -0400129#include <linux/hashtable.h>
Jeff Layton7012b022013-06-21 08:58:22 -0400130#include <linux/percpu.h>
131#include <linux/lglock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Jeff Layton62af4f12014-05-09 14:13:05 -0400133#define CREATE_TRACE_POINTS
134#include <trace/events/filelock.h>
135
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136#include <asm/uaccess.h>
137
138#define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
139#define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
Christoph Hellwig11afe9f2015-01-21 19:17:03 +0100140#define IS_LEASE(fl) (fl->fl_flags & (FL_LEASE|FL_DELEG|FL_LAYOUT))
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400141#define IS_OFDLCK(fl) (fl->fl_flags & FL_OFDLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400143static bool lease_breaking(struct file_lock *fl)
144{
J. Bruce Fields778fc542011-07-26 18:25:49 -0400145 return fl->fl_flags & (FL_UNLOCK_PENDING | FL_DOWNGRADE_PENDING);
146}
147
148static int target_leasetype(struct file_lock *fl)
149{
150 if (fl->fl_flags & FL_UNLOCK_PENDING)
151 return F_UNLCK;
152 if (fl->fl_flags & FL_DOWNGRADE_PENDING)
153 return F_RDLCK;
154 return fl->fl_type;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400155}
156
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157int leases_enable = 1;
158int lease_break_time = 45;
159
Jeff Layton1c8c6012013-06-21 08:58:15 -0400160/*
Jeff Layton7012b022013-06-21 08:58:22 -0400161 * The global file_lock_list is only used for displaying /proc/locks, so we
162 * keep a list on each CPU, with each list protected by its own spinlock via
163 * the file_lock_lglock. Note that alterations to the list also require that
Jeff Layton6109c852015-01-16 15:05:57 -0500164 * the relevant flc_lock is held.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400165 */
Jeff Layton7012b022013-06-21 08:58:22 -0400166DEFINE_STATIC_LGLOCK(file_lock_lglock);
167static DEFINE_PER_CPU(struct hlist_head, file_lock_list);
Jeff Layton88974692013-06-21 08:58:14 -0400168
Jeff Layton1c8c6012013-06-21 08:58:15 -0400169/*
Jeff Layton48f74182013-06-21 08:58:18 -0400170 * The blocked_hash is used to find POSIX lock loops for deadlock detection.
Jeff Layton7b2296a2013-06-21 08:58:20 -0400171 * It is protected by blocked_lock_lock.
Jeff Layton48f74182013-06-21 08:58:18 -0400172 *
173 * We hash locks by lockowner in order to optimize searching for the lock a
174 * particular lockowner is waiting on.
175 *
176 * FIXME: make this value scale via some heuristic? We generally will want more
177 * buckets when we have more lockowners holding locks, but that's a little
178 * difficult to determine without knowing what the workload will look like.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400179 */
Jeff Layton48f74182013-06-21 08:58:18 -0400180#define BLOCKED_HASH_BITS 7
181static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
Jeff Layton88974692013-06-21 08:58:14 -0400182
Jeff Layton1c8c6012013-06-21 08:58:15 -0400183/*
Jeff Layton7b2296a2013-06-21 08:58:20 -0400184 * This lock protects the blocked_hash. Generally, if you're accessing it, you
185 * want to be holding this lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400186 *
187 * In addition, it also protects the fl->fl_block list, and the fl->fl_next
188 * pointer for file_lock structures that are acting as lock requests (in
189 * contrast to those that are acting as records of acquired locks).
190 *
191 * Note that when we acquire this lock in order to change the above fields,
Jeff Layton6109c852015-01-16 15:05:57 -0500192 * we often hold the flc_lock as well. In certain cases, when reading the fields
Jeff Layton1c8c6012013-06-21 08:58:15 -0400193 * protected by this lock, we can skip acquiring it iff we already hold the
Jeff Layton6109c852015-01-16 15:05:57 -0500194 * flc_lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400195 *
196 * In particular, adding an entry to the fl_block list requires that you hold
Jeff Layton6109c852015-01-16 15:05:57 -0500197 * both the flc_lock and the blocked_lock_lock (acquired in that order).
198 * Deleting an entry from the list however only requires the file_lock_lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400199 */
Jeff Layton7b2296a2013-06-21 08:58:20 -0400200static DEFINE_SPINLOCK(blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
Jeff Layton4a075e32015-01-16 15:05:54 -0500202static struct kmem_cache *flctx_cache __read_mostly;
Christoph Lametere18b8902006-12-06 20:33:20 -0800203static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Jeff Layton4a075e32015-01-16 15:05:54 -0500205static struct file_lock_context *
Jeff Layton5c1c6692015-04-03 09:04:03 -0400206locks_get_lock_context(struct inode *inode, int type)
Jeff Layton4a075e32015-01-16 15:05:54 -0500207{
208 struct file_lock_context *new;
209
Jeff Layton5c1c6692015-04-03 09:04:03 -0400210 if (likely(inode->i_flctx) || type == F_UNLCK)
Jeff Layton4a075e32015-01-16 15:05:54 -0500211 goto out;
212
213 new = kmem_cache_alloc(flctx_cache, GFP_KERNEL);
214 if (!new)
215 goto out;
216
Jeff Layton6109c852015-01-16 15:05:57 -0500217 spin_lock_init(&new->flc_lock);
Jeff Layton4a075e32015-01-16 15:05:54 -0500218 INIT_LIST_HEAD(&new->flc_flock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500219 INIT_LIST_HEAD(&new->flc_posix);
Jeff Layton8634b512015-01-16 15:05:55 -0500220 INIT_LIST_HEAD(&new->flc_lease);
Jeff Layton4a075e32015-01-16 15:05:54 -0500221
222 /*
223 * Assign the pointer if it's not already assigned. If it is, then
224 * free the context we just allocated.
225 */
Jeff Layton0429c2b2015-04-03 09:04:04 -0400226 if (cmpxchg(&inode->i_flctx, NULL, new))
Jeff Layton4a075e32015-01-16 15:05:54 -0500227 kmem_cache_free(flctx_cache, new);
228out:
229 return inode->i_flctx;
230}
231
232void
233locks_free_lock_context(struct file_lock_context *ctx)
234{
235 if (ctx) {
236 WARN_ON_ONCE(!list_empty(&ctx->flc_flock));
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500237 WARN_ON_ONCE(!list_empty(&ctx->flc_posix));
Jeff Layton8634b512015-01-16 15:05:55 -0500238 WARN_ON_ONCE(!list_empty(&ctx->flc_lease));
Jeff Layton4a075e32015-01-16 15:05:54 -0500239 kmem_cache_free(flctx_cache, ctx);
240 }
241}
242
Miklos Szerediee19cc42011-07-07 13:06:09 +0200243static void locks_init_lock_heads(struct file_lock *fl)
Miklos Szeredia51cb912011-07-06 12:33:55 +0200244{
Jeff Layton139ca042013-06-21 08:58:17 -0400245 INIT_HLIST_NODE(&fl->fl_link);
Jeff Layton6dee60f2015-01-16 15:05:54 -0500246 INIT_LIST_HEAD(&fl->fl_list);
Miklos Szerediee19cc42011-07-07 13:06:09 +0200247 INIT_LIST_HEAD(&fl->fl_block);
248 init_waitqueue_head(&fl->fl_wait);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200249}
250
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200252struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200254 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200255
256 if (fl)
Miklos Szerediee19cc42011-07-07 13:06:09 +0200257 locks_init_lock_heads(fl);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200258
259 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200261EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500263void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500264{
265 if (fl->fl_ops) {
266 if (fl->fl_ops->fl_release_private)
267 fl->fl_ops->fl_release_private(fl);
268 fl->fl_ops = NULL;
269 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500270
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400271 if (fl->fl_lmops) {
Jeff Laytoncae80b32015-04-03 09:04:04 -0400272 if (fl->fl_lmops->lm_put_owner) {
273 fl->fl_lmops->lm_put_owner(fl->fl_owner);
274 fl->fl_owner = NULL;
275 }
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400276 fl->fl_lmops = NULL;
277 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500278}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500279EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500280
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281/* Free a lock which is not in use. */
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400282void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283{
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800284 BUG_ON(waitqueue_active(&fl->fl_wait));
Jeff Layton6dee60f2015-01-16 15:05:54 -0500285 BUG_ON(!list_empty(&fl->fl_list));
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800286 BUG_ON(!list_empty(&fl->fl_block));
Jeff Layton139ca042013-06-21 08:58:17 -0400287 BUG_ON(!hlist_unhashed(&fl->fl_link));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
Trond Myklebust47831f32006-03-20 13:44:05 -0500289 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 kmem_cache_free(filelock_cache, fl);
291}
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400292EXPORT_SYMBOL(locks_free_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
Jeff Laytoned9814d2014-08-11 14:20:31 -0400294static void
295locks_dispose_list(struct list_head *dispose)
296{
297 struct file_lock *fl;
298
299 while (!list_empty(dispose)) {
Jeff Layton6dee60f2015-01-16 15:05:54 -0500300 fl = list_first_entry(dispose, struct file_lock, fl_list);
301 list_del_init(&fl->fl_list);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400302 locks_free_lock(fl);
303 }
304}
305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306void locks_init_lock(struct file_lock *fl)
307{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200308 memset(fl, 0, sizeof(struct file_lock));
309 locks_init_lock_heads(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310}
311
312EXPORT_SYMBOL(locks_init_lock);
313
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314/*
315 * Initialize a new lock from an existing file_lock structure.
316 */
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400317void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318{
319 new->fl_owner = fl->fl_owner;
320 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500321 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 new->fl_flags = fl->fl_flags;
323 new->fl_type = fl->fl_type;
324 new->fl_start = fl->fl_start;
325 new->fl_end = fl->fl_end;
Kinglong Meef3282962014-08-22 10:18:43 -0400326 new->fl_lmops = fl->fl_lmops;
Trond Myklebust09969052006-03-20 13:44:38 -0500327 new->fl_ops = NULL;
Kinglong Meef3282962014-08-22 10:18:43 -0400328
329 if (fl->fl_lmops) {
330 if (fl->fl_lmops->lm_get_owner)
Jeff Laytoncae80b32015-04-03 09:04:04 -0400331 fl->fl_lmops->lm_get_owner(fl->fl_owner);
Kinglong Meef3282962014-08-22 10:18:43 -0400332 }
Trond Myklebust09969052006-03-20 13:44:38 -0500333}
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400334EXPORT_SYMBOL(locks_copy_conflock);
Trond Myklebust09969052006-03-20 13:44:38 -0500335
336void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
337{
Jeff Layton566709b2014-08-11 14:09:35 -0400338 /* "new" must be a freshly-initialized lock */
339 WARN_ON_ONCE(new->fl_ops);
Trond Myklebust09969052006-03-20 13:44:38 -0500340
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400341 locks_copy_conflock(new, fl);
Kinglong Meef3282962014-08-22 10:18:43 -0400342
Trond Myklebust09969052006-03-20 13:44:38 -0500343 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 new->fl_ops = fl->fl_ops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500345
Kinglong Meef3282962014-08-22 10:18:43 -0400346 if (fl->fl_ops) {
347 if (fl->fl_ops->fl_copy_lock)
348 fl->fl_ops->fl_copy_lock(new, fl);
349 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350}
351
352EXPORT_SYMBOL(locks_copy_lock);
353
354static inline int flock_translate_cmd(int cmd) {
355 if (cmd & LOCK_MAND)
356 return cmd & (LOCK_MAND | LOCK_RW);
357 switch (cmd) {
358 case LOCK_SH:
359 return F_RDLCK;
360 case LOCK_EX:
361 return F_WRLCK;
362 case LOCK_UN:
363 return F_UNLCK;
364 }
365 return -EINVAL;
366}
367
368/* Fill in a file_lock structure with an appropriate FLOCK lock. */
Jeff Layton6e129d002014-09-04 10:25:06 -0400369static struct file_lock *
370flock_make_lock(struct file *filp, unsigned int cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371{
372 struct file_lock *fl;
373 int type = flock_translate_cmd(cmd);
Jeff Layton6e129d002014-09-04 10:25:06 -0400374
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 if (type < 0)
Jeff Layton6e129d002014-09-04 10:25:06 -0400376 return ERR_PTR(type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377
378 fl = locks_alloc_lock();
379 if (fl == NULL)
Jeff Layton6e129d002014-09-04 10:25:06 -0400380 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
382 fl->fl_file = filp;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +0200383 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 fl->fl_pid = current->tgid;
385 fl->fl_flags = FL_FLOCK;
386 fl->fl_type = type;
387 fl->fl_end = OFFSET_MAX;
388
Jeff Layton6e129d002014-09-04 10:25:06 -0400389 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390}
391
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400392static int assign_type(struct file_lock *fl, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393{
394 switch (type) {
395 case F_RDLCK:
396 case F_WRLCK:
397 case F_UNLCK:
398 fl->fl_type = type;
399 break;
400 default:
401 return -EINVAL;
402 }
403 return 0;
404}
405
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500406static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
407 struct flock64 *l)
408{
409 switch (l->l_whence) {
410 case SEEK_SET:
411 fl->fl_start = 0;
412 break;
413 case SEEK_CUR:
414 fl->fl_start = filp->f_pos;
415 break;
416 case SEEK_END:
417 fl->fl_start = i_size_read(file_inode(filp));
418 break;
419 default:
420 return -EINVAL;
421 }
422 if (l->l_start > OFFSET_MAX - fl->fl_start)
423 return -EOVERFLOW;
424 fl->fl_start += l->l_start;
425 if (fl->fl_start < 0)
426 return -EINVAL;
427
428 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
429 POSIX-2001 defines it. */
430 if (l->l_len > 0) {
431 if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
432 return -EOVERFLOW;
433 fl->fl_end = fl->fl_start + l->l_len - 1;
434
435 } else if (l->l_len < 0) {
436 if (fl->fl_start + l->l_len < 0)
437 return -EINVAL;
438 fl->fl_end = fl->fl_start - 1;
439 fl->fl_start += l->l_len;
440 } else
441 fl->fl_end = OFFSET_MAX;
442
443 fl->fl_owner = current->files;
444 fl->fl_pid = current->tgid;
445 fl->fl_file = filp;
446 fl->fl_flags = FL_POSIX;
447 fl->fl_ops = NULL;
448 fl->fl_lmops = NULL;
449
450 return assign_type(fl, l->l_type);
451}
452
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
454 * style lock.
455 */
456static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
457 struct flock *l)
458{
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500459 struct flock64 ll = {
460 .l_type = l->l_type,
461 .l_whence = l->l_whence,
462 .l_start = l->l_start,
463 .l_len = l->l_len,
464 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500466 return flock64_to_posix_lock(filp, fl, &ll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467}
468
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469/* default lease lock manager operations */
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400470static bool
471lease_break_callback(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472{
473 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400474 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475}
476
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400477static void
478lease_setup(struct file_lock *fl, void **priv)
479{
480 struct file *filp = fl->fl_file;
481 struct fasync_struct *fa = *priv;
482
483 /*
484 * fasync_insert_entry() returns the old entry if any. If there was no
485 * old entry, then it used "priv" and inserted it into the fasync list.
486 * Clear the pointer to indicate that it shouldn't be freed.
487 */
488 if (!fasync_insert_entry(fa->fa_fd, filp, &fl->fl_fasync, fa))
489 *priv = NULL;
490
491 __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
492}
493
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700494static const struct lock_manager_operations lease_manager_ops = {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400495 .lm_break = lease_break_callback,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400496 .lm_change = lease_modify,
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400497 .lm_setup = lease_setup,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498};
499
500/*
501 * Initialize a lease, use the default lock manager operations
502 */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400503static int lease_init(struct file *filp, long type, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 {
Trond Myklebust75dff552006-05-07 23:02:42 -0400505 if (assign_type(fl, type) != 0)
506 return -EINVAL;
507
Jeff Layton7ca76312014-09-01 19:04:48 -0400508 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 fl->fl_pid = current->tgid;
510
511 fl->fl_file = filp;
512 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 fl->fl_start = 0;
514 fl->fl_end = OFFSET_MAX;
515 fl->fl_ops = NULL;
516 fl->fl_lmops = &lease_manager_ops;
517 return 0;
518}
519
520/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400521static struct file_lock *lease_alloc(struct file *filp, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522{
523 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400524 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
526 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500527 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
529 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400530 if (error) {
531 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500532 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400533 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500534 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535}
536
537/* Check if two locks overlap each other.
538 */
539static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
540{
541 return ((fl1->fl_end >= fl2->fl_start) &&
542 (fl2->fl_end >= fl1->fl_start));
543}
544
545/*
546 * Check whether two locks have the same owner.
547 */
Matt Mackall33443c42006-01-08 01:05:22 -0800548static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549{
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400550 if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 return fl2->fl_lmops == fl1->fl_lmops &&
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400552 fl1->fl_lmops->lm_compare_owner(fl1, fl2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 return fl1->fl_owner == fl2->fl_owner;
554}
555
Jeff Layton6109c852015-01-16 15:05:57 -0500556/* Must be called with the flc_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500557static void locks_insert_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400558{
Jeff Layton7012b022013-06-21 08:58:22 -0400559 lg_local_lock(&file_lock_lglock);
560 fl->fl_link_cpu = smp_processor_id();
561 hlist_add_head(&fl->fl_link, this_cpu_ptr(&file_lock_list));
562 lg_local_unlock(&file_lock_lglock);
Jeff Layton88974692013-06-21 08:58:14 -0400563}
564
Jeff Layton6109c852015-01-16 15:05:57 -0500565/* Must be called with the flc_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500566static void locks_delete_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400567{
Jeff Layton7012b022013-06-21 08:58:22 -0400568 /*
569 * Avoid taking lock if already unhashed. This is safe since this check
Jeff Layton6109c852015-01-16 15:05:57 -0500570 * is done while holding the flc_lock, and new insertions into the list
Jeff Layton7012b022013-06-21 08:58:22 -0400571 * also require that it be held.
572 */
573 if (hlist_unhashed(&fl->fl_link))
574 return;
575 lg_local_lock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton139ca042013-06-21 08:58:17 -0400576 hlist_del_init(&fl->fl_link);
Jeff Layton7012b022013-06-21 08:58:22 -0400577 lg_local_unlock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton88974692013-06-21 08:58:14 -0400578}
579
Jeff Layton3999e492013-06-21 08:58:19 -0400580static unsigned long
581posix_owner_key(struct file_lock *fl)
582{
583 if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
584 return fl->fl_lmops->lm_owner_key(fl);
585 return (unsigned long)fl->fl_owner;
586}
587
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500588static void locks_insert_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400589{
Daniel Wagner663d5af2015-04-03 09:04:03 -0400590 lockdep_assert_held(&blocked_lock_lock);
591
Jeff Layton3999e492013-06-21 08:58:19 -0400592 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
Jeff Layton88974692013-06-21 08:58:14 -0400593}
594
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500595static void locks_delete_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400596{
Daniel Wagner663d5af2015-04-03 09:04:03 -0400597 lockdep_assert_held(&blocked_lock_lock);
598
Jeff Layton48f74182013-06-21 08:58:18 -0400599 hash_del(&waiter->fl_link);
Jeff Layton88974692013-06-21 08:58:14 -0400600}
601
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602/* Remove waiter from blocker's block list.
603 * When blocker ends up pointing to itself then the list is empty.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400604 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400605 * Must be called with blocked_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 */
Matt Mackall33443c42006-01-08 01:05:22 -0800607static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608{
Jeff Layton88974692013-06-21 08:58:14 -0400609 locks_delete_global_blocked(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 list_del_init(&waiter->fl_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 waiter->fl_next = NULL;
612}
613
Jeff Layton1a9e64a2013-06-21 08:58:10 -0400614static void locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400616 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 __locks_delete_block(waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400618 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619}
620
621/* Insert waiter into blocker's block list.
622 * We use a circular list so that processes can be easily woken up in
623 * the order they blocked. The documentation doesn't require this but
624 * it seems like the reasonable thing to do.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400625 *
Jeff Layton6109c852015-01-16 15:05:57 -0500626 * Must be called with both the flc_lock and blocked_lock_lock held. The
627 * fl_block list itself is protected by the blocked_lock_lock, but by ensuring
628 * that the flc_lock is also held on insertions we can avoid taking the
629 * blocked_lock_lock in some cases when we see that the fl_block list is empty.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400631static void __locks_insert_block(struct file_lock *blocker,
632 struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633{
J. Bruce Fields6dc0fe82006-03-26 01:37:24 -0800634 BUG_ON(!list_empty(&waiter->fl_block));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 waiter->fl_next = blocker;
Jeff Layton88974692013-06-21 08:58:14 -0400636 list_add_tail(&waiter->fl_block, &blocker->fl_block);
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400637 if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400638 locks_insert_global_blocked(waiter);
639}
640
Jeff Layton6109c852015-01-16 15:05:57 -0500641/* Must be called with flc_lock held. */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400642static void locks_insert_block(struct file_lock *blocker,
643 struct file_lock *waiter)
644{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400645 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400646 __locks_insert_block(blocker, waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400647 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648}
649
Jeff Layton1cb36012013-06-21 08:58:12 -0400650/*
651 * Wake up processes blocked waiting for blocker.
652 *
Jeff Layton6109c852015-01-16 15:05:57 -0500653 * Must be called with the inode->flc_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 */
655static void locks_wake_up_blocks(struct file_lock *blocker)
656{
Jeff Layton4e8c7652013-06-21 08:58:16 -0400657 /*
658 * Avoid taking global lock if list is empty. This is safe since new
Jeff Layton6109c852015-01-16 15:05:57 -0500659 * blocked requests are only added to the list under the flc_lock, and
660 * the flc_lock is always held here. Note that removal from the fl_block
661 * list does not require the flc_lock, so we must recheck list_empty()
Jeff Layton7b2296a2013-06-21 08:58:20 -0400662 * after acquiring the blocked_lock_lock.
Jeff Layton4e8c7652013-06-21 08:58:16 -0400663 */
664 if (list_empty(&blocker->fl_block))
665 return;
666
Jeff Layton7b2296a2013-06-21 08:58:20 -0400667 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 while (!list_empty(&blocker->fl_block)) {
Pavel Emelyanovf0c1cd02007-09-19 16:44:07 +0400669 struct file_lock *waiter;
670
671 waiter = list_first_entry(&blocker->fl_block,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 struct file_lock, fl_block);
673 __locks_delete_block(waiter);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400674 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
675 waiter->fl_lmops->lm_notify(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 else
677 wake_up(&waiter->fl_wait);
678 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400679 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680}
681
Jeff Layton5263e312015-01-16 15:05:55 -0500682static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500683locks_insert_lock_ctx(struct file_lock *fl, struct list_head *before)
Jeff Layton5263e312015-01-16 15:05:55 -0500684{
685 fl->fl_nspid = get_pid(task_tgid(current));
686 list_add_tail(&fl->fl_list, before);
687 locks_insert_global_locks(fl);
688}
689
Jeff Layton8634b512015-01-16 15:05:55 -0500690static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500691locks_unlink_lock_ctx(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692{
Jeff Layton88974692013-06-21 08:58:14 -0400693 locks_delete_global_locks(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500694 list_del_init(&fl->fl_list);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000695 if (fl->fl_nspid) {
696 put_pid(fl->fl_nspid);
697 fl->fl_nspid = NULL;
698 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 locks_wake_up_blocks(fl);
Jeff Layton24cbe782014-02-03 12:13:06 -0500700}
701
Jeff Layton5263e312015-01-16 15:05:55 -0500702static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500703locks_delete_lock_ctx(struct file_lock *fl, struct list_head *dispose)
Jeff Layton5263e312015-01-16 15:05:55 -0500704{
Jeff Laytone084c1b2015-02-16 14:32:03 -0500705 locks_unlink_lock_ctx(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500706 if (dispose)
707 list_add(&fl->fl_list, dispose);
708 else
709 locks_free_lock(fl);
Jeff Layton5263e312015-01-16 15:05:55 -0500710}
711
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
713 * checks for shared/exclusive status of overlapping locks.
714 */
715static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
716{
717 if (sys_fl->fl_type == F_WRLCK)
718 return 1;
719 if (caller_fl->fl_type == F_WRLCK)
720 return 1;
721 return 0;
722}
723
724/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
725 * checking before calling the locks_conflict().
726 */
727static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
728{
729 /* POSIX locks owned by the same process do not conflict with
730 * each other.
731 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400732 if (posix_same_owner(caller_fl, sys_fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 return (0);
734
735 /* Check whether they overlap */
736 if (!locks_overlap(caller_fl, sys_fl))
737 return 0;
738
739 return (locks_conflict(caller_fl, sys_fl));
740}
741
742/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
743 * checking before calling the locks_conflict().
744 */
745static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
746{
747 /* FLOCK locks referring to the same filp do not conflict with
748 * each other.
749 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400750 if (caller_fl->fl_file == sys_fl->fl_file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 return (0);
752 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
753 return 0;
754
755 return (locks_conflict(caller_fl, sys_fl));
756}
757
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400758void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500759posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760{
761 struct file_lock *cfl;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500762 struct file_lock_context *ctx;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400763 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500765 ctx = inode->i_flctx;
766 if (!ctx || list_empty_careful(&ctx->flc_posix)) {
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400767 fl->fl_type = F_UNLCK;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500768 return;
769 }
770
Jeff Layton6109c852015-01-16 15:05:57 -0500771 spin_lock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500772 list_for_each_entry(cfl, &ctx->flc_posix, fl_list) {
773 if (posix_locks_conflict(fl, cfl)) {
774 locks_copy_conflock(fl, cfl);
775 if (cfl->fl_nspid)
776 fl->fl_pid = pid_vnr(cfl->fl_nspid);
777 goto out;
778 }
779 }
780 fl->fl_type = F_UNLCK;
781out:
Jeff Layton6109c852015-01-16 15:05:57 -0500782 spin_unlock(&ctx->flc_lock);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400783 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785EXPORT_SYMBOL(posix_test_lock);
786
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400787/*
788 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400790 * We attempt to detect deadlocks that are due purely to posix file
791 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400793 * We assume that a task can be waiting for at most one lock at a time.
794 * So for any acquired lock, the process holding that lock may be
795 * waiting on at most one other lock. That lock in turns may be held by
796 * someone waiting for at most one other lock. Given a requested lock
797 * caller_fl which is about to wait for a conflicting lock block_fl, we
798 * follow this chain of waiters to ensure we are not about to create a
799 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400800 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400801 * Since we do this before we ever put a process to sleep on a lock, we
802 * are ensured that there is never a cycle; that is what guarantees that
803 * the while() loop in posix_locks_deadlock() eventually completes.
804 *
805 * Note: the above assumption may not be true when handling lock
806 * requests from a broken NFS client. It may also fail in the presence
807 * of tasks (such as posix threads) sharing the same open file table.
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400808 * To handle those cases, we just bail out after a few iterations.
Jeff Layton57b65322014-02-03 12:13:09 -0500809 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400810 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
Jeff Layton57b65322014-02-03 12:13:09 -0500811 * Because the owner is not even nominally tied to a thread of
812 * execution, the deadlock detection below can't reasonably work well. Just
813 * skip it for those.
814 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400815 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
Jeff Layton57b65322014-02-03 12:13:09 -0500816 * locks that just checks for the case where two tasks are attempting to
817 * upgrade from read to write locks on the same inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400819
820#define MAX_DEADLK_ITERATIONS 10
821
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400822/* Find a lock that the owner of the given block_fl is blocking on. */
823static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
824{
825 struct file_lock *fl;
826
Jeff Layton3999e492013-06-21 08:58:19 -0400827 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400828 if (posix_same_owner(fl, block_fl))
829 return fl->fl_next;
830 }
831 return NULL;
832}
833
Jeff Layton7b2296a2013-06-21 08:58:20 -0400834/* Must be called with the blocked_lock_lock held! */
Adrian Bunkb0904e12006-06-23 02:05:13 -0700835static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 struct file_lock *block_fl)
837{
J. Bruce Fields97855b42007-10-30 11:20:02 -0400838 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839
Daniel Wagner663d5af2015-04-03 09:04:03 -0400840 lockdep_assert_held(&blocked_lock_lock);
841
Jeff Layton57b65322014-02-03 12:13:09 -0500842 /*
843 * This deadlock detector can't reasonably detect deadlocks with
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400844 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
Jeff Layton57b65322014-02-03 12:13:09 -0500845 */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400846 if (IS_OFDLCK(caller_fl))
Jeff Layton57b65322014-02-03 12:13:09 -0500847 return 0;
848
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400849 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
850 if (i++ > MAX_DEADLK_ITERATIONS)
851 return 0;
852 if (posix_same_owner(caller_fl, block_fl))
853 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 }
855 return 0;
856}
857
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -0400859 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -0400860 *
861 * Note that if called with an FL_EXISTS argument, the caller may determine
862 * whether or not a lock was successfully freed by testing the return
863 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 */
Trond Myklebust993dfa82006-03-31 02:30:55 -0800865static int flock_lock_file(struct file *filp, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866{
Trond Myklebust993dfa82006-03-31 02:30:55 -0800867 struct file_lock *new_fl = NULL;
Jeff Layton5263e312015-01-16 15:05:55 -0500868 struct file_lock *fl;
869 struct file_lock_context *ctx;
870 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 int error = 0;
Jeff Layton5263e312015-01-16 15:05:55 -0500872 bool found = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -0400873 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
Jeff Layton5c1c6692015-04-03 09:04:03 -0400875 ctx = locks_get_lock_context(inode, request->fl_type);
876 if (!ctx) {
877 if (request->fl_type != F_UNLCK)
878 return -ENOMEM;
879 return (request->fl_flags & FL_EXISTS) ? -ENOENT : 0;
880 }
Jeff Layton5263e312015-01-16 15:05:55 -0500881
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200882 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
883 new_fl = locks_alloc_lock();
884 if (!new_fl)
885 return -ENOMEM;
886 }
887
Jeff Layton6109c852015-01-16 15:05:57 -0500888 spin_lock(&ctx->flc_lock);
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400889 if (request->fl_flags & FL_ACCESS)
890 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +0400891
Jeff Layton5263e312015-01-16 15:05:55 -0500892 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 if (filp != fl->fl_file)
894 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800895 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 goto out;
Jeff Layton5263e312015-01-16 15:05:55 -0500897 found = true;
Jeff Laytone084c1b2015-02-16 14:32:03 -0500898 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 break;
900 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901
Trond Myklebustf475ae92006-06-29 16:38:32 -0400902 if (request->fl_type == F_UNLCK) {
903 if ((request->fl_flags & FL_EXISTS) && !found)
904 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800905 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400906 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400908find_conflict:
Jeff Layton5263e312015-01-16 15:05:55 -0500909 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Trond Myklebust993dfa82006-03-31 02:30:55 -0800910 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 continue;
912 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700913 if (!(request->fl_flags & FL_SLEEP))
914 goto out;
915 error = FILE_LOCK_DEFERRED;
916 locks_insert_block(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 goto out;
918 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400919 if (request->fl_flags & FL_ACCESS)
920 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800921 locks_copy_lock(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -0500922 locks_insert_lock_ctx(new_fl, &ctx->flc_flock);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800923 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +0400924 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925
926out:
Jeff Layton6109c852015-01-16 15:05:57 -0500927 spin_unlock(&ctx->flc_lock);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800928 if (new_fl)
929 locks_free_lock(new_fl);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400930 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 return error;
932}
933
Marc Eshel150b3932007-01-18 16:15:35 -0500934static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500936 struct file_lock *fl, *tmp;
Miklos Szeredi39005d02006-06-23 02:05:10 -0700937 struct file_lock *new_fl = NULL;
938 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 struct file_lock *left = NULL;
940 struct file_lock *right = NULL;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500941 struct file_lock_context *ctx;
Jeff Laytonb9746ef2013-06-21 08:58:13 -0400942 int error;
943 bool added = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -0400944 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945
Jeff Layton5c1c6692015-04-03 09:04:03 -0400946 ctx = locks_get_lock_context(inode, request->fl_type);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500947 if (!ctx)
Jeff Layton5c1c6692015-04-03 09:04:03 -0400948 return (request->fl_type == F_UNLCK) ? 0 : -ENOMEM;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500949
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 /*
951 * We may need two file_lock structures for this operation,
952 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -0700953 *
954 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 */
Miklos Szeredi39005d02006-06-23 02:05:10 -0700956 if (!(request->fl_flags & FL_ACCESS) &&
957 (request->fl_type != F_UNLCK ||
958 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
959 new_fl = locks_alloc_lock();
960 new_fl2 = locks_alloc_lock();
961 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962
Jeff Layton6109c852015-01-16 15:05:57 -0500963 spin_lock(&ctx->flc_lock);
Jeff Layton1cb36012013-06-21 08:58:12 -0400964 /*
965 * New lock request. Walk all POSIX locks and look for conflicts. If
966 * there are any, either return error or put the request on the
Jeff Layton48f74182013-06-21 08:58:18 -0400967 * blocker's list of waiters and the global blocked_hash.
Jeff Layton1cb36012013-06-21 08:58:12 -0400968 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 if (request->fl_type != F_UNLCK) {
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500970 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 if (!posix_locks_conflict(request, fl))
972 continue;
Andy Adamson5842add2006-03-26 01:37:26 -0800973 if (conflock)
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400974 locks_copy_conflock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975 error = -EAGAIN;
976 if (!(request->fl_flags & FL_SLEEP))
977 goto out;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400978 /*
979 * Deadlock detection and insertion into the blocked
980 * locks list must be done while holding the same lock!
981 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 error = -EDEADLK;
Jeff Layton7b2296a2013-06-21 08:58:20 -0400983 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400984 if (likely(!posix_locks_deadlock(request, fl))) {
985 error = FILE_LOCK_DEFERRED;
986 __locks_insert_block(fl, request);
987 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400988 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 goto out;
990 }
991 }
992
993 /* If we're just looking for a conflict, we're done. */
994 error = 0;
995 if (request->fl_flags & FL_ACCESS)
996 goto out;
997
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500998 /* Find the first old lock with the same owner as the new lock */
999 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1000 if (posix_same_owner(request, fl))
1001 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 }
1003
Jeff Layton1cb36012013-06-21 08:58:12 -04001004 /* Process locks with this owner. */
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001005 list_for_each_entry_safe_from(fl, tmp, &ctx->flc_posix, fl_list) {
1006 if (!posix_same_owner(request, fl))
1007 break;
1008
1009 /* Detect adjacent or overlapping regions (if same lock type) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -07001011 /* In all comparisons of start vs end, use
1012 * "start - 1" rather than "end + 1". If end
1013 * is OFFSET_MAX, end + 1 will become negative.
1014 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 if (fl->fl_end < request->fl_start - 1)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001016 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 /* If the next lock in the list has entirely bigger
1018 * addresses than the new one, insert the lock here.
1019 */
Olaf Kirch449231d2005-08-25 16:25:35 -07001020 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 break;
1022
1023 /* If we come here, the new and old lock are of the
1024 * same type and adjacent or overlapping. Make one
1025 * lock yielding from the lower start address of both
1026 * locks to the higher end address.
1027 */
1028 if (fl->fl_start > request->fl_start)
1029 fl->fl_start = request->fl_start;
1030 else
1031 request->fl_start = fl->fl_start;
1032 if (fl->fl_end < request->fl_end)
1033 fl->fl_end = request->fl_end;
1034 else
1035 request->fl_end = fl->fl_end;
1036 if (added) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001037 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 continue;
1039 }
1040 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001041 added = true;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001042 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 /* Processing for different lock types is a bit
1044 * more complex.
1045 */
1046 if (fl->fl_end < request->fl_start)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001047 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 if (fl->fl_start > request->fl_end)
1049 break;
1050 if (request->fl_type == F_UNLCK)
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001051 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 if (fl->fl_start < request->fl_start)
1053 left = fl;
1054 /* If the next lock in the list has a higher end
1055 * address than the new one, insert the new one here.
1056 */
1057 if (fl->fl_end > request->fl_end) {
1058 right = fl;
1059 break;
1060 }
1061 if (fl->fl_start >= request->fl_start) {
1062 /* The new lock completely replaces an old
1063 * one (This may happen several times).
1064 */
1065 if (added) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001066 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 continue;
1068 }
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001069 /*
1070 * Replace the old lock with new_fl, and
1071 * remove the old one. It's safe to do the
1072 * insert here since we know that we won't be
1073 * using new_fl later, and that the lock is
1074 * just replacing an existing lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 */
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001076 error = -ENOLCK;
1077 if (!new_fl)
1078 goto out;
1079 locks_copy_lock(new_fl, request);
1080 request = new_fl;
1081 new_fl = NULL;
Jeff Laytone084c1b2015-02-16 14:32:03 -05001082 locks_insert_lock_ctx(request, &fl->fl_list);
1083 locks_delete_lock_ctx(fl, &dispose);
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001084 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 }
1086 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 }
1088
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001089 /*
Jeff Layton1cb36012013-06-21 08:58:12 -04001090 * The above code only modifies existing locks in case of merging or
1091 * replacing. If new lock(s) need to be inserted all modifications are
1092 * done below this, so it's safe yet to bail out.
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001093 */
1094 error = -ENOLCK; /* "no luck" */
1095 if (right && left == right && !new_fl2)
1096 goto out;
1097
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 error = 0;
1099 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -04001100 if (request->fl_type == F_UNLCK) {
1101 if (request->fl_flags & FL_EXISTS)
1102 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001104 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001105
1106 if (!new_fl) {
1107 error = -ENOLCK;
1108 goto out;
1109 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 locks_copy_lock(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001111 locks_insert_lock_ctx(new_fl, &fl->fl_list);
Jeff Layton2e2f756f2015-02-17 17:08:23 -05001112 fl = new_fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 new_fl = NULL;
1114 }
1115 if (right) {
1116 if (left == right) {
1117 /* The new lock breaks the old one in two pieces,
1118 * so we have to use the second new lock.
1119 */
1120 left = new_fl2;
1121 new_fl2 = NULL;
1122 locks_copy_lock(left, right);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001123 locks_insert_lock_ctx(left, &fl->fl_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 }
1125 right->fl_start = request->fl_end + 1;
1126 locks_wake_up_blocks(right);
1127 }
1128 if (left) {
1129 left->fl_end = request->fl_start - 1;
1130 locks_wake_up_blocks(left);
1131 }
1132 out:
Jeff Layton6109c852015-01-16 15:05:57 -05001133 spin_unlock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 /*
1135 * Free any unused locks.
1136 */
1137 if (new_fl)
1138 locks_free_lock(new_fl);
1139 if (new_fl2)
1140 locks_free_lock(new_fl2);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001141 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 return error;
1143}
1144
1145/**
1146 * posix_lock_file - Apply a POSIX-style lock to a file
1147 * @filp: The file to apply the lock to
1148 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001149 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 *
1151 * Add a POSIX style lock to a file.
1152 * We merge adjacent & overlapping locks whenever possible.
1153 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001154 *
1155 * Note that if called with an FL_EXISTS argument, the caller may determine
1156 * whether or not a lock was successfully freed by testing the return
1157 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 */
Marc Eshel150b3932007-01-18 16:15:35 -05001159int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001160 struct file_lock *conflock)
1161{
Al Viro496ad9a2013-01-23 17:07:38 -05001162 return __posix_lock_file(file_inode(filp), fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001163}
Marc Eshel150b3932007-01-18 16:15:35 -05001164EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165
1166/**
1167 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1168 * @filp: The file to apply the lock to
1169 * @fl: The lock to be applied
1170 *
1171 * Add a POSIX style lock to a file.
1172 * We merge adjacent & overlapping locks whenever possible.
1173 * POSIX locks are sorted by owner task, then by starting address
1174 */
1175int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1176{
1177 int error;
1178 might_sleep ();
1179 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001180 error = posix_lock_file(filp, 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}
1192EXPORT_SYMBOL(posix_lock_file_wait);
1193
1194/**
1195 * 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
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001208 ctx = inode->i_flctx;
1209 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);
1292
J. Bruce Fields778fc542011-07-26 18:25:49 -04001293static void lease_clear_pending(struct file_lock *fl, int arg)
1294{
1295 switch (arg) {
1296 case F_UNLCK:
1297 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1298 /* fall through: */
1299 case F_RDLCK:
1300 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1301 }
1302}
1303
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304/* We already had a lease on this file; just change its type */
Jeff Layton7448cc32015-01-16 15:05:57 -05001305int lease_modify(struct file_lock *fl, int arg, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307 int error = assign_type(fl, arg);
1308
1309 if (error)
1310 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001311 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001313 if (arg == F_UNLCK) {
1314 struct file *filp = fl->fl_file;
1315
1316 f_delown(filp);
1317 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001318 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1319 if (fl->fl_fasync != NULL) {
1320 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1321 fl->fl_fasync = NULL;
1322 }
Jeff Laytone084c1b2015-02-16 14:32:03 -05001323 locks_delete_lock_ctx(fl, dispose);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001324 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 return 0;
1326}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327EXPORT_SYMBOL(lease_modify);
1328
J. Bruce Fields778fc542011-07-26 18:25:49 -04001329static bool past_time(unsigned long then)
1330{
1331 if (!then)
1332 /* 0 is a special value meaning "this never expires": */
1333 return false;
1334 return time_after(jiffies, then);
1335}
1336
Jeff Laytonc45198e2014-09-01 07:12:07 -04001337static void time_out_leases(struct inode *inode, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338{
Jeff Layton8634b512015-01-16 15:05:55 -05001339 struct file_lock_context *ctx = inode->i_flctx;
1340 struct file_lock *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341
Jeff Layton6109c852015-01-16 15:05:57 -05001342 lockdep_assert_held(&ctx->flc_lock);
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001343
Jeff Layton8634b512015-01-16 15:05:55 -05001344 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001345 trace_time_out_leases(inode, fl);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001346 if (past_time(fl->fl_downgrade_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001347 lease_modify(fl, F_RDLCK, dispose);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001348 if (past_time(fl->fl_break_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001349 lease_modify(fl, F_UNLCK, dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 }
1351}
1352
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001353static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1354{
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001355 if ((breaker->fl_flags & FL_LAYOUT) != (lease->fl_flags & FL_LAYOUT))
1356 return false;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001357 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1358 return false;
1359 return locks_conflict(breaker, lease);
1360}
1361
Jeff Layton03d12dd2014-09-01 14:53:41 -04001362static bool
1363any_leases_conflict(struct inode *inode, struct file_lock *breaker)
1364{
Jeff Layton8634b512015-01-16 15:05:55 -05001365 struct file_lock_context *ctx = inode->i_flctx;
Jeff Layton03d12dd2014-09-01 14:53:41 -04001366 struct file_lock *fl;
1367
Jeff Layton6109c852015-01-16 15:05:57 -05001368 lockdep_assert_held(&ctx->flc_lock);
Jeff Layton03d12dd2014-09-01 14:53:41 -04001369
Jeff Layton8634b512015-01-16 15:05:55 -05001370 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Jeff Layton03d12dd2014-09-01 14:53:41 -04001371 if (leases_conflict(fl, breaker))
1372 return true;
1373 }
1374 return false;
1375}
1376
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377/**
1378 * __break_lease - revoke all outstanding leases on file
1379 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001380 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1381 * break all leases
1382 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1383 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 *
david m. richter87250dd2007-05-09 16:10:27 -04001385 * break_lease (inlined for speed) has checked there already is at least
1386 * some kind of lock (maybe a lease) on this file. Leases are broken on
1387 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 * specified %O_NONBLOCK to your open().
1389 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001390int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001392 int error = 0;
Jeff Layton8634b512015-01-16 15:05:55 -05001393 struct file_lock_context *ctx = inode->i_flctx;
Yan, Zhenga9011252015-03-27 10:34:20 +08001394 struct file_lock *new_fl, *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 unsigned long break_time;
Al Viro8737c932009-12-24 06:47:55 -05001396 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001397 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398
Al Viro8737c932009-12-24 06:47:55 -05001399 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001400 if (IS_ERR(new_fl))
1401 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001402 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403
Jeff Layton8634b512015-01-16 15:05:55 -05001404 /* typically we will check that ctx is non-NULL before calling */
1405 if (!ctx) {
1406 WARN_ON_ONCE(1);
1407 return error;
1408 }
1409
Jeff Layton6109c852015-01-16 15:05:57 -05001410 spin_lock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411
Jeff Laytonc45198e2014-09-01 07:12:07 -04001412 time_out_leases(inode, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413
Jeff Layton03d12dd2014-09-01 14:53:41 -04001414 if (!any_leases_conflict(inode, new_fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001415 goto out;
1416
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 break_time = 0;
1418 if (lease_break_time > 0) {
1419 break_time = jiffies + lease_break_time * HZ;
1420 if (break_time == 0)
1421 break_time++; /* so that 0 means no break time */
1422 }
1423
Yan, Zhenga9011252015-03-27 10:34:20 +08001424 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001425 if (!leases_conflict(fl, new_fl))
1426 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001427 if (want_write) {
1428 if (fl->fl_flags & FL_UNLOCK_PENDING)
1429 continue;
1430 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001432 } else {
Jeff Layton8634b512015-01-16 15:05:55 -05001433 if (lease_breaking(fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001434 continue;
1435 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1436 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 }
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001438 if (fl->fl_lmops->lm_break(fl))
Jeff Laytone084c1b2015-02-16 14:32:03 -05001439 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 }
1441
Jeff Layton8634b512015-01-16 15:05:55 -05001442 if (list_empty(&ctx->flc_lease))
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001443 goto out;
1444
Jeff Layton843c6b22014-09-01 14:27:43 -04001445 if (mode & O_NONBLOCK) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001446 trace_break_lease_noblock(inode, new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447 error = -EWOULDBLOCK;
1448 goto out;
1449 }
1450
1451restart:
Jeff Layton8634b512015-01-16 15:05:55 -05001452 fl = list_first_entry(&ctx->flc_lease, struct file_lock, fl_list);
1453 break_time = fl->fl_break_time;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001454 if (break_time != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 break_time -= jiffies;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001456 if (break_time == 0)
1457 break_time++;
Jeff Layton8634b512015-01-16 15:05:55 -05001458 locks_insert_block(fl, new_fl);
Jeff Layton62af4f12014-05-09 14:13:05 -04001459 trace_break_lease_block(inode, new_fl);
Jeff Layton6109c852015-01-16 15:05:57 -05001460 spin_unlock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001461 locks_dispose_list(&dispose);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001462 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1463 !new_fl->fl_next, break_time);
Jeff Layton6109c852015-01-16 15:05:57 -05001464 spin_lock(&ctx->flc_lock);
Jeff Layton62af4f12014-05-09 14:13:05 -04001465 trace_break_lease_unblock(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001466 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 if (error >= 0) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001468 /*
1469 * Wait for the next conflicting lease that has not been
1470 * broken yet
1471 */
Jeff Layton03d12dd2014-09-01 14:53:41 -04001472 if (error == 0)
1473 time_out_leases(inode, &dispose);
1474 if (any_leases_conflict(inode, new_fl))
1475 goto restart;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 error = 0;
1477 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478out:
Jeff Layton6109c852015-01-16 15:05:57 -05001479 spin_unlock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001480 locks_dispose_list(&dispose);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001481 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 return error;
1483}
1484
1485EXPORT_SYMBOL(__break_lease);
1486
1487/**
Randy Dunlapa6b91912008-03-19 17:01:00 -07001488 * lease_get_mtime - get the last modified time of an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 * @inode: the inode
1490 * @time: pointer to a timespec which will contain the last modified time
1491 *
1492 * This is to force NFS clients to flush their caches for files with
1493 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001494 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495 */
1496void lease_get_mtime(struct inode *inode, struct timespec *time)
1497{
Jeff Laytonbfe86022014-08-22 10:18:44 -04001498 bool has_lease = false;
Jeff Layton8634b512015-01-16 15:05:55 -05001499 struct file_lock_context *ctx = inode->i_flctx;
1500 struct file_lock *fl;
Jeff Laytonbfe86022014-08-22 10:18:44 -04001501
Jeff Layton8634b512015-01-16 15:05:55 -05001502 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Jeff Layton6109c852015-01-16 15:05:57 -05001503 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001504 if (!list_empty(&ctx->flc_lease)) {
1505 fl = list_first_entry(&ctx->flc_lease,
1506 struct file_lock, fl_list);
1507 if (fl->fl_type == F_WRLCK)
1508 has_lease = true;
1509 }
Jeff Layton6109c852015-01-16 15:05:57 -05001510 spin_unlock(&ctx->flc_lock);
Jeff Laytonbfe86022014-08-22 10:18:44 -04001511 }
1512
1513 if (has_lease)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 *time = current_fs_time(inode->i_sb);
1515 else
1516 *time = inode->i_mtime;
1517}
1518
1519EXPORT_SYMBOL(lease_get_mtime);
1520
1521/**
1522 * fcntl_getlease - Enquire what lease is currently active
1523 * @filp: the file
1524 *
1525 * The value returned by this function will be one of
1526 * (if no lease break is pending):
1527 *
1528 * %F_RDLCK to indicate a shared lease is held.
1529 *
1530 * %F_WRLCK to indicate an exclusive lease is held.
1531 *
1532 * %F_UNLCK to indicate no lease is held.
1533 *
1534 * (if a lease break is pending):
1535 *
1536 * %F_RDLCK to indicate an exclusive lease needs to be
1537 * changed to a shared lease (or removed).
1538 *
1539 * %F_UNLCK to indicate the lease needs to be removed.
1540 *
1541 * XXX: sfr & willy disagree over whether F_INPROGRESS
1542 * should be returned to userspace.
1543 */
1544int fcntl_getlease(struct file *filp)
1545{
1546 struct file_lock *fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001547 struct inode *inode = file_inode(filp);
Jeff Layton8634b512015-01-16 15:05:55 -05001548 struct file_lock_context *ctx = inode->i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 int type = F_UNLCK;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001550 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551
Jeff Layton8634b512015-01-16 15:05:55 -05001552 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Jeff Layton6109c852015-01-16 15:05:57 -05001553 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001554 time_out_leases(file_inode(filp), &dispose);
1555 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1556 if (fl->fl_file != filp)
1557 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001558 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 break;
1560 }
Jeff Layton6109c852015-01-16 15:05:57 -05001561 spin_unlock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001562 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 return type;
1565}
1566
Jeff Layton24cbe782014-02-03 12:13:06 -05001567/**
1568 * check_conflicting_open - see if the given dentry points to a file that has
1569 * an existing open that would conflict with the
1570 * desired lease.
1571 * @dentry: dentry to check
1572 * @arg: type of lease that we're trying to acquire
1573 *
1574 * Check to see if there's an existing open fd on this file that would
1575 * conflict with the lease we're trying to set.
1576 */
1577static int
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001578check_conflicting_open(const struct dentry *dentry, const long arg, int flags)
Jeff Layton24cbe782014-02-03 12:13:06 -05001579{
1580 int ret = 0;
1581 struct inode *inode = dentry->d_inode;
1582
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001583 if (flags & FL_LAYOUT)
1584 return 0;
1585
Jeff Layton24cbe782014-02-03 12:13:06 -05001586 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1587 return -EAGAIN;
1588
1589 if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1590 (atomic_read(&inode->i_count) > 1)))
1591 ret = -EAGAIN;
1592
1593 return ret;
1594}
1595
Jeff Laytone6f5c782014-08-22 10:40:25 -04001596static int
1597generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598{
Jeff Layton8634b512015-01-16 15:05:55 -05001599 struct file_lock *fl, *my_fl = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001600 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 struct inode *inode = dentry->d_inode;
Jeff Layton8634b512015-01-16 15:05:55 -05001602 struct file_lock_context *ctx;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001603 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001604 int error;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001605 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606
J. Bruce Fields096657b2010-10-30 17:31:14 -04001607 lease = *flp;
Jeff Layton62af4f12014-05-09 14:13:05 -04001608 trace_generic_add_lease(inode, lease);
1609
Jeff Layton5c1c6692015-04-03 09:04:03 -04001610 /* Note that arg is never F_UNLCK here */
1611 ctx = locks_get_lock_context(inode, arg);
Jeff Layton8634b512015-01-16 15:05:55 -05001612 if (!ctx)
1613 return -ENOMEM;
1614
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001615 /*
1616 * In the delegation case we need mutual exclusion with
1617 * a number of operations that take the i_mutex. We trylock
1618 * because delegations are an optional optimization, and if
1619 * there's some chance of a conflict--we'd rather not
1620 * bother, maybe that's a sign this just isn't a good file to
1621 * hand out a delegation on.
1622 */
1623 if (is_deleg && !mutex_trylock(&inode->i_mutex))
1624 return -EAGAIN;
1625
1626 if (is_deleg && arg == F_WRLCK) {
1627 /* Write delegations are not currently supported: */
Dan Carpenter4fdb7932013-11-13 10:56:27 +03001628 mutex_unlock(&inode->i_mutex);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001629 WARN_ON_ONCE(1);
1630 return -EINVAL;
1631 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001632
Jeff Layton6109c852015-01-16 15:05:57 -05001633 spin_lock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001634 time_out_leases(inode, &dispose);
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001635 error = check_conflicting_open(dentry, arg, lease->fl_flags);
Jeff Layton24cbe782014-02-03 12:13:06 -05001636 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001637 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001638
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 /*
1640 * At this point, we know that if there is an exclusive
1641 * lease on this file, then we hold it on this filp
1642 * (otherwise our open of this file would have blocked).
1643 * And if we are trying to acquire an exclusive lease,
1644 * then the file is not open by anyone (including us)
1645 * except for this filp.
1646 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001647 error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001648 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001649 if (fl->fl_file == filp &&
1650 fl->fl_owner == lease->fl_owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001651 my_fl = fl;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001652 continue;
1653 }
Jeff Layton8634b512015-01-16 15:05:55 -05001654
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001655 /*
1656 * No exclusive leases if someone else has a lease on
1657 * this file:
1658 */
1659 if (arg == F_WRLCK)
1660 goto out;
1661 /*
1662 * Modifying our existing lease is OK, but no getting a
1663 * new lease if someone else is opening for write:
1664 */
1665 if (fl->fl_flags & FL_UNLOCK_PENDING)
1666 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 }
1668
Jeff Layton8634b512015-01-16 15:05:55 -05001669 if (my_fl != NULL) {
Jeff Layton0164bf02015-03-04 17:34:32 -05001670 lease = my_fl;
1671 error = lease->fl_lmops->lm_change(lease, arg, &dispose);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001672 if (error)
1673 goto out;
1674 goto out_setup;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 }
1676
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 error = -EINVAL;
1678 if (!leases_enable)
1679 goto out;
1680
Jeff Laytone084c1b2015-02-16 14:32:03 -05001681 locks_insert_lock_ctx(lease, &ctx->flc_lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001682 /*
1683 * The check in break_lease() is lockless. It's possible for another
1684 * open to race in after we did the earlier check for a conflicting
1685 * open but before the lease was inserted. Check again for a
1686 * conflicting open and cancel the lease if there is one.
1687 *
1688 * We also add a barrier here to ensure that the insertion of the lock
1689 * precedes these checks.
1690 */
1691 smp_mb();
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001692 error = check_conflicting_open(dentry, arg, lease->fl_flags);
Jeff Layton8634b512015-01-16 15:05:55 -05001693 if (error) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001694 locks_unlink_lock_ctx(lease);
Jeff Layton8634b512015-01-16 15:05:55 -05001695 goto out;
1696 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001697
1698out_setup:
1699 if (lease->fl_lmops->lm_setup)
1700 lease->fl_lmops->lm_setup(lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701out:
Jeff Layton6109c852015-01-16 15:05:57 -05001702 spin_unlock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001703 locks_dispose_list(&dispose);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001704 if (is_deleg)
1705 mutex_unlock(&inode->i_mutex);
Jeff Layton8634b512015-01-16 15:05:55 -05001706 if (!error && !my_fl)
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001707 *flp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 return error;
1709}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001710
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001711static int generic_delete_lease(struct file *filp, void *owner)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001712{
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001713 int error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001714 struct file_lock *fl, *victim = NULL;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001715 struct dentry *dentry = filp->f_path.dentry;
1716 struct inode *inode = dentry->d_inode;
Jeff Layton8634b512015-01-16 15:05:55 -05001717 struct file_lock_context *ctx = inode->i_flctx;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001718 LIST_HEAD(dispose);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001719
Jeff Layton8634b512015-01-16 15:05:55 -05001720 if (!ctx) {
1721 trace_generic_delete_lease(inode, NULL);
1722 return error;
1723 }
1724
Jeff Layton6109c852015-01-16 15:05:57 -05001725 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001726 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001727 if (fl->fl_file == filp &&
1728 fl->fl_owner == owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001729 victim = fl;
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001730 break;
Jeff Layton8634b512015-01-16 15:05:55 -05001731 }
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001732 }
Jeff Laytona9b1b452015-03-14 09:45:35 -04001733 trace_generic_delete_lease(inode, victim);
Jeff Layton8634b512015-01-16 15:05:55 -05001734 if (victim)
Jeff Layton7448cc32015-01-16 15:05:57 -05001735 error = fl->fl_lmops->lm_change(victim, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05001736 spin_unlock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001737 locks_dispose_list(&dispose);
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001738 return error;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001739}
1740
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741/**
1742 * generic_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001743 * @filp: file pointer
1744 * @arg: type of lease to obtain
1745 * @flp: input - file_lock to use, output - file_lock inserted
1746 * @priv: private data for lm_setup (may be NULL if lm_setup
1747 * doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 *
1749 * The (input) flp->fl_lmops->lm_break function is required
1750 * by break_lease().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001752int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
1753 void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 struct dentry *dentry = filp->f_path.dentry;
1756 struct inode *inode = dentry->d_inode;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001757 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001759 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001760 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001762 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 error = security_file_lock(filp, arg);
1764 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001765 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001767 switch (arg) {
1768 case F_UNLCK:
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001769 return generic_delete_lease(filp, *priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001770 case F_RDLCK:
1771 case F_WRLCK:
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001772 if (!(*flp)->fl_lmops->lm_break) {
1773 WARN_ON_ONCE(1);
1774 return -ENOLCK;
1775 }
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001776
Jeff Laytone6f5c782014-08-22 10:40:25 -04001777 return generic_add_lease(filp, arg, flp, priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001778 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001779 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001782EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001784/**
Jeff Laytone51673a2014-08-22 18:13:28 -04001785 * vfs_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001786 * @filp: file pointer
1787 * @arg: type of lease to obtain
1788 * @lease: file_lock to use when adding a lease
1789 * @priv: private info for lm_setup when adding a lease (may be
1790 * NULL if lm_setup doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791 *
Jeff Laytone51673a2014-08-22 18:13:28 -04001792 * Call this to establish a lease on the file. The "lease" argument is not
1793 * used for F_UNLCK requests and may be NULL. For commands that set or alter
1794 * an existing lease, the (*lease)->fl_lmops->lm_break operation must be set;
1795 * if not, this function will return -ENOLCK (and generate a scary-looking
1796 * stack trace).
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001797 *
1798 * The "priv" pointer is passed directly to the lm_setup function as-is. It
1799 * may be NULL if the lm_setup operation doesn't require it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001801int
1802vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803{
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001804 if (filp->f_op->setlease)
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001805 return filp->f_op->setlease(filp, arg, lease, priv);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001806 else
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001807 return generic_setlease(filp, arg, lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001809EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001811static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812{
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001813 struct file_lock *fl;
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001814 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 int error;
1816
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001817 fl = lease_alloc(filp, arg);
1818 if (IS_ERR(fl))
1819 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001821 new = fasync_alloc();
1822 if (!new) {
1823 locks_free_lock(fl);
1824 return -ENOMEM;
1825 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001826 new->fa_fd = fd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001828 error = vfs_setlease(filp, arg, &fl, (void **)&new);
Jeff Layton2dfb9282014-08-11 18:14:12 -04001829 if (fl)
1830 locks_free_lock(fl);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001831 if (new)
1832 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833 return error;
1834}
1835
1836/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001837 * fcntl_setlease - sets a lease on an open file
1838 * @fd: open file descriptor
1839 * @filp: file pointer
1840 * @arg: type of lease to obtain
1841 *
1842 * Call this fcntl to establish a lease on the file.
1843 * Note that you also need to call %F_SETSIG to
1844 * receive a signal when the lease is broken.
1845 */
1846int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1847{
1848 if (arg == F_UNLCK)
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001849 return vfs_setlease(filp, F_UNLCK, NULL, (void **)&filp);
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001850 return do_fcntl_add_lease(fd, filp, arg);
1851}
1852
1853/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1855 * @filp: The file to apply the lock to
1856 * @fl: The lock to be applied
1857 *
1858 * Add a FLOCK style lock to a file.
1859 */
1860int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1861{
1862 int error;
1863 might_sleep();
1864 for (;;) {
1865 error = flock_lock_file(filp, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001866 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 break;
1868 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1869 if (!error)
1870 continue;
1871
1872 locks_delete_block(fl);
1873 break;
1874 }
1875 return error;
1876}
1877
1878EXPORT_SYMBOL(flock_lock_file_wait);
1879
1880/**
1881 * sys_flock: - flock() system call.
1882 * @fd: the file descriptor to lock.
1883 * @cmd: the type of lock to apply.
1884 *
1885 * Apply a %FL_FLOCK style lock to an open file descriptor.
1886 * The @cmd can be one of
1887 *
1888 * %LOCK_SH -- a shared lock.
1889 *
1890 * %LOCK_EX -- an exclusive lock.
1891 *
1892 * %LOCK_UN -- remove an existing lock.
1893 *
1894 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1895 *
1896 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1897 * processes read and write access respectively.
1898 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001899SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900{
Al Viro2903ff02012-08-28 12:52:22 -04001901 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 struct file_lock *lock;
1903 int can_sleep, unlock;
1904 int error;
1905
1906 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001907 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 goto out;
1909
1910 can_sleep = !(cmd & LOCK_NB);
1911 cmd &= ~LOCK_NB;
1912 unlock = (cmd == LOCK_UN);
1913
Al Viroaeb5d722008-09-02 15:28:45 -04001914 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04001915 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916 goto out_putf;
1917
Jeff Layton6e129d002014-09-04 10:25:06 -04001918 lock = flock_make_lock(f.file, cmd);
1919 if (IS_ERR(lock)) {
1920 error = PTR_ERR(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 goto out_putf;
Jeff Layton6e129d002014-09-04 10:25:06 -04001922 }
1923
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924 if (can_sleep)
1925 lock->fl_flags |= FL_SLEEP;
1926
Al Viro2903ff02012-08-28 12:52:22 -04001927 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 if (error)
1929 goto out_free;
1930
Al Viro72c2d532013-09-22 16:27:52 -04001931 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04001932 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 (can_sleep) ? F_SETLKW : F_SETLK,
1934 lock);
1935 else
Al Viro2903ff02012-08-28 12:52:22 -04001936 error = flock_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937
1938 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08001939 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940
1941 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04001942 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943 out:
1944 return error;
1945}
1946
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001947/**
1948 * vfs_test_lock - test file byte range lock
1949 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04001950 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001951 *
1952 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1953 * setting conf->fl_type to something other than F_UNLCK.
1954 */
1955int vfs_test_lock(struct file *filp, struct file_lock *fl)
1956{
Al Viro72c2d532013-09-22 16:27:52 -04001957 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001958 return filp->f_op->lock(filp, F_GETLK, fl);
1959 posix_test_lock(filp, fl);
1960 return 0;
1961}
1962EXPORT_SYMBOL_GPL(vfs_test_lock);
1963
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001964static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1965{
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001966 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001967#if BITS_PER_LONG == 32
1968 /*
1969 * Make sure we can represent the posix lock via
1970 * legacy 32bit flock.
1971 */
1972 if (fl->fl_start > OFFT_OFFSET_MAX)
1973 return -EOVERFLOW;
1974 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1975 return -EOVERFLOW;
1976#endif
1977 flock->l_start = fl->fl_start;
1978 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1979 fl->fl_end - fl->fl_start + 1;
1980 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04001981 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001982 return 0;
1983}
1984
1985#if BITS_PER_LONG == 32
1986static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1987{
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001988 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001989 flock->l_start = fl->fl_start;
1990 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1991 fl->fl_end - fl->fl_start + 1;
1992 flock->l_whence = 0;
1993 flock->l_type = fl->fl_type;
1994}
1995#endif
1996
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997/* Report the first existing lock that would conflict with l.
1998 * This implements the F_GETLK command of fcntl().
1999 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05002000int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002002 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 struct flock flock;
2004 int error;
2005
2006 error = -EFAULT;
2007 if (copy_from_user(&flock, l, sizeof(flock)))
2008 goto out;
2009 error = -EINVAL;
2010 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2011 goto out;
2012
2013 error = flock_to_posix_lock(filp, &file_lock, &flock);
2014 if (error)
2015 goto out;
2016
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002017 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002018 error = -EINVAL;
2019 if (flock.l_pid != 0)
2020 goto out;
2021
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002022 cmd = F_GETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002023 file_lock.fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002024 file_lock.fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002025 }
2026
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002027 error = vfs_test_lock(filp, &file_lock);
2028 if (error)
2029 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002031 flock.l_type = file_lock.fl_type;
2032 if (file_lock.fl_type != F_UNLCK) {
2033 error = posix_lock_to_flock(&flock, &file_lock);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002034 if (error)
Kinglong Meef3282962014-08-22 10:18:43 -04002035 goto rel_priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036 }
2037 error = -EFAULT;
2038 if (!copy_to_user(l, &flock, sizeof(flock)))
2039 error = 0;
Kinglong Meef3282962014-08-22 10:18:43 -04002040rel_priv:
2041 locks_release_private(&file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042out:
2043 return error;
2044}
2045
Marc Eshel7723ec92007-01-18 15:08:55 -05002046/**
2047 * vfs_lock_file - file byte range lock
2048 * @filp: The file to apply the lock to
2049 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2050 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05002051 * @conf: Place to return a copy of the conflicting lock, if found.
2052 *
2053 * A caller that doesn't care about the conflicting lock may pass NULL
2054 * as the final argument.
2055 *
2056 * If the filesystem defines a private ->lock() method, then @conf will
2057 * be left unchanged; so a caller that cares should initialize it to
2058 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05002059 *
2060 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2061 * locks, the ->lock() interface may return asynchronously, before the lock has
2062 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002063 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05002064 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2065 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002066 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05002067 * request completes.
2068 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07002069 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2070 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05002071 * nonzero return code and the file system should release the lock. The file
2072 * system is also responsible to keep a corresponding posix lock when it
2073 * grants a lock so the VFS can find out which locks are locally held and do
2074 * the correct lock cleanup when required.
2075 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002076 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05002077 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05002078 */
Marc Eshel150b3932007-01-18 16:15:35 -05002079int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05002080{
Al Viro72c2d532013-09-22 16:27:52 -04002081 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05002082 return filp->f_op->lock(filp, cmd, fl);
2083 else
Marc Eshel150b3932007-01-18 16:15:35 -05002084 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05002085}
2086EXPORT_SYMBOL_GPL(vfs_lock_file);
2087
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002088static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2089 struct file_lock *fl)
2090{
2091 int error;
2092
2093 error = security_file_lock(filp, fl->fl_type);
2094 if (error)
2095 return error;
2096
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002097 for (;;) {
2098 error = vfs_lock_file(filp, cmd, fl, NULL);
2099 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002100 break;
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002101 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
2102 if (!error)
2103 continue;
2104
2105 locks_delete_block(fl);
2106 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002107 }
2108
2109 return error;
2110}
2111
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002112/* Ensure that fl->fl_filp has compatible f_mode for F_SETLK calls */
2113static int
2114check_fmode_for_setlk(struct file_lock *fl)
2115{
2116 switch (fl->fl_type) {
2117 case F_RDLCK:
2118 if (!(fl->fl_file->f_mode & FMODE_READ))
2119 return -EBADF;
2120 break;
2121 case F_WRLCK:
2122 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2123 return -EBADF;
2124 }
2125 return 0;
2126}
2127
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128/* Apply the lock described by l to an open file descriptor.
2129 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2130 */
Peter Staubachc2936212005-07-27 11:45:09 -07002131int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
2132 struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133{
2134 struct file_lock *file_lock = locks_alloc_lock();
2135 struct flock flock;
2136 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002137 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138 int error;
2139
2140 if (file_lock == NULL)
2141 return -ENOLCK;
2142
2143 /*
2144 * This might block, so we do it before checking the inode.
2145 */
2146 error = -EFAULT;
2147 if (copy_from_user(&flock, l, sizeof(flock)))
2148 goto out;
2149
Al Viro496ad9a2013-01-23 17:07:38 -05002150 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151
2152 /* Don't allow mandatory locks on files that may be memory mapped
2153 * and shared.
2154 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002155 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 error = -EAGAIN;
2157 goto out;
2158 }
2159
Peter Staubachc2936212005-07-27 11:45:09 -07002160again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 error = flock_to_posix_lock(filp, file_lock, &flock);
2162 if (error)
2163 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002164
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002165 error = check_fmode_for_setlk(file_lock);
2166 if (error)
2167 goto out;
2168
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002169 /*
2170 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002171 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002172 */
2173 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002174 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002175 error = -EINVAL;
2176 if (flock.l_pid != 0)
2177 goto out;
2178
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002179 cmd = F_SETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002180 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002181 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002182 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002183 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002184 error = -EINVAL;
2185 if (flock.l_pid != 0)
2186 goto out;
2187
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002188 cmd = F_SETLKW;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002189 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002190 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002191 /* Fallthrough */
2192 case F_SETLKW:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193 file_lock->fl_flags |= FL_SLEEP;
2194 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002195
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002196 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197
Peter Staubachc2936212005-07-27 11:45:09 -07002198 /*
2199 * Attempt to detect a close/fcntl race and recover by
2200 * releasing the lock that was just acquired.
2201 */
Al Viro0b2bac22008-05-06 13:58:34 -04002202 /*
2203 * we need that spin_lock here - it prevents reordering between
Jeff Layton8116bf42015-01-21 20:44:01 -05002204 * update of i_flctx->flc_posix and check for it done in close().
Al Viro0b2bac22008-05-06 13:58:34 -04002205 * rcu_read_lock() wouldn't do.
2206 */
2207 spin_lock(&current->files->file_lock);
2208 f = fcheck(fd);
2209 spin_unlock(&current->files->file_lock);
2210 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002211 flock.l_type = F_UNLCK;
2212 goto again;
2213 }
2214
2215out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 locks_free_lock(file_lock);
2217 return error;
2218}
2219
2220#if BITS_PER_LONG == 32
2221/* Report the first existing lock that would conflict with l.
2222 * This implements the F_GETLK command of fcntl().
2223 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05002224int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002226 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227 struct flock64 flock;
2228 int error;
2229
2230 error = -EFAULT;
2231 if (copy_from_user(&flock, l, sizeof(flock)))
2232 goto out;
2233 error = -EINVAL;
2234 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2235 goto out;
2236
2237 error = flock64_to_posix_lock(filp, &file_lock, &flock);
2238 if (error)
2239 goto out;
2240
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002241 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002242 error = -EINVAL;
2243 if (flock.l_pid != 0)
2244 goto out;
2245
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002246 cmd = F_GETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002247 file_lock.fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002248 file_lock.fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002249 }
2250
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002251 error = vfs_test_lock(filp, &file_lock);
2252 if (error)
2253 goto out;
2254
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002255 flock.l_type = file_lock.fl_type;
2256 if (file_lock.fl_type != F_UNLCK)
2257 posix_lock_to_flock64(&flock, &file_lock);
2258
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259 error = -EFAULT;
2260 if (!copy_to_user(l, &flock, sizeof(flock)))
2261 error = 0;
Kinglong Meef3282962014-08-22 10:18:43 -04002262
2263 locks_release_private(&file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264out:
2265 return error;
2266}
2267
2268/* Apply the lock described by l to an open file descriptor.
2269 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2270 */
Peter Staubachc2936212005-07-27 11:45:09 -07002271int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2272 struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273{
2274 struct file_lock *file_lock = locks_alloc_lock();
2275 struct flock64 flock;
2276 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002277 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 int error;
2279
2280 if (file_lock == NULL)
2281 return -ENOLCK;
2282
2283 /*
2284 * This might block, so we do it before checking the inode.
2285 */
2286 error = -EFAULT;
2287 if (copy_from_user(&flock, l, sizeof(flock)))
2288 goto out;
2289
Al Viro496ad9a2013-01-23 17:07:38 -05002290 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291
2292 /* Don't allow mandatory locks on files that may be memory mapped
2293 * and shared.
2294 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002295 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296 error = -EAGAIN;
2297 goto out;
2298 }
2299
Peter Staubachc2936212005-07-27 11:45:09 -07002300again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 error = flock64_to_posix_lock(filp, file_lock, &flock);
2302 if (error)
2303 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002304
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002305 error = check_fmode_for_setlk(file_lock);
2306 if (error)
2307 goto out;
2308
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002309 /*
2310 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002311 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002312 */
2313 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002314 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002315 error = -EINVAL;
2316 if (flock.l_pid != 0)
2317 goto out;
2318
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002319 cmd = F_SETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002320 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002321 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002322 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002323 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002324 error = -EINVAL;
2325 if (flock.l_pid != 0)
2326 goto out;
2327
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002328 cmd = F_SETLKW64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002329 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002330 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002331 /* Fallthrough */
2332 case F_SETLKW64:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 file_lock->fl_flags |= FL_SLEEP;
2334 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002335
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002336 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337
Peter Staubachc2936212005-07-27 11:45:09 -07002338 /*
2339 * Attempt to detect a close/fcntl race and recover by
2340 * releasing the lock that was just acquired.
2341 */
Al Viro0b2bac22008-05-06 13:58:34 -04002342 spin_lock(&current->files->file_lock);
2343 f = fcheck(fd);
2344 spin_unlock(&current->files->file_lock);
2345 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002346 flock.l_type = F_UNLCK;
2347 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002348 }
2349
2350out:
2351 locks_free_lock(file_lock);
2352 return error;
2353}
2354#endif /* BITS_PER_LONG == 32 */
2355
2356/*
2357 * This function is called when the file is being removed
2358 * from the task's fd array. POSIX locks belonging to this task
2359 * are deleted at this time.
2360 */
2361void locks_remove_posix(struct file *filp, fl_owner_t owner)
2362{
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002363 struct file_lock lock;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05002364 struct file_lock_context *ctx = file_inode(filp)->i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365
2366 /*
2367 * If there are no locks held on this file, we don't need to call
2368 * posix_lock_file(). Another process could be setting a lock on this
2369 * file at the same time, but we wouldn't remove that lock anyway.
2370 */
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05002371 if (!ctx || list_empty(&ctx->flc_posix))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372 return;
2373
2374 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002375 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376 lock.fl_start = 0;
2377 lock.fl_end = OFFSET_MAX;
2378 lock.fl_owner = owner;
2379 lock.fl_pid = current->tgid;
2380 lock.fl_file = filp;
2381 lock.fl_ops = NULL;
2382 lock.fl_lmops = NULL;
2383
Marc Eshel150b3932007-01-18 16:15:35 -05002384 vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2387 lock.fl_ops->fl_release_private(&lock);
2388}
2389
2390EXPORT_SYMBOL(locks_remove_posix);
2391
Jeff Layton3d8e5602015-01-16 15:05:58 -05002392/* The i_flctx must be valid when calling into here */
Jeff Laytondd459bb2015-01-16 15:05:54 -05002393static void
2394locks_remove_flock(struct file *filp)
2395{
2396 struct file_lock fl = {
2397 .fl_owner = filp,
2398 .fl_pid = current->tgid,
2399 .fl_file = filp,
2400 .fl_flags = FL_FLOCK,
2401 .fl_type = F_UNLCK,
2402 .fl_end = OFFSET_MAX,
2403 };
Jeff Layton5263e312015-01-16 15:05:55 -05002404 struct file_lock_context *flctx = file_inode(filp)->i_flctx;
Jeff Laytondd459bb2015-01-16 15:05:54 -05002405
Jeff Layton3d8e5602015-01-16 15:05:58 -05002406 if (list_empty(&flctx->flc_flock))
Jeff Laytondd459bb2015-01-16 15:05:54 -05002407 return;
2408
2409 if (filp->f_op->flock)
2410 filp->f_op->flock(filp, F_SETLKW, &fl);
2411 else
2412 flock_lock_file(filp, &fl);
2413
2414 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2415 fl.fl_ops->fl_release_private(&fl);
2416}
2417
Jeff Layton3d8e5602015-01-16 15:05:58 -05002418/* The i_flctx must be valid when calling into here */
Jeff Layton8634b512015-01-16 15:05:55 -05002419static void
2420locks_remove_lease(struct file *filp)
2421{
2422 struct inode *inode = file_inode(filp);
2423 struct file_lock_context *ctx = inode->i_flctx;
2424 struct file_lock *fl, *tmp;
2425 LIST_HEAD(dispose);
2426
Jeff Layton3d8e5602015-01-16 15:05:58 -05002427 if (list_empty(&ctx->flc_lease))
Jeff Layton8634b512015-01-16 15:05:55 -05002428 return;
2429
Jeff Layton6109c852015-01-16 15:05:57 -05002430 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05002431 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list)
Jeff Laytonc4e136c2015-02-16 19:37:42 -05002432 if (filp == fl->fl_file)
2433 lease_modify(fl, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05002434 spin_unlock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05002435 locks_dispose_list(&dispose);
2436}
2437
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438/*
2439 * This function is called on the last close of an open file.
2440 */
Jeff Layton78ed8a12014-02-03 12:13:08 -05002441void locks_remove_file(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442{
Jeff Layton3d8e5602015-01-16 15:05:58 -05002443 if (!file_inode(filp)->i_flctx)
2444 return;
2445
Jeff Laytondd459bb2015-01-16 15:05:54 -05002446 /* remove any OFD locks */
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002447 locks_remove_posix(filp, filp);
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002448
Jeff Laytondd459bb2015-01-16 15:05:54 -05002449 /* remove flock locks */
2450 locks_remove_flock(filp);
2451
Jeff Layton8634b512015-01-16 15:05:55 -05002452 /* remove any leases */
2453 locks_remove_lease(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454}
2455
2456/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457 * posix_unblock_lock - stop waiting for a file lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07002458 * @waiter: the lock which was waiting
2459 *
2460 * lockd needs to block waiting for locks.
2461 */
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002462int
Jeff Laytonf891a292013-06-21 08:58:09 -04002463posix_unblock_lock(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464{
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002465 int status = 0;
2466
Jeff Layton7b2296a2013-06-21 08:58:20 -04002467 spin_lock(&blocked_lock_lock);
J. Bruce Fields5996a292006-01-03 09:55:44 +01002468 if (waiter->fl_next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469 __locks_delete_block(waiter);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002470 else
2471 status = -ENOENT;
Jeff Layton7b2296a2013-06-21 08:58:20 -04002472 spin_unlock(&blocked_lock_lock);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002473 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475EXPORT_SYMBOL(posix_unblock_lock);
2476
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002477/**
2478 * vfs_cancel_lock - file byte range unblock lock
2479 * @filp: The file to apply the unblock to
2480 * @fl: The lock to be unblocked
2481 *
2482 * Used by lock managers to cancel blocked requests
2483 */
2484int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2485{
Al Viro72c2d532013-09-22 16:27:52 -04002486 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002487 return filp->f_op->lock(filp, F_CANCELLK, fl);
2488 return 0;
2489}
2490
2491EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2492
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002493#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002494#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002495#include <linux/seq_file.h>
2496
Jeff Layton7012b022013-06-21 08:58:22 -04002497struct locks_iterator {
2498 int li_cpu;
2499 loff_t li_pos;
2500};
2501
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002502static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002503 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504{
2505 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002506 unsigned int fl_pid;
2507
2508 if (fl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -08002509 fl_pid = pid_vnr(fl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002510 else
2511 fl_pid = fl->fl_pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512
2513 if (fl->fl_file != NULL)
Al Viro496ad9a2013-01-23 17:07:38 -05002514 inode = file_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515
Jerome Marchand99dc8292010-10-26 14:22:33 -07002516 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517 if (IS_POSIX(fl)) {
Jeff Laytonc918d422014-02-03 12:13:09 -05002518 if (fl->fl_flags & FL_ACCESS)
Fabian Frederick5315c262014-05-09 14:13:05 -04002519 seq_puts(f, "ACCESS");
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002520 else if (IS_OFDLCK(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002521 seq_puts(f, "OFDLCK");
Jeff Laytonc918d422014-02-03 12:13:09 -05002522 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002523 seq_puts(f, "POSIX ");
Jeff Laytonc918d422014-02-03 12:13:09 -05002524
2525 seq_printf(f, " %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002526 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002527 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528 } else if (IS_FLOCK(fl)) {
2529 if (fl->fl_type & LOCK_MAND) {
Fabian Frederick5315c262014-05-09 14:13:05 -04002530 seq_puts(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002532 seq_puts(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533 }
2534 } else if (IS_LEASE(fl)) {
Jeff Layton8144f1f2014-08-11 13:36:54 -04002535 if (fl->fl_flags & FL_DELEG)
2536 seq_puts(f, "DELEG ");
2537 else
2538 seq_puts(f, "LEASE ");
2539
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002540 if (lease_breaking(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002541 seq_puts(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002542 else if (fl->fl_file)
Fabian Frederick5315c262014-05-09 14:13:05 -04002543 seq_puts(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002545 seq_puts(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002546 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002547 seq_puts(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548 }
2549 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002550 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002551 (fl->fl_type & LOCK_READ)
2552 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2553 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2554 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002555 seq_printf(f, "%s ",
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002556 (lease_breaking(fl))
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04002557 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2558 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559 }
2560 if (inode) {
Jeff Layton36488882015-04-03 09:04:04 -04002561 /* userspace relies on this representation of dev_t */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002562 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563 MAJOR(inode->i_sb->s_dev),
2564 MINOR(inode->i_sb->s_dev), inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002565 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002566 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002567 }
2568 if (IS_POSIX(fl)) {
2569 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002570 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002571 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002572 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002574 seq_puts(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002575 }
2576}
2577
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002578static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002579{
Jeff Layton7012b022013-06-21 08:58:22 -04002580 struct locks_iterator *iter = f->private;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002581 struct file_lock *fl, *bfl;
2582
Jeff Layton139ca042013-06-21 08:58:17 -04002583 fl = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002584
Jeff Layton7012b022013-06-21 08:58:22 -04002585 lock_get_status(f, fl, iter->li_pos, "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002586
2587 list_for_each_entry(bfl, &fl->fl_block, fl_block)
Jeff Layton7012b022013-06-21 08:58:22 -04002588 lock_get_status(f, bfl, iter->li_pos, " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002589
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002590 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591}
2592
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002593static void __show_fd_locks(struct seq_file *f,
2594 struct list_head *head, int *id,
2595 struct file *filp, struct files_struct *files)
2596{
2597 struct file_lock *fl;
2598
2599 list_for_each_entry(fl, head, fl_list) {
2600
2601 if (filp != fl->fl_file)
2602 continue;
2603 if (fl->fl_owner != files &&
2604 fl->fl_owner != filp)
2605 continue;
2606
2607 (*id)++;
2608 seq_puts(f, "lock:\t");
2609 lock_get_status(f, fl, *id, "");
2610 }
2611}
2612
2613void show_fd_locks(struct seq_file *f,
2614 struct file *filp, struct files_struct *files)
2615{
2616 struct inode *inode = file_inode(filp);
2617 struct file_lock_context *ctx;
2618 int id = 0;
2619
2620 ctx = inode->i_flctx;
2621 if (!ctx)
2622 return;
2623
2624 spin_lock(&ctx->flc_lock);
2625 __show_fd_locks(f, &ctx->flc_flock, &id, filp, files);
2626 __show_fd_locks(f, &ctx->flc_posix, &id, filp, files);
2627 __show_fd_locks(f, &ctx->flc_lease, &id, filp, files);
2628 spin_unlock(&ctx->flc_lock);
2629}
2630
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002631static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002632 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633{
Jeff Layton7012b022013-06-21 08:58:22 -04002634 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002635
Jeff Layton7012b022013-06-21 08:58:22 -04002636 iter->li_pos = *pos + 1;
2637 lg_global_lock(&file_lock_lglock);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002638 spin_lock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002639 return seq_hlist_start_percpu(&file_lock_list, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640}
2641
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002642static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2643{
Jeff Layton7012b022013-06-21 08:58:22 -04002644 struct locks_iterator *iter = f->private;
2645
2646 ++iter->li_pos;
2647 return seq_hlist_next_percpu(v, &file_lock_list, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002648}
2649
2650static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002651 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002652{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002653 spin_unlock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002654 lg_global_unlock(&file_lock_lglock);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002655}
2656
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002657static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002658 .start = locks_start,
2659 .next = locks_next,
2660 .stop = locks_stop,
2661 .show = locks_show,
2662};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002663
2664static int locks_open(struct inode *inode, struct file *filp)
2665{
Jeff Layton7012b022013-06-21 08:58:22 -04002666 return seq_open_private(filp, &locks_seq_operations,
2667 sizeof(struct locks_iterator));
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002668}
2669
2670static const struct file_operations proc_locks_operations = {
2671 .open = locks_open,
2672 .read = seq_read,
2673 .llseek = seq_lseek,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002674 .release = seq_release_private,
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002675};
2676
2677static int __init proc_locks_init(void)
2678{
2679 proc_create("locks", 0, NULL, &proc_locks_operations);
2680 return 0;
2681}
2682module_init(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002683#endif
2684
Linus Torvalds1da177e2005-04-16 15:20:36 -07002685static int __init filelock_init(void)
2686{
Jeff Layton7012b022013-06-21 08:58:22 -04002687 int i;
2688
Jeff Layton4a075e32015-01-16 15:05:54 -05002689 flctx_cache = kmem_cache_create("file_lock_ctx",
2690 sizeof(struct file_lock_context), 0, SLAB_PANIC, NULL);
2691
Linus Torvalds1da177e2005-04-16 15:20:36 -07002692 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002693 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2694
Jeff Layton7012b022013-06-21 08:58:22 -04002695 lg_lock_init(&file_lock_lglock, "file_lock_lglock");
2696
2697 for_each_possible_cpu(i)
2698 INIT_HLIST_HEAD(per_cpu_ptr(&file_lock_list, i));
2699
Linus Torvalds1da177e2005-04-16 15:20:36 -07002700 return 0;
2701}
2702
2703core_initcall(filelock_init);