blob: 54a79883a7f97813cc282c11ab635533fa426ac2 [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 */
226 spin_lock(&inode->i_lock);
227 if (likely(!inode->i_flctx)) {
228 inode->i_flctx = new;
229 new = NULL;
230 }
231 spin_unlock(&inode->i_lock);
232
233 if (new)
234 kmem_cache_free(flctx_cache, new);
235out:
236 return inode->i_flctx;
237}
238
239void
240locks_free_lock_context(struct file_lock_context *ctx)
241{
242 if (ctx) {
243 WARN_ON_ONCE(!list_empty(&ctx->flc_flock));
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500244 WARN_ON_ONCE(!list_empty(&ctx->flc_posix));
Jeff Layton8634b512015-01-16 15:05:55 -0500245 WARN_ON_ONCE(!list_empty(&ctx->flc_lease));
Jeff Layton4a075e32015-01-16 15:05:54 -0500246 kmem_cache_free(flctx_cache, ctx);
247 }
248}
249
Miklos Szerediee19cc42011-07-07 13:06:09 +0200250static void locks_init_lock_heads(struct file_lock *fl)
Miklos Szeredia51cb912011-07-06 12:33:55 +0200251{
Jeff Layton139ca042013-06-21 08:58:17 -0400252 INIT_HLIST_NODE(&fl->fl_link);
Jeff Layton6dee60f2015-01-16 15:05:54 -0500253 INIT_LIST_HEAD(&fl->fl_list);
Miklos Szerediee19cc42011-07-07 13:06:09 +0200254 INIT_LIST_HEAD(&fl->fl_block);
255 init_waitqueue_head(&fl->fl_wait);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200256}
257
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200259struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200261 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200262
263 if (fl)
Miklos Szerediee19cc42011-07-07 13:06:09 +0200264 locks_init_lock_heads(fl);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200265
266 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200268EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500270void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500271{
272 if (fl->fl_ops) {
273 if (fl->fl_ops->fl_release_private)
274 fl->fl_ops->fl_release_private(fl);
275 fl->fl_ops = NULL;
276 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500277
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400278 if (fl->fl_lmops) {
279 if (fl->fl_lmops->lm_put_owner)
280 fl->fl_lmops->lm_put_owner(fl);
281 fl->fl_lmops = NULL;
282 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500283}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500284EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500285
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286/* Free a lock which is not in use. */
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400287void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288{
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800289 BUG_ON(waitqueue_active(&fl->fl_wait));
Jeff Layton6dee60f2015-01-16 15:05:54 -0500290 BUG_ON(!list_empty(&fl->fl_list));
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800291 BUG_ON(!list_empty(&fl->fl_block));
Jeff Layton139ca042013-06-21 08:58:17 -0400292 BUG_ON(!hlist_unhashed(&fl->fl_link));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
Trond Myklebust47831f32006-03-20 13:44:05 -0500294 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 kmem_cache_free(filelock_cache, fl);
296}
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400297EXPORT_SYMBOL(locks_free_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
Jeff Laytoned9814d2014-08-11 14:20:31 -0400299static void
300locks_dispose_list(struct list_head *dispose)
301{
302 struct file_lock *fl;
303
304 while (!list_empty(dispose)) {
Jeff Layton6dee60f2015-01-16 15:05:54 -0500305 fl = list_first_entry(dispose, struct file_lock, fl_list);
306 list_del_init(&fl->fl_list);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400307 locks_free_lock(fl);
308 }
309}
310
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311void locks_init_lock(struct file_lock *fl)
312{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200313 memset(fl, 0, sizeof(struct file_lock));
314 locks_init_lock_heads(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315}
316
317EXPORT_SYMBOL(locks_init_lock);
318
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319/*
320 * Initialize a new lock from an existing file_lock structure.
321 */
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400322void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323{
324 new->fl_owner = fl->fl_owner;
325 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500326 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 new->fl_flags = fl->fl_flags;
328 new->fl_type = fl->fl_type;
329 new->fl_start = fl->fl_start;
330 new->fl_end = fl->fl_end;
Kinglong Meef3282962014-08-22 10:18:43 -0400331 new->fl_lmops = fl->fl_lmops;
Trond Myklebust09969052006-03-20 13:44:38 -0500332 new->fl_ops = NULL;
Kinglong Meef3282962014-08-22 10:18:43 -0400333
334 if (fl->fl_lmops) {
335 if (fl->fl_lmops->lm_get_owner)
336 fl->fl_lmops->lm_get_owner(new, fl);
337 }
Trond Myklebust09969052006-03-20 13:44:38 -0500338}
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400339EXPORT_SYMBOL(locks_copy_conflock);
Trond Myklebust09969052006-03-20 13:44:38 -0500340
341void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
342{
Jeff Layton566709b2014-08-11 14:09:35 -0400343 /* "new" must be a freshly-initialized lock */
344 WARN_ON_ONCE(new->fl_ops);
Trond Myklebust09969052006-03-20 13:44:38 -0500345
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400346 locks_copy_conflock(new, fl);
Kinglong Meef3282962014-08-22 10:18:43 -0400347
Trond Myklebust09969052006-03-20 13:44:38 -0500348 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 new->fl_ops = fl->fl_ops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500350
Kinglong Meef3282962014-08-22 10:18:43 -0400351 if (fl->fl_ops) {
352 if (fl->fl_ops->fl_copy_lock)
353 fl->fl_ops->fl_copy_lock(new, fl);
354 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355}
356
357EXPORT_SYMBOL(locks_copy_lock);
358
359static inline int flock_translate_cmd(int cmd) {
360 if (cmd & LOCK_MAND)
361 return cmd & (LOCK_MAND | LOCK_RW);
362 switch (cmd) {
363 case LOCK_SH:
364 return F_RDLCK;
365 case LOCK_EX:
366 return F_WRLCK;
367 case LOCK_UN:
368 return F_UNLCK;
369 }
370 return -EINVAL;
371}
372
373/* Fill in a file_lock structure with an appropriate FLOCK lock. */
Jeff Layton6e129d002014-09-04 10:25:06 -0400374static struct file_lock *
375flock_make_lock(struct file *filp, unsigned int cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376{
377 struct file_lock *fl;
378 int type = flock_translate_cmd(cmd);
Jeff Layton6e129d002014-09-04 10:25:06 -0400379
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 if (type < 0)
Jeff Layton6e129d002014-09-04 10:25:06 -0400381 return ERR_PTR(type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
383 fl = locks_alloc_lock();
384 if (fl == NULL)
Jeff Layton6e129d002014-09-04 10:25:06 -0400385 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
387 fl->fl_file = filp;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +0200388 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 fl->fl_pid = current->tgid;
390 fl->fl_flags = FL_FLOCK;
391 fl->fl_type = type;
392 fl->fl_end = OFFSET_MAX;
393
Jeff Layton6e129d002014-09-04 10:25:06 -0400394 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395}
396
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400397static int assign_type(struct file_lock *fl, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398{
399 switch (type) {
400 case F_RDLCK:
401 case F_WRLCK:
402 case F_UNLCK:
403 fl->fl_type = type;
404 break;
405 default:
406 return -EINVAL;
407 }
408 return 0;
409}
410
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500411static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
412 struct flock64 *l)
413{
414 switch (l->l_whence) {
415 case SEEK_SET:
416 fl->fl_start = 0;
417 break;
418 case SEEK_CUR:
419 fl->fl_start = filp->f_pos;
420 break;
421 case SEEK_END:
422 fl->fl_start = i_size_read(file_inode(filp));
423 break;
424 default:
425 return -EINVAL;
426 }
427 if (l->l_start > OFFSET_MAX - fl->fl_start)
428 return -EOVERFLOW;
429 fl->fl_start += l->l_start;
430 if (fl->fl_start < 0)
431 return -EINVAL;
432
433 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
434 POSIX-2001 defines it. */
435 if (l->l_len > 0) {
436 if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
437 return -EOVERFLOW;
438 fl->fl_end = fl->fl_start + l->l_len - 1;
439
440 } else if (l->l_len < 0) {
441 if (fl->fl_start + l->l_len < 0)
442 return -EINVAL;
443 fl->fl_end = fl->fl_start - 1;
444 fl->fl_start += l->l_len;
445 } else
446 fl->fl_end = OFFSET_MAX;
447
448 fl->fl_owner = current->files;
449 fl->fl_pid = current->tgid;
450 fl->fl_file = filp;
451 fl->fl_flags = FL_POSIX;
452 fl->fl_ops = NULL;
453 fl->fl_lmops = NULL;
454
455 return assign_type(fl, l->l_type);
456}
457
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
459 * style lock.
460 */
461static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
462 struct flock *l)
463{
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500464 struct flock64 ll = {
465 .l_type = l->l_type,
466 .l_whence = l->l_whence,
467 .l_start = l->l_start,
468 .l_len = l->l_len,
469 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500471 return flock64_to_posix_lock(filp, fl, &ll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472}
473
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474/* default lease lock manager operations */
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400475static bool
476lease_break_callback(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477{
478 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400479 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480}
481
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400482static void
483lease_setup(struct file_lock *fl, void **priv)
484{
485 struct file *filp = fl->fl_file;
486 struct fasync_struct *fa = *priv;
487
488 /*
489 * fasync_insert_entry() returns the old entry if any. If there was no
490 * old entry, then it used "priv" and inserted it into the fasync list.
491 * Clear the pointer to indicate that it shouldn't be freed.
492 */
493 if (!fasync_insert_entry(fa->fa_fd, filp, &fl->fl_fasync, fa))
494 *priv = NULL;
495
496 __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
497}
498
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700499static const struct lock_manager_operations lease_manager_ops = {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400500 .lm_break = lease_break_callback,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400501 .lm_change = lease_modify,
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400502 .lm_setup = lease_setup,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503};
504
505/*
506 * Initialize a lease, use the default lock manager operations
507 */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400508static int lease_init(struct file *filp, long type, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 {
Trond Myklebust75dff552006-05-07 23:02:42 -0400510 if (assign_type(fl, type) != 0)
511 return -EINVAL;
512
Jeff Layton7ca76312014-09-01 19:04:48 -0400513 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 fl->fl_pid = current->tgid;
515
516 fl->fl_file = filp;
517 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 fl->fl_start = 0;
519 fl->fl_end = OFFSET_MAX;
520 fl->fl_ops = NULL;
521 fl->fl_lmops = &lease_manager_ops;
522 return 0;
523}
524
525/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400526static struct file_lock *lease_alloc(struct file *filp, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527{
528 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400529 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
531 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500532 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533
534 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400535 if (error) {
536 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500537 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400538 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500539 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540}
541
542/* Check if two locks overlap each other.
543 */
544static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
545{
546 return ((fl1->fl_end >= fl2->fl_start) &&
547 (fl2->fl_end >= fl1->fl_start));
548}
549
550/*
551 * Check whether two locks have the same owner.
552 */
Matt Mackall33443c42006-01-08 01:05:22 -0800553static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554{
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400555 if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 return fl2->fl_lmops == fl1->fl_lmops &&
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400557 fl1->fl_lmops->lm_compare_owner(fl1, fl2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 return fl1->fl_owner == fl2->fl_owner;
559}
560
Jeff Layton6109c852015-01-16 15:05:57 -0500561/* Must be called with the flc_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500562static void locks_insert_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400563{
Jeff Layton7012b022013-06-21 08:58:22 -0400564 lg_local_lock(&file_lock_lglock);
565 fl->fl_link_cpu = smp_processor_id();
566 hlist_add_head(&fl->fl_link, this_cpu_ptr(&file_lock_list));
567 lg_local_unlock(&file_lock_lglock);
Jeff Layton88974692013-06-21 08:58:14 -0400568}
569
Jeff Layton6109c852015-01-16 15:05:57 -0500570/* Must be called with the flc_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500571static void locks_delete_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400572{
Jeff Layton7012b022013-06-21 08:58:22 -0400573 /*
574 * Avoid taking lock if already unhashed. This is safe since this check
Jeff Layton6109c852015-01-16 15:05:57 -0500575 * is done while holding the flc_lock, and new insertions into the list
Jeff Layton7012b022013-06-21 08:58:22 -0400576 * also require that it be held.
577 */
578 if (hlist_unhashed(&fl->fl_link))
579 return;
580 lg_local_lock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton139ca042013-06-21 08:58:17 -0400581 hlist_del_init(&fl->fl_link);
Jeff Layton7012b022013-06-21 08:58:22 -0400582 lg_local_unlock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton88974692013-06-21 08:58:14 -0400583}
584
Jeff Layton3999e492013-06-21 08:58:19 -0400585static unsigned long
586posix_owner_key(struct file_lock *fl)
587{
588 if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
589 return fl->fl_lmops->lm_owner_key(fl);
590 return (unsigned long)fl->fl_owner;
591}
592
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500593static void locks_insert_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400594{
Daniel Wagner663d5af2015-04-03 09:04:03 -0400595 lockdep_assert_held(&blocked_lock_lock);
596
Jeff Layton3999e492013-06-21 08:58:19 -0400597 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
Jeff Layton88974692013-06-21 08:58:14 -0400598}
599
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500600static void locks_delete_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400601{
Daniel Wagner663d5af2015-04-03 09:04:03 -0400602 lockdep_assert_held(&blocked_lock_lock);
603
Jeff Layton48f74182013-06-21 08:58:18 -0400604 hash_del(&waiter->fl_link);
Jeff Layton88974692013-06-21 08:58:14 -0400605}
606
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607/* Remove waiter from blocker's block list.
608 * When blocker ends up pointing to itself then the list is empty.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400609 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400610 * Must be called with blocked_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 */
Matt Mackall33443c42006-01-08 01:05:22 -0800612static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613{
Jeff Layton88974692013-06-21 08:58:14 -0400614 locks_delete_global_blocked(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 list_del_init(&waiter->fl_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 waiter->fl_next = NULL;
617}
618
Jeff Layton1a9e64a2013-06-21 08:58:10 -0400619static void locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400621 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 __locks_delete_block(waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400623 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624}
625
626/* Insert waiter into blocker's block list.
627 * We use a circular list so that processes can be easily woken up in
628 * the order they blocked. The documentation doesn't require this but
629 * it seems like the reasonable thing to do.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400630 *
Jeff Layton6109c852015-01-16 15:05:57 -0500631 * Must be called with both the flc_lock and blocked_lock_lock held. The
632 * fl_block list itself is protected by the blocked_lock_lock, but by ensuring
633 * that the flc_lock is also held on insertions we can avoid taking the
634 * blocked_lock_lock in some cases when we see that the fl_block list is empty.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400636static void __locks_insert_block(struct file_lock *blocker,
637 struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638{
J. Bruce Fields6dc0fe82006-03-26 01:37:24 -0800639 BUG_ON(!list_empty(&waiter->fl_block));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 waiter->fl_next = blocker;
Jeff Layton88974692013-06-21 08:58:14 -0400641 list_add_tail(&waiter->fl_block, &blocker->fl_block);
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400642 if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400643 locks_insert_global_blocked(waiter);
644}
645
Jeff Layton6109c852015-01-16 15:05:57 -0500646/* Must be called with flc_lock held. */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400647static void locks_insert_block(struct file_lock *blocker,
648 struct file_lock *waiter)
649{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400650 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400651 __locks_insert_block(blocker, waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400652 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653}
654
Jeff Layton1cb36012013-06-21 08:58:12 -0400655/*
656 * Wake up processes blocked waiting for blocker.
657 *
Jeff Layton6109c852015-01-16 15:05:57 -0500658 * Must be called with the inode->flc_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 */
660static void locks_wake_up_blocks(struct file_lock *blocker)
661{
Jeff Layton4e8c7652013-06-21 08:58:16 -0400662 /*
663 * Avoid taking global lock if list is empty. This is safe since new
Jeff Layton6109c852015-01-16 15:05:57 -0500664 * blocked requests are only added to the list under the flc_lock, and
665 * the flc_lock is always held here. Note that removal from the fl_block
666 * list does not require the flc_lock, so we must recheck list_empty()
Jeff Layton7b2296a2013-06-21 08:58:20 -0400667 * after acquiring the blocked_lock_lock.
Jeff Layton4e8c7652013-06-21 08:58:16 -0400668 */
669 if (list_empty(&blocker->fl_block))
670 return;
671
Jeff Layton7b2296a2013-06-21 08:58:20 -0400672 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 while (!list_empty(&blocker->fl_block)) {
Pavel Emelyanovf0c1cd02007-09-19 16:44:07 +0400674 struct file_lock *waiter;
675
676 waiter = list_first_entry(&blocker->fl_block,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 struct file_lock, fl_block);
678 __locks_delete_block(waiter);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400679 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
680 waiter->fl_lmops->lm_notify(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 else
682 wake_up(&waiter->fl_wait);
683 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400684 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685}
686
Jeff Layton5263e312015-01-16 15:05:55 -0500687static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500688locks_insert_lock_ctx(struct file_lock *fl, struct list_head *before)
Jeff Layton5263e312015-01-16 15:05:55 -0500689{
690 fl->fl_nspid = get_pid(task_tgid(current));
691 list_add_tail(&fl->fl_list, before);
692 locks_insert_global_locks(fl);
693}
694
Jeff Layton8634b512015-01-16 15:05:55 -0500695static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500696locks_unlink_lock_ctx(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697{
Jeff Layton88974692013-06-21 08:58:14 -0400698 locks_delete_global_locks(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500699 list_del_init(&fl->fl_list);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000700 if (fl->fl_nspid) {
701 put_pid(fl->fl_nspid);
702 fl->fl_nspid = NULL;
703 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 locks_wake_up_blocks(fl);
Jeff Layton24cbe782014-02-03 12:13:06 -0500705}
706
Jeff Layton5263e312015-01-16 15:05:55 -0500707static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500708locks_delete_lock_ctx(struct file_lock *fl, struct list_head *dispose)
Jeff Layton5263e312015-01-16 15:05:55 -0500709{
Jeff Laytone084c1b2015-02-16 14:32:03 -0500710 locks_unlink_lock_ctx(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500711 if (dispose)
712 list_add(&fl->fl_list, dispose);
713 else
714 locks_free_lock(fl);
Jeff Layton5263e312015-01-16 15:05:55 -0500715}
716
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
718 * checks for shared/exclusive status of overlapping locks.
719 */
720static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
721{
722 if (sys_fl->fl_type == F_WRLCK)
723 return 1;
724 if (caller_fl->fl_type == F_WRLCK)
725 return 1;
726 return 0;
727}
728
729/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
730 * checking before calling the locks_conflict().
731 */
732static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
733{
734 /* POSIX locks owned by the same process do not conflict with
735 * each other.
736 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400737 if (posix_same_owner(caller_fl, sys_fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 return (0);
739
740 /* Check whether they overlap */
741 if (!locks_overlap(caller_fl, sys_fl))
742 return 0;
743
744 return (locks_conflict(caller_fl, sys_fl));
745}
746
747/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
748 * checking before calling the locks_conflict().
749 */
750static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
751{
752 /* FLOCK locks referring to the same filp do not conflict with
753 * each other.
754 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400755 if (caller_fl->fl_file == sys_fl->fl_file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 return (0);
757 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
758 return 0;
759
760 return (locks_conflict(caller_fl, sys_fl));
761}
762
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400763void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500764posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765{
766 struct file_lock *cfl;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500767 struct file_lock_context *ctx;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400768 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500770 ctx = inode->i_flctx;
771 if (!ctx || list_empty_careful(&ctx->flc_posix)) {
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400772 fl->fl_type = F_UNLCK;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500773 return;
774 }
775
Jeff Layton6109c852015-01-16 15:05:57 -0500776 spin_lock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500777 list_for_each_entry(cfl, &ctx->flc_posix, fl_list) {
778 if (posix_locks_conflict(fl, cfl)) {
779 locks_copy_conflock(fl, cfl);
780 if (cfl->fl_nspid)
781 fl->fl_pid = pid_vnr(cfl->fl_nspid);
782 goto out;
783 }
784 }
785 fl->fl_type = F_UNLCK;
786out:
Jeff Layton6109c852015-01-16 15:05:57 -0500787 spin_unlock(&ctx->flc_lock);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400788 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790EXPORT_SYMBOL(posix_test_lock);
791
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400792/*
793 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400795 * We attempt to detect deadlocks that are due purely to posix file
796 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400798 * We assume that a task can be waiting for at most one lock at a time.
799 * So for any acquired lock, the process holding that lock may be
800 * waiting on at most one other lock. That lock in turns may be held by
801 * someone waiting for at most one other lock. Given a requested lock
802 * caller_fl which is about to wait for a conflicting lock block_fl, we
803 * follow this chain of waiters to ensure we are not about to create a
804 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400805 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400806 * Since we do this before we ever put a process to sleep on a lock, we
807 * are ensured that there is never a cycle; that is what guarantees that
808 * the while() loop in posix_locks_deadlock() eventually completes.
809 *
810 * Note: the above assumption may not be true when handling lock
811 * requests from a broken NFS client. It may also fail in the presence
812 * of tasks (such as posix threads) sharing the same open file table.
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400813 * To handle those cases, we just bail out after a few iterations.
Jeff Layton57b65322014-02-03 12:13:09 -0500814 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400815 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
Jeff Layton57b65322014-02-03 12:13:09 -0500816 * Because the owner is not even nominally tied to a thread of
817 * execution, the deadlock detection below can't reasonably work well. Just
818 * skip it for those.
819 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400820 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
Jeff Layton57b65322014-02-03 12:13:09 -0500821 * locks that just checks for the case where two tasks are attempting to
822 * upgrade from read to write locks on the same inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400824
825#define MAX_DEADLK_ITERATIONS 10
826
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400827/* Find a lock that the owner of the given block_fl is blocking on. */
828static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
829{
830 struct file_lock *fl;
831
Jeff Layton3999e492013-06-21 08:58:19 -0400832 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400833 if (posix_same_owner(fl, block_fl))
834 return fl->fl_next;
835 }
836 return NULL;
837}
838
Jeff Layton7b2296a2013-06-21 08:58:20 -0400839/* Must be called with the blocked_lock_lock held! */
Adrian Bunkb0904e12006-06-23 02:05:13 -0700840static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 struct file_lock *block_fl)
842{
J. Bruce Fields97855b42007-10-30 11:20:02 -0400843 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
Daniel Wagner663d5af2015-04-03 09:04:03 -0400845 lockdep_assert_held(&blocked_lock_lock);
846
Jeff Layton57b65322014-02-03 12:13:09 -0500847 /*
848 * This deadlock detector can't reasonably detect deadlocks with
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400849 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
Jeff Layton57b65322014-02-03 12:13:09 -0500850 */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400851 if (IS_OFDLCK(caller_fl))
Jeff Layton57b65322014-02-03 12:13:09 -0500852 return 0;
853
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400854 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
855 if (i++ > MAX_DEADLK_ITERATIONS)
856 return 0;
857 if (posix_same_owner(caller_fl, block_fl))
858 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 }
860 return 0;
861}
862
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -0400864 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -0400865 *
866 * Note that if called with an FL_EXISTS argument, the caller may determine
867 * whether or not a lock was successfully freed by testing the return
868 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 */
Trond Myklebust993dfa82006-03-31 02:30:55 -0800870static int flock_lock_file(struct file *filp, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871{
Trond Myklebust993dfa82006-03-31 02:30:55 -0800872 struct file_lock *new_fl = NULL;
Jeff Layton5263e312015-01-16 15:05:55 -0500873 struct file_lock *fl;
874 struct file_lock_context *ctx;
875 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 int error = 0;
Jeff Layton5263e312015-01-16 15:05:55 -0500877 bool found = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -0400878 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879
Jeff Layton5c1c6692015-04-03 09:04:03 -0400880 ctx = locks_get_lock_context(inode, request->fl_type);
881 if (!ctx) {
882 if (request->fl_type != F_UNLCK)
883 return -ENOMEM;
884 return (request->fl_flags & FL_EXISTS) ? -ENOENT : 0;
885 }
Jeff Layton5263e312015-01-16 15:05:55 -0500886
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200887 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
888 new_fl = locks_alloc_lock();
889 if (!new_fl)
890 return -ENOMEM;
891 }
892
Jeff Layton6109c852015-01-16 15:05:57 -0500893 spin_lock(&ctx->flc_lock);
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400894 if (request->fl_flags & FL_ACCESS)
895 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +0400896
Jeff Layton5263e312015-01-16 15:05:55 -0500897 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 if (filp != fl->fl_file)
899 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800900 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 goto out;
Jeff Layton5263e312015-01-16 15:05:55 -0500902 found = true;
Jeff Laytone084c1b2015-02-16 14:32:03 -0500903 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 break;
905 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906
Trond Myklebustf475ae92006-06-29 16:38:32 -0400907 if (request->fl_type == F_UNLCK) {
908 if ((request->fl_flags & FL_EXISTS) && !found)
909 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800910 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400911 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400913find_conflict:
Jeff Layton5263e312015-01-16 15:05:55 -0500914 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Trond Myklebust993dfa82006-03-31 02:30:55 -0800915 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 continue;
917 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700918 if (!(request->fl_flags & FL_SLEEP))
919 goto out;
920 error = FILE_LOCK_DEFERRED;
921 locks_insert_block(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 goto out;
923 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400924 if (request->fl_flags & FL_ACCESS)
925 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800926 locks_copy_lock(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -0500927 locks_insert_lock_ctx(new_fl, &ctx->flc_flock);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800928 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +0400929 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930
931out:
Jeff Layton6109c852015-01-16 15:05:57 -0500932 spin_unlock(&ctx->flc_lock);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800933 if (new_fl)
934 locks_free_lock(new_fl);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400935 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 return error;
937}
938
Marc Eshel150b3932007-01-18 16:15:35 -0500939static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500941 struct file_lock *fl, *tmp;
Miklos Szeredi39005d02006-06-23 02:05:10 -0700942 struct file_lock *new_fl = NULL;
943 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 struct file_lock *left = NULL;
945 struct file_lock *right = NULL;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500946 struct file_lock_context *ctx;
Jeff Laytonb9746ef2013-06-21 08:58:13 -0400947 int error;
948 bool added = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -0400949 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
Jeff Layton5c1c6692015-04-03 09:04:03 -0400951 ctx = locks_get_lock_context(inode, request->fl_type);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500952 if (!ctx)
Jeff Layton5c1c6692015-04-03 09:04:03 -0400953 return (request->fl_type == F_UNLCK) ? 0 : -ENOMEM;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500954
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 /*
956 * We may need two file_lock structures for this operation,
957 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -0700958 *
959 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 */
Miklos Szeredi39005d02006-06-23 02:05:10 -0700961 if (!(request->fl_flags & FL_ACCESS) &&
962 (request->fl_type != F_UNLCK ||
963 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
964 new_fl = locks_alloc_lock();
965 new_fl2 = locks_alloc_lock();
966 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967
Jeff Layton6109c852015-01-16 15:05:57 -0500968 spin_lock(&ctx->flc_lock);
Jeff Layton1cb36012013-06-21 08:58:12 -0400969 /*
970 * New lock request. Walk all POSIX locks and look for conflicts. If
971 * there are any, either return error or put the request on the
Jeff Layton48f74182013-06-21 08:58:18 -0400972 * blocker's list of waiters and the global blocked_hash.
Jeff Layton1cb36012013-06-21 08:58:12 -0400973 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 if (request->fl_type != F_UNLCK) {
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500975 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 if (!posix_locks_conflict(request, fl))
977 continue;
Andy Adamson5842add2006-03-26 01:37:26 -0800978 if (conflock)
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400979 locks_copy_conflock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 error = -EAGAIN;
981 if (!(request->fl_flags & FL_SLEEP))
982 goto out;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400983 /*
984 * Deadlock detection and insertion into the blocked
985 * locks list must be done while holding the same lock!
986 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 error = -EDEADLK;
Jeff Layton7b2296a2013-06-21 08:58:20 -0400988 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400989 if (likely(!posix_locks_deadlock(request, fl))) {
990 error = FILE_LOCK_DEFERRED;
991 __locks_insert_block(fl, request);
992 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400993 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 goto out;
995 }
996 }
997
998 /* If we're just looking for a conflict, we're done. */
999 error = 0;
1000 if (request->fl_flags & FL_ACCESS)
1001 goto out;
1002
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001003 /* Find the first old lock with the same owner as the new lock */
1004 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1005 if (posix_same_owner(request, fl))
1006 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 }
1008
Jeff Layton1cb36012013-06-21 08:58:12 -04001009 /* Process locks with this owner. */
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001010 list_for_each_entry_safe_from(fl, tmp, &ctx->flc_posix, fl_list) {
1011 if (!posix_same_owner(request, fl))
1012 break;
1013
1014 /* Detect adjacent or overlapping regions (if same lock type) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -07001016 /* In all comparisons of start vs end, use
1017 * "start - 1" rather than "end + 1". If end
1018 * is OFFSET_MAX, end + 1 will become negative.
1019 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 if (fl->fl_end < request->fl_start - 1)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001021 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 /* If the next lock in the list has entirely bigger
1023 * addresses than the new one, insert the lock here.
1024 */
Olaf Kirch449231d2005-08-25 16:25:35 -07001025 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 break;
1027
1028 /* If we come here, the new and old lock are of the
1029 * same type and adjacent or overlapping. Make one
1030 * lock yielding from the lower start address of both
1031 * locks to the higher end address.
1032 */
1033 if (fl->fl_start > request->fl_start)
1034 fl->fl_start = request->fl_start;
1035 else
1036 request->fl_start = fl->fl_start;
1037 if (fl->fl_end < request->fl_end)
1038 fl->fl_end = request->fl_end;
1039 else
1040 request->fl_end = fl->fl_end;
1041 if (added) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001042 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 continue;
1044 }
1045 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001046 added = true;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001047 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 /* Processing for different lock types is a bit
1049 * more complex.
1050 */
1051 if (fl->fl_end < request->fl_start)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001052 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 if (fl->fl_start > request->fl_end)
1054 break;
1055 if (request->fl_type == F_UNLCK)
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001056 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 if (fl->fl_start < request->fl_start)
1058 left = fl;
1059 /* If the next lock in the list has a higher end
1060 * address than the new one, insert the new one here.
1061 */
1062 if (fl->fl_end > request->fl_end) {
1063 right = fl;
1064 break;
1065 }
1066 if (fl->fl_start >= request->fl_start) {
1067 /* The new lock completely replaces an old
1068 * one (This may happen several times).
1069 */
1070 if (added) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001071 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 continue;
1073 }
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001074 /*
1075 * Replace the old lock with new_fl, and
1076 * remove the old one. It's safe to do the
1077 * insert here since we know that we won't be
1078 * using new_fl later, and that the lock is
1079 * just replacing an existing lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 */
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001081 error = -ENOLCK;
1082 if (!new_fl)
1083 goto out;
1084 locks_copy_lock(new_fl, request);
1085 request = new_fl;
1086 new_fl = NULL;
Jeff Laytone084c1b2015-02-16 14:32:03 -05001087 locks_insert_lock_ctx(request, &fl->fl_list);
1088 locks_delete_lock_ctx(fl, &dispose);
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001089 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 }
1091 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 }
1093
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001094 /*
Jeff Layton1cb36012013-06-21 08:58:12 -04001095 * The above code only modifies existing locks in case of merging or
1096 * replacing. If new lock(s) need to be inserted all modifications are
1097 * done below this, so it's safe yet to bail out.
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001098 */
1099 error = -ENOLCK; /* "no luck" */
1100 if (right && left == right && !new_fl2)
1101 goto out;
1102
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 error = 0;
1104 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -04001105 if (request->fl_type == F_UNLCK) {
1106 if (request->fl_flags & FL_EXISTS)
1107 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001109 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001110
1111 if (!new_fl) {
1112 error = -ENOLCK;
1113 goto out;
1114 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 locks_copy_lock(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001116 locks_insert_lock_ctx(new_fl, &fl->fl_list);
Jeff Layton2e2f756f2015-02-17 17:08:23 -05001117 fl = new_fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 new_fl = NULL;
1119 }
1120 if (right) {
1121 if (left == right) {
1122 /* The new lock breaks the old one in two pieces,
1123 * so we have to use the second new lock.
1124 */
1125 left = new_fl2;
1126 new_fl2 = NULL;
1127 locks_copy_lock(left, right);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001128 locks_insert_lock_ctx(left, &fl->fl_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 }
1130 right->fl_start = request->fl_end + 1;
1131 locks_wake_up_blocks(right);
1132 }
1133 if (left) {
1134 left->fl_end = request->fl_start - 1;
1135 locks_wake_up_blocks(left);
1136 }
1137 out:
Jeff Layton6109c852015-01-16 15:05:57 -05001138 spin_unlock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 /*
1140 * Free any unused locks.
1141 */
1142 if (new_fl)
1143 locks_free_lock(new_fl);
1144 if (new_fl2)
1145 locks_free_lock(new_fl2);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001146 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 return error;
1148}
1149
1150/**
1151 * posix_lock_file - Apply a POSIX-style lock to a file
1152 * @filp: The file to apply the lock to
1153 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001154 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 *
1156 * Add a POSIX style lock to a file.
1157 * We merge adjacent & overlapping locks whenever possible.
1158 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001159 *
1160 * Note that if called with an FL_EXISTS argument, the caller may determine
1161 * whether or not a lock was successfully freed by testing the return
1162 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 */
Marc Eshel150b3932007-01-18 16:15:35 -05001164int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001165 struct file_lock *conflock)
1166{
Al Viro496ad9a2013-01-23 17:07:38 -05001167 return __posix_lock_file(file_inode(filp), fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001168}
Marc Eshel150b3932007-01-18 16:15:35 -05001169EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170
1171/**
1172 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1173 * @filp: The file to apply the lock to
1174 * @fl: The lock to be applied
1175 *
1176 * Add a POSIX style lock to a file.
1177 * We merge adjacent & overlapping locks whenever possible.
1178 * POSIX locks are sorted by owner task, then by starting address
1179 */
1180int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1181{
1182 int error;
1183 might_sleep ();
1184 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001185 error = posix_lock_file(filp, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001186 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 break;
1188 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1189 if (!error)
1190 continue;
1191
1192 locks_delete_block(fl);
1193 break;
1194 }
1195 return error;
1196}
1197EXPORT_SYMBOL(posix_lock_file_wait);
1198
1199/**
1200 * locks_mandatory_locked - Check for an active lock
Jeff Laytond7a06982014-03-10 09:54:15 -04001201 * @file: the file to check
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 *
1203 * Searches the inode's list of locks to find any POSIX locks which conflict.
1204 * This function is called from locks_verify_locked() only.
1205 */
Jeff Laytond7a06982014-03-10 09:54:15 -04001206int locks_mandatory_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001208 int ret;
Jeff Laytond7a06982014-03-10 09:54:15 -04001209 struct inode *inode = file_inode(file);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001210 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 struct file_lock *fl;
1212
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001213 ctx = inode->i_flctx;
1214 if (!ctx || list_empty_careful(&ctx->flc_posix))
1215 return 0;
1216
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217 /*
1218 * Search the lock list for this inode for any POSIX locks.
1219 */
Jeff Layton6109c852015-01-16 15:05:57 -05001220 spin_lock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001221 ret = 0;
1222 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001223 if (fl->fl_owner != current->files &&
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001224 fl->fl_owner != file) {
1225 ret = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 break;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001227 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 }
Jeff Layton6109c852015-01-16 15:05:57 -05001229 spin_unlock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001230 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231}
1232
1233/**
1234 * locks_mandatory_area - Check for a conflicting lock
1235 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1236 * for shared
1237 * @inode: the file to check
1238 * @filp: how the file was opened (if it was)
1239 * @offset: start of area to check
1240 * @count: length of area to check
1241 *
1242 * Searches the inode's list of locks to find any POSIX locks which conflict.
1243 * This function is called from rw_verify_area() and
1244 * locks_verify_truncate().
1245 */
1246int locks_mandatory_area(int read_write, struct inode *inode,
1247 struct file *filp, loff_t offset,
1248 size_t count)
1249{
1250 struct file_lock fl;
1251 int error;
Jeff Layton29723ad2014-03-10 09:54:19 -04001252 bool sleep = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253
1254 locks_init_lock(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 fl.fl_pid = current->tgid;
1256 fl.fl_file = filp;
1257 fl.fl_flags = FL_POSIX | FL_ACCESS;
1258 if (filp && !(filp->f_flags & O_NONBLOCK))
Jeff Layton29723ad2014-03-10 09:54:19 -04001259 sleep = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1261 fl.fl_start = offset;
1262 fl.fl_end = offset + count - 1;
1263
1264 for (;;) {
Jeff Layton29723ad2014-03-10 09:54:19 -04001265 if (filp) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001266 fl.fl_owner = filp;
Jeff Layton29723ad2014-03-10 09:54:19 -04001267 fl.fl_flags &= ~FL_SLEEP;
1268 error = __posix_lock_file(inode, &fl, NULL);
1269 if (!error)
1270 break;
1271 }
1272
1273 if (sleep)
1274 fl.fl_flags |= FL_SLEEP;
1275 fl.fl_owner = current->files;
Marc Eshel150b3932007-01-18 16:15:35 -05001276 error = __posix_lock_file(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001277 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 break;
1279 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1280 if (!error) {
1281 /*
1282 * If we've been sleeping someone might have
1283 * changed the permissions behind our back.
1284 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001285 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 continue;
1287 }
1288
1289 locks_delete_block(&fl);
1290 break;
1291 }
1292
1293 return error;
1294}
1295
1296EXPORT_SYMBOL(locks_mandatory_area);
1297
J. Bruce Fields778fc542011-07-26 18:25:49 -04001298static void lease_clear_pending(struct file_lock *fl, int arg)
1299{
1300 switch (arg) {
1301 case F_UNLCK:
1302 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1303 /* fall through: */
1304 case F_RDLCK:
1305 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1306 }
1307}
1308
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309/* We already had a lease on this file; just change its type */
Jeff Layton7448cc32015-01-16 15:05:57 -05001310int lease_modify(struct file_lock *fl, int arg, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 int error = assign_type(fl, arg);
1313
1314 if (error)
1315 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001316 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001318 if (arg == F_UNLCK) {
1319 struct file *filp = fl->fl_file;
1320
1321 f_delown(filp);
1322 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001323 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1324 if (fl->fl_fasync != NULL) {
1325 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1326 fl->fl_fasync = NULL;
1327 }
Jeff Laytone084c1b2015-02-16 14:32:03 -05001328 locks_delete_lock_ctx(fl, dispose);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001329 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 return 0;
1331}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332EXPORT_SYMBOL(lease_modify);
1333
J. Bruce Fields778fc542011-07-26 18:25:49 -04001334static bool past_time(unsigned long then)
1335{
1336 if (!then)
1337 /* 0 is a special value meaning "this never expires": */
1338 return false;
1339 return time_after(jiffies, then);
1340}
1341
Jeff Laytonc45198e2014-09-01 07:12:07 -04001342static void time_out_leases(struct inode *inode, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343{
Jeff Layton8634b512015-01-16 15:05:55 -05001344 struct file_lock_context *ctx = inode->i_flctx;
1345 struct file_lock *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346
Jeff Layton6109c852015-01-16 15:05:57 -05001347 lockdep_assert_held(&ctx->flc_lock);
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001348
Jeff Layton8634b512015-01-16 15:05:55 -05001349 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001350 trace_time_out_leases(inode, fl);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001351 if (past_time(fl->fl_downgrade_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001352 lease_modify(fl, F_RDLCK, dispose);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001353 if (past_time(fl->fl_break_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001354 lease_modify(fl, F_UNLCK, dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 }
1356}
1357
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001358static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1359{
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001360 if ((breaker->fl_flags & FL_LAYOUT) != (lease->fl_flags & FL_LAYOUT))
1361 return false;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001362 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1363 return false;
1364 return locks_conflict(breaker, lease);
1365}
1366
Jeff Layton03d12dd2014-09-01 14:53:41 -04001367static bool
1368any_leases_conflict(struct inode *inode, struct file_lock *breaker)
1369{
Jeff Layton8634b512015-01-16 15:05:55 -05001370 struct file_lock_context *ctx = inode->i_flctx;
Jeff Layton03d12dd2014-09-01 14:53:41 -04001371 struct file_lock *fl;
1372
Jeff Layton6109c852015-01-16 15:05:57 -05001373 lockdep_assert_held(&ctx->flc_lock);
Jeff Layton03d12dd2014-09-01 14:53:41 -04001374
Jeff Layton8634b512015-01-16 15:05:55 -05001375 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Jeff Layton03d12dd2014-09-01 14:53:41 -04001376 if (leases_conflict(fl, breaker))
1377 return true;
1378 }
1379 return false;
1380}
1381
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382/**
1383 * __break_lease - revoke all outstanding leases on file
1384 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001385 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1386 * break all leases
1387 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1388 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 *
david m. richter87250dd2007-05-09 16:10:27 -04001390 * break_lease (inlined for speed) has checked there already is at least
1391 * some kind of lock (maybe a lease) on this file. Leases are broken on
1392 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 * specified %O_NONBLOCK to your open().
1394 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001395int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001397 int error = 0;
Jeff Layton8634b512015-01-16 15:05:55 -05001398 struct file_lock_context *ctx = inode->i_flctx;
Yan, Zhenga9011252015-03-27 10:34:20 +08001399 struct file_lock *new_fl, *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 unsigned long break_time;
Al Viro8737c932009-12-24 06:47:55 -05001401 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001402 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403
Al Viro8737c932009-12-24 06:47:55 -05001404 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001405 if (IS_ERR(new_fl))
1406 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001407 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408
Jeff Layton8634b512015-01-16 15:05:55 -05001409 /* typically we will check that ctx is non-NULL before calling */
1410 if (!ctx) {
1411 WARN_ON_ONCE(1);
1412 return error;
1413 }
1414
Jeff Layton6109c852015-01-16 15:05:57 -05001415 spin_lock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416
Jeff Laytonc45198e2014-09-01 07:12:07 -04001417 time_out_leases(inode, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418
Jeff Layton03d12dd2014-09-01 14:53:41 -04001419 if (!any_leases_conflict(inode, new_fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001420 goto out;
1421
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 break_time = 0;
1423 if (lease_break_time > 0) {
1424 break_time = jiffies + lease_break_time * HZ;
1425 if (break_time == 0)
1426 break_time++; /* so that 0 means no break time */
1427 }
1428
Yan, Zhenga9011252015-03-27 10:34:20 +08001429 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001430 if (!leases_conflict(fl, new_fl))
1431 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001432 if (want_write) {
1433 if (fl->fl_flags & FL_UNLOCK_PENDING)
1434 continue;
1435 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001437 } else {
Jeff Layton8634b512015-01-16 15:05:55 -05001438 if (lease_breaking(fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001439 continue;
1440 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1441 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 }
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001443 if (fl->fl_lmops->lm_break(fl))
Jeff Laytone084c1b2015-02-16 14:32:03 -05001444 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 }
1446
Jeff Layton8634b512015-01-16 15:05:55 -05001447 if (list_empty(&ctx->flc_lease))
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001448 goto out;
1449
Jeff Layton843c6b22014-09-01 14:27:43 -04001450 if (mode & O_NONBLOCK) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001451 trace_break_lease_noblock(inode, new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 error = -EWOULDBLOCK;
1453 goto out;
1454 }
1455
1456restart:
Jeff Layton8634b512015-01-16 15:05:55 -05001457 fl = list_first_entry(&ctx->flc_lease, struct file_lock, fl_list);
1458 break_time = fl->fl_break_time;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001459 if (break_time != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460 break_time -= jiffies;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001461 if (break_time == 0)
1462 break_time++;
Jeff Layton8634b512015-01-16 15:05:55 -05001463 locks_insert_block(fl, new_fl);
Jeff Layton62af4f12014-05-09 14:13:05 -04001464 trace_break_lease_block(inode, new_fl);
Jeff Layton6109c852015-01-16 15:05:57 -05001465 spin_unlock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001466 locks_dispose_list(&dispose);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001467 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1468 !new_fl->fl_next, break_time);
Jeff Layton6109c852015-01-16 15:05:57 -05001469 spin_lock(&ctx->flc_lock);
Jeff Layton62af4f12014-05-09 14:13:05 -04001470 trace_break_lease_unblock(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001471 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 if (error >= 0) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001473 /*
1474 * Wait for the next conflicting lease that has not been
1475 * broken yet
1476 */
Jeff Layton03d12dd2014-09-01 14:53:41 -04001477 if (error == 0)
1478 time_out_leases(inode, &dispose);
1479 if (any_leases_conflict(inode, new_fl))
1480 goto restart;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481 error = 0;
1482 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483out:
Jeff Layton6109c852015-01-16 15:05:57 -05001484 spin_unlock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001485 locks_dispose_list(&dispose);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001486 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487 return error;
1488}
1489
1490EXPORT_SYMBOL(__break_lease);
1491
1492/**
Randy Dunlapa6b91912008-03-19 17:01:00 -07001493 * lease_get_mtime - get the last modified time of an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 * @inode: the inode
1495 * @time: pointer to a timespec which will contain the last modified time
1496 *
1497 * This is to force NFS clients to flush their caches for files with
1498 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001499 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500 */
1501void lease_get_mtime(struct inode *inode, struct timespec *time)
1502{
Jeff Laytonbfe86022014-08-22 10:18:44 -04001503 bool has_lease = false;
Jeff Layton8634b512015-01-16 15:05:55 -05001504 struct file_lock_context *ctx = inode->i_flctx;
1505 struct file_lock *fl;
Jeff Laytonbfe86022014-08-22 10:18:44 -04001506
Jeff Layton8634b512015-01-16 15:05:55 -05001507 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Jeff Layton6109c852015-01-16 15:05:57 -05001508 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001509 if (!list_empty(&ctx->flc_lease)) {
1510 fl = list_first_entry(&ctx->flc_lease,
1511 struct file_lock, fl_list);
1512 if (fl->fl_type == F_WRLCK)
1513 has_lease = true;
1514 }
Jeff Layton6109c852015-01-16 15:05:57 -05001515 spin_unlock(&ctx->flc_lock);
Jeff Laytonbfe86022014-08-22 10:18:44 -04001516 }
1517
1518 if (has_lease)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 *time = current_fs_time(inode->i_sb);
1520 else
1521 *time = inode->i_mtime;
1522}
1523
1524EXPORT_SYMBOL(lease_get_mtime);
1525
1526/**
1527 * fcntl_getlease - Enquire what lease is currently active
1528 * @filp: the file
1529 *
1530 * The value returned by this function will be one of
1531 * (if no lease break is pending):
1532 *
1533 * %F_RDLCK to indicate a shared lease is held.
1534 *
1535 * %F_WRLCK to indicate an exclusive lease is held.
1536 *
1537 * %F_UNLCK to indicate no lease is held.
1538 *
1539 * (if a lease break is pending):
1540 *
1541 * %F_RDLCK to indicate an exclusive lease needs to be
1542 * changed to a shared lease (or removed).
1543 *
1544 * %F_UNLCK to indicate the lease needs to be removed.
1545 *
1546 * XXX: sfr & willy disagree over whether F_INPROGRESS
1547 * should be returned to userspace.
1548 */
1549int fcntl_getlease(struct file *filp)
1550{
1551 struct file_lock *fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001552 struct inode *inode = file_inode(filp);
Jeff Layton8634b512015-01-16 15:05:55 -05001553 struct file_lock_context *ctx = inode->i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 int type = F_UNLCK;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001555 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556
Jeff Layton8634b512015-01-16 15:05:55 -05001557 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Jeff Layton6109c852015-01-16 15:05:57 -05001558 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001559 time_out_leases(file_inode(filp), &dispose);
1560 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1561 if (fl->fl_file != filp)
1562 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001563 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 break;
1565 }
Jeff Layton6109c852015-01-16 15:05:57 -05001566 spin_unlock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001567 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 return type;
1570}
1571
Jeff Layton24cbe782014-02-03 12:13:06 -05001572/**
1573 * check_conflicting_open - see if the given dentry points to a file that has
1574 * an existing open that would conflict with the
1575 * desired lease.
1576 * @dentry: dentry to check
1577 * @arg: type of lease that we're trying to acquire
1578 *
1579 * Check to see if there's an existing open fd on this file that would
1580 * conflict with the lease we're trying to set.
1581 */
1582static int
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001583check_conflicting_open(const struct dentry *dentry, const long arg, int flags)
Jeff Layton24cbe782014-02-03 12:13:06 -05001584{
1585 int ret = 0;
1586 struct inode *inode = dentry->d_inode;
1587
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001588 if (flags & FL_LAYOUT)
1589 return 0;
1590
Jeff Layton24cbe782014-02-03 12:13:06 -05001591 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1592 return -EAGAIN;
1593
1594 if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1595 (atomic_read(&inode->i_count) > 1)))
1596 ret = -EAGAIN;
1597
1598 return ret;
1599}
1600
Jeff Laytone6f5c782014-08-22 10:40:25 -04001601static int
1602generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603{
Jeff Layton8634b512015-01-16 15:05:55 -05001604 struct file_lock *fl, *my_fl = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001605 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 struct inode *inode = dentry->d_inode;
Jeff Layton8634b512015-01-16 15:05:55 -05001607 struct file_lock_context *ctx;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001608 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001609 int error;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001610 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611
J. Bruce Fields096657b2010-10-30 17:31:14 -04001612 lease = *flp;
Jeff Layton62af4f12014-05-09 14:13:05 -04001613 trace_generic_add_lease(inode, lease);
1614
Jeff Layton5c1c6692015-04-03 09:04:03 -04001615 /* Note that arg is never F_UNLCK here */
1616 ctx = locks_get_lock_context(inode, arg);
Jeff Layton8634b512015-01-16 15:05:55 -05001617 if (!ctx)
1618 return -ENOMEM;
1619
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001620 /*
1621 * In the delegation case we need mutual exclusion with
1622 * a number of operations that take the i_mutex. We trylock
1623 * because delegations are an optional optimization, and if
1624 * there's some chance of a conflict--we'd rather not
1625 * bother, maybe that's a sign this just isn't a good file to
1626 * hand out a delegation on.
1627 */
1628 if (is_deleg && !mutex_trylock(&inode->i_mutex))
1629 return -EAGAIN;
1630
1631 if (is_deleg && arg == F_WRLCK) {
1632 /* Write delegations are not currently supported: */
Dan Carpenter4fdb7932013-11-13 10:56:27 +03001633 mutex_unlock(&inode->i_mutex);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001634 WARN_ON_ONCE(1);
1635 return -EINVAL;
1636 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001637
Jeff Layton6109c852015-01-16 15:05:57 -05001638 spin_lock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001639 time_out_leases(inode, &dispose);
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001640 error = check_conflicting_open(dentry, arg, lease->fl_flags);
Jeff Layton24cbe782014-02-03 12:13:06 -05001641 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001642 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001643
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 /*
1645 * At this point, we know that if there is an exclusive
1646 * lease on this file, then we hold it on this filp
1647 * (otherwise our open of this file would have blocked).
1648 * And if we are trying to acquire an exclusive lease,
1649 * then the file is not open by anyone (including us)
1650 * except for this filp.
1651 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001652 error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001653 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001654 if (fl->fl_file == filp &&
1655 fl->fl_owner == lease->fl_owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001656 my_fl = fl;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001657 continue;
1658 }
Jeff Layton8634b512015-01-16 15:05:55 -05001659
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001660 /*
1661 * No exclusive leases if someone else has a lease on
1662 * this file:
1663 */
1664 if (arg == F_WRLCK)
1665 goto out;
1666 /*
1667 * Modifying our existing lease is OK, but no getting a
1668 * new lease if someone else is opening for write:
1669 */
1670 if (fl->fl_flags & FL_UNLOCK_PENDING)
1671 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 }
1673
Jeff Layton8634b512015-01-16 15:05:55 -05001674 if (my_fl != NULL) {
Jeff Layton0164bf02015-03-04 17:34:32 -05001675 lease = my_fl;
1676 error = lease->fl_lmops->lm_change(lease, arg, &dispose);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001677 if (error)
1678 goto out;
1679 goto out_setup;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 }
1681
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 error = -EINVAL;
1683 if (!leases_enable)
1684 goto out;
1685
Jeff Laytone084c1b2015-02-16 14:32:03 -05001686 locks_insert_lock_ctx(lease, &ctx->flc_lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001687 /*
1688 * The check in break_lease() is lockless. It's possible for another
1689 * open to race in after we did the earlier check for a conflicting
1690 * open but before the lease was inserted. Check again for a
1691 * conflicting open and cancel the lease if there is one.
1692 *
1693 * We also add a barrier here to ensure that the insertion of the lock
1694 * precedes these checks.
1695 */
1696 smp_mb();
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001697 error = check_conflicting_open(dentry, arg, lease->fl_flags);
Jeff Layton8634b512015-01-16 15:05:55 -05001698 if (error) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001699 locks_unlink_lock_ctx(lease);
Jeff Layton8634b512015-01-16 15:05:55 -05001700 goto out;
1701 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001702
1703out_setup:
1704 if (lease->fl_lmops->lm_setup)
1705 lease->fl_lmops->lm_setup(lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706out:
Jeff Layton6109c852015-01-16 15:05:57 -05001707 spin_unlock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001708 locks_dispose_list(&dispose);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001709 if (is_deleg)
1710 mutex_unlock(&inode->i_mutex);
Jeff Layton8634b512015-01-16 15:05:55 -05001711 if (!error && !my_fl)
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001712 *flp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 return error;
1714}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001715
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001716static int generic_delete_lease(struct file *filp, void *owner)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001717{
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001718 int error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001719 struct file_lock *fl, *victim = NULL;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001720 struct dentry *dentry = filp->f_path.dentry;
1721 struct inode *inode = dentry->d_inode;
Jeff Layton8634b512015-01-16 15:05:55 -05001722 struct file_lock_context *ctx = inode->i_flctx;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001723 LIST_HEAD(dispose);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001724
Jeff Layton8634b512015-01-16 15:05:55 -05001725 if (!ctx) {
1726 trace_generic_delete_lease(inode, NULL);
1727 return error;
1728 }
1729
Jeff Layton6109c852015-01-16 15:05:57 -05001730 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001731 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001732 if (fl->fl_file == filp &&
1733 fl->fl_owner == owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001734 victim = fl;
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001735 break;
Jeff Layton8634b512015-01-16 15:05:55 -05001736 }
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001737 }
Jeff Laytona9b1b452015-03-14 09:45:35 -04001738 trace_generic_delete_lease(inode, victim);
Jeff Layton8634b512015-01-16 15:05:55 -05001739 if (victim)
Jeff Layton7448cc32015-01-16 15:05:57 -05001740 error = fl->fl_lmops->lm_change(victim, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05001741 spin_unlock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001742 locks_dispose_list(&dispose);
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001743 return error;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001744}
1745
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746/**
1747 * generic_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001748 * @filp: file pointer
1749 * @arg: type of lease to obtain
1750 * @flp: input - file_lock to use, output - file_lock inserted
1751 * @priv: private data for lm_setup (may be NULL if lm_setup
1752 * doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 *
1754 * The (input) flp->fl_lmops->lm_break function is required
1755 * by break_lease().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001757int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
1758 void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760 struct dentry *dentry = filp->f_path.dentry;
1761 struct inode *inode = dentry->d_inode;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001762 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001764 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001765 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001767 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 error = security_file_lock(filp, arg);
1769 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001770 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001772 switch (arg) {
1773 case F_UNLCK:
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001774 return generic_delete_lease(filp, *priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001775 case F_RDLCK:
1776 case F_WRLCK:
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001777 if (!(*flp)->fl_lmops->lm_break) {
1778 WARN_ON_ONCE(1);
1779 return -ENOLCK;
1780 }
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001781
Jeff Laytone6f5c782014-08-22 10:40:25 -04001782 return generic_add_lease(filp, arg, flp, priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001783 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001784 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001787EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001789/**
Jeff Laytone51673a2014-08-22 18:13:28 -04001790 * vfs_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001791 * @filp: file pointer
1792 * @arg: type of lease to obtain
1793 * @lease: file_lock to use when adding a lease
1794 * @priv: private info for lm_setup when adding a lease (may be
1795 * NULL if lm_setup doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 *
Jeff Laytone51673a2014-08-22 18:13:28 -04001797 * Call this to establish a lease on the file. The "lease" argument is not
1798 * used for F_UNLCK requests and may be NULL. For commands that set or alter
1799 * an existing lease, the (*lease)->fl_lmops->lm_break operation must be set;
1800 * if not, this function will return -ENOLCK (and generate a scary-looking
1801 * stack trace).
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001802 *
1803 * The "priv" pointer is passed directly to the lm_setup function as-is. It
1804 * may be NULL if the lm_setup operation doesn't require it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001806int
1807vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808{
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001809 if (filp->f_op->setlease)
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001810 return filp->f_op->setlease(filp, arg, lease, priv);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001811 else
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001812 return generic_setlease(filp, arg, lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001814EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001816static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817{
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001818 struct file_lock *fl;
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001819 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 int error;
1821
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001822 fl = lease_alloc(filp, arg);
1823 if (IS_ERR(fl))
1824 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001826 new = fasync_alloc();
1827 if (!new) {
1828 locks_free_lock(fl);
1829 return -ENOMEM;
1830 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001831 new->fa_fd = fd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001833 error = vfs_setlease(filp, arg, &fl, (void **)&new);
Jeff Layton2dfb9282014-08-11 18:14:12 -04001834 if (fl)
1835 locks_free_lock(fl);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001836 if (new)
1837 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 return error;
1839}
1840
1841/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001842 * fcntl_setlease - sets a lease on an open file
1843 * @fd: open file descriptor
1844 * @filp: file pointer
1845 * @arg: type of lease to obtain
1846 *
1847 * Call this fcntl to establish a lease on the file.
1848 * Note that you also need to call %F_SETSIG to
1849 * receive a signal when the lease is broken.
1850 */
1851int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1852{
1853 if (arg == F_UNLCK)
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001854 return vfs_setlease(filp, F_UNLCK, NULL, (void **)&filp);
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001855 return do_fcntl_add_lease(fd, filp, arg);
1856}
1857
1858/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1860 * @filp: The file to apply the lock to
1861 * @fl: The lock to be applied
1862 *
1863 * Add a FLOCK style lock to a file.
1864 */
1865int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1866{
1867 int error;
1868 might_sleep();
1869 for (;;) {
1870 error = flock_lock_file(filp, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001871 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872 break;
1873 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1874 if (!error)
1875 continue;
1876
1877 locks_delete_block(fl);
1878 break;
1879 }
1880 return error;
1881}
1882
1883EXPORT_SYMBOL(flock_lock_file_wait);
1884
1885/**
1886 * sys_flock: - flock() system call.
1887 * @fd: the file descriptor to lock.
1888 * @cmd: the type of lock to apply.
1889 *
1890 * Apply a %FL_FLOCK style lock to an open file descriptor.
1891 * The @cmd can be one of
1892 *
1893 * %LOCK_SH -- a shared lock.
1894 *
1895 * %LOCK_EX -- an exclusive lock.
1896 *
1897 * %LOCK_UN -- remove an existing lock.
1898 *
1899 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1900 *
1901 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1902 * processes read and write access respectively.
1903 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001904SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905{
Al Viro2903ff02012-08-28 12:52:22 -04001906 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 struct file_lock *lock;
1908 int can_sleep, unlock;
1909 int error;
1910
1911 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001912 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913 goto out;
1914
1915 can_sleep = !(cmd & LOCK_NB);
1916 cmd &= ~LOCK_NB;
1917 unlock = (cmd == LOCK_UN);
1918
Al Viroaeb5d722008-09-02 15:28:45 -04001919 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04001920 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 goto out_putf;
1922
Jeff Layton6e129d002014-09-04 10:25:06 -04001923 lock = flock_make_lock(f.file, cmd);
1924 if (IS_ERR(lock)) {
1925 error = PTR_ERR(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 goto out_putf;
Jeff Layton6e129d002014-09-04 10:25:06 -04001927 }
1928
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 if (can_sleep)
1930 lock->fl_flags |= FL_SLEEP;
1931
Al Viro2903ff02012-08-28 12:52:22 -04001932 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 if (error)
1934 goto out_free;
1935
Al Viro72c2d532013-09-22 16:27:52 -04001936 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04001937 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938 (can_sleep) ? F_SETLKW : F_SETLK,
1939 lock);
1940 else
Al Viro2903ff02012-08-28 12:52:22 -04001941 error = flock_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942
1943 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08001944 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945
1946 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04001947 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 out:
1949 return error;
1950}
1951
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001952/**
1953 * vfs_test_lock - test file byte range lock
1954 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04001955 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001956 *
1957 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1958 * setting conf->fl_type to something other than F_UNLCK.
1959 */
1960int vfs_test_lock(struct file *filp, struct file_lock *fl)
1961{
Al Viro72c2d532013-09-22 16:27:52 -04001962 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001963 return filp->f_op->lock(filp, F_GETLK, fl);
1964 posix_test_lock(filp, fl);
1965 return 0;
1966}
1967EXPORT_SYMBOL_GPL(vfs_test_lock);
1968
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001969static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1970{
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001971 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001972#if BITS_PER_LONG == 32
1973 /*
1974 * Make sure we can represent the posix lock via
1975 * legacy 32bit flock.
1976 */
1977 if (fl->fl_start > OFFT_OFFSET_MAX)
1978 return -EOVERFLOW;
1979 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1980 return -EOVERFLOW;
1981#endif
1982 flock->l_start = fl->fl_start;
1983 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1984 fl->fl_end - fl->fl_start + 1;
1985 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04001986 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001987 return 0;
1988}
1989
1990#if BITS_PER_LONG == 32
1991static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1992{
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001993 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001994 flock->l_start = fl->fl_start;
1995 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1996 fl->fl_end - fl->fl_start + 1;
1997 flock->l_whence = 0;
1998 flock->l_type = fl->fl_type;
1999}
2000#endif
2001
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002/* Report the first existing lock that would conflict with l.
2003 * This implements the F_GETLK command of fcntl().
2004 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05002005int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002007 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 struct flock flock;
2009 int error;
2010
2011 error = -EFAULT;
2012 if (copy_from_user(&flock, l, sizeof(flock)))
2013 goto out;
2014 error = -EINVAL;
2015 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2016 goto out;
2017
2018 error = flock_to_posix_lock(filp, &file_lock, &flock);
2019 if (error)
2020 goto out;
2021
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002022 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002023 error = -EINVAL;
2024 if (flock.l_pid != 0)
2025 goto out;
2026
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002027 cmd = F_GETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002028 file_lock.fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002029 file_lock.fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002030 }
2031
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002032 error = vfs_test_lock(filp, &file_lock);
2033 if (error)
2034 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002036 flock.l_type = file_lock.fl_type;
2037 if (file_lock.fl_type != F_UNLCK) {
2038 error = posix_lock_to_flock(&flock, &file_lock);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002039 if (error)
Kinglong Meef3282962014-08-22 10:18:43 -04002040 goto rel_priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 }
2042 error = -EFAULT;
2043 if (!copy_to_user(l, &flock, sizeof(flock)))
2044 error = 0;
Kinglong Meef3282962014-08-22 10:18:43 -04002045rel_priv:
2046 locks_release_private(&file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047out:
2048 return error;
2049}
2050
Marc Eshel7723ec92007-01-18 15:08:55 -05002051/**
2052 * vfs_lock_file - file byte range lock
2053 * @filp: The file to apply the lock to
2054 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2055 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05002056 * @conf: Place to return a copy of the conflicting lock, if found.
2057 *
2058 * A caller that doesn't care about the conflicting lock may pass NULL
2059 * as the final argument.
2060 *
2061 * If the filesystem defines a private ->lock() method, then @conf will
2062 * be left unchanged; so a caller that cares should initialize it to
2063 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05002064 *
2065 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2066 * locks, the ->lock() interface may return asynchronously, before the lock has
2067 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002068 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05002069 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2070 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002071 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05002072 * request completes.
2073 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07002074 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2075 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05002076 * nonzero return code and the file system should release the lock. The file
2077 * system is also responsible to keep a corresponding posix lock when it
2078 * grants a lock so the VFS can find out which locks are locally held and do
2079 * the correct lock cleanup when required.
2080 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002081 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05002082 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05002083 */
Marc Eshel150b3932007-01-18 16:15:35 -05002084int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05002085{
Al Viro72c2d532013-09-22 16:27:52 -04002086 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05002087 return filp->f_op->lock(filp, cmd, fl);
2088 else
Marc Eshel150b3932007-01-18 16:15:35 -05002089 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05002090}
2091EXPORT_SYMBOL_GPL(vfs_lock_file);
2092
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002093static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2094 struct file_lock *fl)
2095{
2096 int error;
2097
2098 error = security_file_lock(filp, fl->fl_type);
2099 if (error)
2100 return error;
2101
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002102 for (;;) {
2103 error = vfs_lock_file(filp, cmd, fl, NULL);
2104 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002105 break;
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002106 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
2107 if (!error)
2108 continue;
2109
2110 locks_delete_block(fl);
2111 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002112 }
2113
2114 return error;
2115}
2116
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002117/* Ensure that fl->fl_filp has compatible f_mode for F_SETLK calls */
2118static int
2119check_fmode_for_setlk(struct file_lock *fl)
2120{
2121 switch (fl->fl_type) {
2122 case F_RDLCK:
2123 if (!(fl->fl_file->f_mode & FMODE_READ))
2124 return -EBADF;
2125 break;
2126 case F_WRLCK:
2127 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2128 return -EBADF;
2129 }
2130 return 0;
2131}
2132
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133/* Apply the lock described by l to an open file descriptor.
2134 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2135 */
Peter Staubachc2936212005-07-27 11:45:09 -07002136int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
2137 struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138{
2139 struct file_lock *file_lock = locks_alloc_lock();
2140 struct flock flock;
2141 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002142 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 int error;
2144
2145 if (file_lock == NULL)
2146 return -ENOLCK;
2147
2148 /*
2149 * This might block, so we do it before checking the inode.
2150 */
2151 error = -EFAULT;
2152 if (copy_from_user(&flock, l, sizeof(flock)))
2153 goto out;
2154
Al Viro496ad9a2013-01-23 17:07:38 -05002155 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156
2157 /* Don't allow mandatory locks on files that may be memory mapped
2158 * and shared.
2159 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002160 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 error = -EAGAIN;
2162 goto out;
2163 }
2164
Peter Staubachc2936212005-07-27 11:45:09 -07002165again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 error = flock_to_posix_lock(filp, file_lock, &flock);
2167 if (error)
2168 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002169
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002170 error = check_fmode_for_setlk(file_lock);
2171 if (error)
2172 goto out;
2173
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002174 /*
2175 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002176 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002177 */
2178 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002179 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002180 error = -EINVAL;
2181 if (flock.l_pid != 0)
2182 goto out;
2183
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002184 cmd = F_SETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002185 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002186 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002187 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002188 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002189 error = -EINVAL;
2190 if (flock.l_pid != 0)
2191 goto out;
2192
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002193 cmd = F_SETLKW;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002194 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002195 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002196 /* Fallthrough */
2197 case F_SETLKW:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 file_lock->fl_flags |= FL_SLEEP;
2199 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002200
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002201 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202
Peter Staubachc2936212005-07-27 11:45:09 -07002203 /*
2204 * Attempt to detect a close/fcntl race and recover by
2205 * releasing the lock that was just acquired.
2206 */
Al Viro0b2bac22008-05-06 13:58:34 -04002207 /*
2208 * we need that spin_lock here - it prevents reordering between
Jeff Layton8116bf42015-01-21 20:44:01 -05002209 * update of i_flctx->flc_posix and check for it done in close().
Al Viro0b2bac22008-05-06 13:58:34 -04002210 * rcu_read_lock() wouldn't do.
2211 */
2212 spin_lock(&current->files->file_lock);
2213 f = fcheck(fd);
2214 spin_unlock(&current->files->file_lock);
2215 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002216 flock.l_type = F_UNLCK;
2217 goto again;
2218 }
2219
2220out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 locks_free_lock(file_lock);
2222 return error;
2223}
2224
2225#if BITS_PER_LONG == 32
2226/* Report the first existing lock that would conflict with l.
2227 * This implements the F_GETLK command of fcntl().
2228 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05002229int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002231 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232 struct flock64 flock;
2233 int error;
2234
2235 error = -EFAULT;
2236 if (copy_from_user(&flock, l, sizeof(flock)))
2237 goto out;
2238 error = -EINVAL;
2239 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2240 goto out;
2241
2242 error = flock64_to_posix_lock(filp, &file_lock, &flock);
2243 if (error)
2244 goto out;
2245
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002246 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002247 error = -EINVAL;
2248 if (flock.l_pid != 0)
2249 goto out;
2250
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002251 cmd = F_GETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002252 file_lock.fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002253 file_lock.fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002254 }
2255
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002256 error = vfs_test_lock(filp, &file_lock);
2257 if (error)
2258 goto out;
2259
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002260 flock.l_type = file_lock.fl_type;
2261 if (file_lock.fl_type != F_UNLCK)
2262 posix_lock_to_flock64(&flock, &file_lock);
2263
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 error = -EFAULT;
2265 if (!copy_to_user(l, &flock, sizeof(flock)))
2266 error = 0;
Kinglong Meef3282962014-08-22 10:18:43 -04002267
2268 locks_release_private(&file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269out:
2270 return error;
2271}
2272
2273/* Apply the lock described by l to an open file descriptor.
2274 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2275 */
Peter Staubachc2936212005-07-27 11:45:09 -07002276int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2277 struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278{
2279 struct file_lock *file_lock = locks_alloc_lock();
2280 struct flock64 flock;
2281 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002282 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283 int error;
2284
2285 if (file_lock == NULL)
2286 return -ENOLCK;
2287
2288 /*
2289 * This might block, so we do it before checking the inode.
2290 */
2291 error = -EFAULT;
2292 if (copy_from_user(&flock, l, sizeof(flock)))
2293 goto out;
2294
Al Viro496ad9a2013-01-23 17:07:38 -05002295 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296
2297 /* Don't allow mandatory locks on files that may be memory mapped
2298 * and shared.
2299 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002300 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 error = -EAGAIN;
2302 goto out;
2303 }
2304
Peter Staubachc2936212005-07-27 11:45:09 -07002305again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 error = flock64_to_posix_lock(filp, file_lock, &flock);
2307 if (error)
2308 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002309
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002310 error = check_fmode_for_setlk(file_lock);
2311 if (error)
2312 goto out;
2313
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002314 /*
2315 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002316 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002317 */
2318 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002319 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002320 error = -EINVAL;
2321 if (flock.l_pid != 0)
2322 goto out;
2323
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002324 cmd = F_SETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002325 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002326 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002327 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002328 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002329 error = -EINVAL;
2330 if (flock.l_pid != 0)
2331 goto out;
2332
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002333 cmd = F_SETLKW64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002334 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002335 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002336 /* Fallthrough */
2337 case F_SETLKW64:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338 file_lock->fl_flags |= FL_SLEEP;
2339 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002340
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002341 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342
Peter Staubachc2936212005-07-27 11:45:09 -07002343 /*
2344 * Attempt to detect a close/fcntl race and recover by
2345 * releasing the lock that was just acquired.
2346 */
Al Viro0b2bac22008-05-06 13:58:34 -04002347 spin_lock(&current->files->file_lock);
2348 f = fcheck(fd);
2349 spin_unlock(&current->files->file_lock);
2350 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002351 flock.l_type = F_UNLCK;
2352 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353 }
2354
2355out:
2356 locks_free_lock(file_lock);
2357 return error;
2358}
2359#endif /* BITS_PER_LONG == 32 */
2360
2361/*
2362 * This function is called when the file is being removed
2363 * from the task's fd array. POSIX locks belonging to this task
2364 * are deleted at this time.
2365 */
2366void locks_remove_posix(struct file *filp, fl_owner_t owner)
2367{
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002368 struct file_lock lock;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05002369 struct file_lock_context *ctx = file_inode(filp)->i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370
2371 /*
2372 * If there are no locks held on this file, we don't need to call
2373 * posix_lock_file(). Another process could be setting a lock on this
2374 * file at the same time, but we wouldn't remove that lock anyway.
2375 */
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05002376 if (!ctx || list_empty(&ctx->flc_posix))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377 return;
2378
2379 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002380 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 lock.fl_start = 0;
2382 lock.fl_end = OFFSET_MAX;
2383 lock.fl_owner = owner;
2384 lock.fl_pid = current->tgid;
2385 lock.fl_file = filp;
2386 lock.fl_ops = NULL;
2387 lock.fl_lmops = NULL;
2388
Marc Eshel150b3932007-01-18 16:15:35 -05002389 vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2392 lock.fl_ops->fl_release_private(&lock);
2393}
2394
2395EXPORT_SYMBOL(locks_remove_posix);
2396
Jeff Layton3d8e5602015-01-16 15:05:58 -05002397/* The i_flctx must be valid when calling into here */
Jeff Laytondd459bb2015-01-16 15:05:54 -05002398static void
2399locks_remove_flock(struct file *filp)
2400{
2401 struct file_lock fl = {
2402 .fl_owner = filp,
2403 .fl_pid = current->tgid,
2404 .fl_file = filp,
2405 .fl_flags = FL_FLOCK,
2406 .fl_type = F_UNLCK,
2407 .fl_end = OFFSET_MAX,
2408 };
Jeff Layton5263e312015-01-16 15:05:55 -05002409 struct file_lock_context *flctx = file_inode(filp)->i_flctx;
Jeff Laytondd459bb2015-01-16 15:05:54 -05002410
Jeff Layton3d8e5602015-01-16 15:05:58 -05002411 if (list_empty(&flctx->flc_flock))
Jeff Laytondd459bb2015-01-16 15:05:54 -05002412 return;
2413
2414 if (filp->f_op->flock)
2415 filp->f_op->flock(filp, F_SETLKW, &fl);
2416 else
2417 flock_lock_file(filp, &fl);
2418
2419 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2420 fl.fl_ops->fl_release_private(&fl);
2421}
2422
Jeff Layton3d8e5602015-01-16 15:05:58 -05002423/* The i_flctx must be valid when calling into here */
Jeff Layton8634b512015-01-16 15:05:55 -05002424static void
2425locks_remove_lease(struct file *filp)
2426{
2427 struct inode *inode = file_inode(filp);
2428 struct file_lock_context *ctx = inode->i_flctx;
2429 struct file_lock *fl, *tmp;
2430 LIST_HEAD(dispose);
2431
Jeff Layton3d8e5602015-01-16 15:05:58 -05002432 if (list_empty(&ctx->flc_lease))
Jeff Layton8634b512015-01-16 15:05:55 -05002433 return;
2434
Jeff Layton6109c852015-01-16 15:05:57 -05002435 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05002436 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list)
Jeff Laytonc4e136c2015-02-16 19:37:42 -05002437 if (filp == fl->fl_file)
2438 lease_modify(fl, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05002439 spin_unlock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05002440 locks_dispose_list(&dispose);
2441}
2442
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443/*
2444 * This function is called on the last close of an open file.
2445 */
Jeff Layton78ed8a12014-02-03 12:13:08 -05002446void locks_remove_file(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447{
Jeff Layton3d8e5602015-01-16 15:05:58 -05002448 if (!file_inode(filp)->i_flctx)
2449 return;
2450
Jeff Laytondd459bb2015-01-16 15:05:54 -05002451 /* remove any OFD locks */
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002452 locks_remove_posix(filp, filp);
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002453
Jeff Laytondd459bb2015-01-16 15:05:54 -05002454 /* remove flock locks */
2455 locks_remove_flock(filp);
2456
Jeff Layton8634b512015-01-16 15:05:55 -05002457 /* remove any leases */
2458 locks_remove_lease(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459}
2460
2461/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462 * posix_unblock_lock - stop waiting for a file lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 * @waiter: the lock which was waiting
2464 *
2465 * lockd needs to block waiting for locks.
2466 */
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002467int
Jeff Laytonf891a292013-06-21 08:58:09 -04002468posix_unblock_lock(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469{
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002470 int status = 0;
2471
Jeff Layton7b2296a2013-06-21 08:58:20 -04002472 spin_lock(&blocked_lock_lock);
J. Bruce Fields5996a292006-01-03 09:55:44 +01002473 if (waiter->fl_next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474 __locks_delete_block(waiter);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002475 else
2476 status = -ENOENT;
Jeff Layton7b2296a2013-06-21 08:58:20 -04002477 spin_unlock(&blocked_lock_lock);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002478 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480EXPORT_SYMBOL(posix_unblock_lock);
2481
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002482/**
2483 * vfs_cancel_lock - file byte range unblock lock
2484 * @filp: The file to apply the unblock to
2485 * @fl: The lock to be unblocked
2486 *
2487 * Used by lock managers to cancel blocked requests
2488 */
2489int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2490{
Al Viro72c2d532013-09-22 16:27:52 -04002491 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002492 return filp->f_op->lock(filp, F_CANCELLK, fl);
2493 return 0;
2494}
2495
2496EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2497
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002498#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002499#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002500#include <linux/seq_file.h>
2501
Jeff Layton7012b022013-06-21 08:58:22 -04002502struct locks_iterator {
2503 int li_cpu;
2504 loff_t li_pos;
2505};
2506
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002507static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002508 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509{
2510 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002511 unsigned int fl_pid;
2512
2513 if (fl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -08002514 fl_pid = pid_vnr(fl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002515 else
2516 fl_pid = fl->fl_pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517
2518 if (fl->fl_file != NULL)
Al Viro496ad9a2013-01-23 17:07:38 -05002519 inode = file_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520
Jerome Marchand99dc8292010-10-26 14:22:33 -07002521 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522 if (IS_POSIX(fl)) {
Jeff Laytonc918d422014-02-03 12:13:09 -05002523 if (fl->fl_flags & FL_ACCESS)
Fabian Frederick5315c262014-05-09 14:13:05 -04002524 seq_puts(f, "ACCESS");
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002525 else if (IS_OFDLCK(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002526 seq_puts(f, "OFDLCK");
Jeff Laytonc918d422014-02-03 12:13:09 -05002527 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002528 seq_puts(f, "POSIX ");
Jeff Laytonc918d422014-02-03 12:13:09 -05002529
2530 seq_printf(f, " %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002532 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533 } else if (IS_FLOCK(fl)) {
2534 if (fl->fl_type & LOCK_MAND) {
Fabian Frederick5315c262014-05-09 14:13:05 -04002535 seq_puts(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002537 seq_puts(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002538 }
2539 } else if (IS_LEASE(fl)) {
Jeff Layton8144f1f2014-08-11 13:36:54 -04002540 if (fl->fl_flags & FL_DELEG)
2541 seq_puts(f, "DELEG ");
2542 else
2543 seq_puts(f, "LEASE ");
2544
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002545 if (lease_breaking(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002546 seq_puts(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547 else if (fl->fl_file)
Fabian Frederick5315c262014-05-09 14:13:05 -04002548 seq_puts(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002549 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002550 seq_puts(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002551 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002552 seq_puts(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553 }
2554 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002555 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556 (fl->fl_type & LOCK_READ)
2557 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2558 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2559 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002560 seq_printf(f, "%s ",
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002561 (lease_breaking(fl))
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04002562 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2563 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564 }
2565 if (inode) {
2566#ifdef WE_CAN_BREAK_LSLK_NOW
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002567 seq_printf(f, "%d %s:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568 inode->i_sb->s_id, inode->i_ino);
2569#else
2570 /* userspace relies on this representation of dev_t ;-( */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002571 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572 MAJOR(inode->i_sb->s_dev),
2573 MINOR(inode->i_sb->s_dev), inode->i_ino);
2574#endif
2575 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002576 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002577 }
2578 if (IS_POSIX(fl)) {
2579 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002580 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002581 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002582 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002584 seq_puts(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002585 }
2586}
2587
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002588static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002589{
Jeff Layton7012b022013-06-21 08:58:22 -04002590 struct locks_iterator *iter = f->private;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002591 struct file_lock *fl, *bfl;
2592
Jeff Layton139ca042013-06-21 08:58:17 -04002593 fl = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002594
Jeff Layton7012b022013-06-21 08:58:22 -04002595 lock_get_status(f, fl, iter->li_pos, "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002596
2597 list_for_each_entry(bfl, &fl->fl_block, fl_block)
Jeff Layton7012b022013-06-21 08:58:22 -04002598 lock_get_status(f, bfl, iter->li_pos, " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002599
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002600 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002601}
2602
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002603static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002604 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002605{
Jeff Layton7012b022013-06-21 08:58:22 -04002606 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002607
Jeff Layton7012b022013-06-21 08:58:22 -04002608 iter->li_pos = *pos + 1;
2609 lg_global_lock(&file_lock_lglock);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002610 spin_lock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002611 return seq_hlist_start_percpu(&file_lock_list, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612}
2613
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002614static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2615{
Jeff Layton7012b022013-06-21 08:58:22 -04002616 struct locks_iterator *iter = f->private;
2617
2618 ++iter->li_pos;
2619 return seq_hlist_next_percpu(v, &file_lock_list, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002620}
2621
2622static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002623 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002624{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002625 spin_unlock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002626 lg_global_unlock(&file_lock_lglock);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002627}
2628
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002629static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002630 .start = locks_start,
2631 .next = locks_next,
2632 .stop = locks_stop,
2633 .show = locks_show,
2634};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002635
2636static int locks_open(struct inode *inode, struct file *filp)
2637{
Jeff Layton7012b022013-06-21 08:58:22 -04002638 return seq_open_private(filp, &locks_seq_operations,
2639 sizeof(struct locks_iterator));
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002640}
2641
2642static const struct file_operations proc_locks_operations = {
2643 .open = locks_open,
2644 .read = seq_read,
2645 .llseek = seq_lseek,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002646 .release = seq_release_private,
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002647};
2648
2649static int __init proc_locks_init(void)
2650{
2651 proc_create("locks", 0, NULL, &proc_locks_operations);
2652 return 0;
2653}
2654module_init(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002655#endif
2656
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657static int __init filelock_init(void)
2658{
Jeff Layton7012b022013-06-21 08:58:22 -04002659 int i;
2660
Jeff Layton4a075e32015-01-16 15:05:54 -05002661 flctx_cache = kmem_cache_create("file_lock_ctx",
2662 sizeof(struct file_lock_context), 0, SLAB_PANIC, NULL);
2663
Linus Torvalds1da177e2005-04-16 15:20:36 -07002664 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002665 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2666
Jeff Layton7012b022013-06-21 08:58:22 -04002667 lg_lock_init(&file_lock_lglock, "file_lock_lglock");
2668
2669 for_each_possible_cpu(i)
2670 INIT_HLIST_HEAD(per_cpu_ptr(&file_lock_list, i));
2671
Linus Torvalds1da177e2005-04-16 15:20:36 -07002672 return 0;
2673}
2674
2675core_initcall(filelock_init);