blob: 055df53f19de7476bf6bdff8501faffd0664d937 [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)
J. Bruce Fields617588d2011-07-01 15:18:34 -0400140#define IS_LEASE(fl) (fl->fl_flags & (FL_LEASE|FL_DELEG))
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
160#define for_each_lock(inode, lockp) \
161 for (lockp = &inode->i_flock; *lockp != NULL; lockp = &(*lockp)->fl_next)
162
Jeff Layton1c8c6012013-06-21 08:58:15 -0400163/*
Jeff Layton7012b022013-06-21 08:58:22 -0400164 * The global file_lock_list is only used for displaying /proc/locks, so we
165 * keep a list on each CPU, with each list protected by its own spinlock via
166 * the file_lock_lglock. Note that alterations to the list also require that
167 * the relevant i_lock is held.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400168 */
Jeff Layton7012b022013-06-21 08:58:22 -0400169DEFINE_STATIC_LGLOCK(file_lock_lglock);
170static DEFINE_PER_CPU(struct hlist_head, file_lock_list);
Jeff Layton88974692013-06-21 08:58:14 -0400171
Jeff Layton1c8c6012013-06-21 08:58:15 -0400172/*
Jeff Layton48f74182013-06-21 08:58:18 -0400173 * The blocked_hash is used to find POSIX lock loops for deadlock detection.
Jeff Layton7b2296a2013-06-21 08:58:20 -0400174 * It is protected by blocked_lock_lock.
Jeff Layton48f74182013-06-21 08:58:18 -0400175 *
176 * We hash locks by lockowner in order to optimize searching for the lock a
177 * particular lockowner is waiting on.
178 *
179 * FIXME: make this value scale via some heuristic? We generally will want more
180 * buckets when we have more lockowners holding locks, but that's a little
181 * difficult to determine without knowing what the workload will look like.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400182 */
Jeff Layton48f74182013-06-21 08:58:18 -0400183#define BLOCKED_HASH_BITS 7
184static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
Jeff Layton88974692013-06-21 08:58:14 -0400185
Jeff Layton1c8c6012013-06-21 08:58:15 -0400186/*
Jeff Layton7b2296a2013-06-21 08:58:20 -0400187 * This lock protects the blocked_hash. Generally, if you're accessing it, you
188 * want to be holding this lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400189 *
190 * In addition, it also protects the fl->fl_block list, and the fl->fl_next
191 * pointer for file_lock structures that are acting as lock requests (in
192 * contrast to those that are acting as records of acquired locks).
193 *
194 * Note that when we acquire this lock in order to change the above fields,
195 * we often hold the i_lock as well. In certain cases, when reading the fields
196 * protected by this lock, we can skip acquiring it iff we already hold the
197 * i_lock.
198 *
199 * In particular, adding an entry to the fl_block list requires that you hold
200 * both the i_lock and the blocked_lock_lock (acquired in that order). Deleting
201 * an entry from the list however only requires the file_lock_lock.
202 */
Jeff Layton7b2296a2013-06-21 08:58:20 -0400203static DEFINE_SPINLOCK(blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Jeff Layton4a075e32015-01-16 15:05:54 -0500205static struct kmem_cache *flctx_cache __read_mostly;
Christoph Lametere18b8902006-12-06 20:33:20 -0800206static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
Jeff Layton4a075e32015-01-16 15:05:54 -0500208static struct file_lock_context *
209locks_get_lock_context(struct inode *inode)
210{
211 struct file_lock_context *new;
212
213 if (likely(inode->i_flctx))
214 goto out;
215
216 new = kmem_cache_alloc(flctx_cache, GFP_KERNEL);
217 if (!new)
218 goto out;
219
220 INIT_LIST_HEAD(&new->flc_flock);
221
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));
244 kmem_cache_free(flctx_cache, ctx);
245 }
246}
247
Miklos Szerediee19cc42011-07-07 13:06:09 +0200248static void locks_init_lock_heads(struct file_lock *fl)
Miklos Szeredia51cb912011-07-06 12:33:55 +0200249{
Jeff Layton139ca042013-06-21 08:58:17 -0400250 INIT_HLIST_NODE(&fl->fl_link);
Jeff Layton6dee60f2015-01-16 15:05:54 -0500251 INIT_LIST_HEAD(&fl->fl_list);
Miklos Szerediee19cc42011-07-07 13:06:09 +0200252 INIT_LIST_HEAD(&fl->fl_block);
253 init_waitqueue_head(&fl->fl_wait);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200254}
255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200257struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200259 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200260
261 if (fl)
Miklos Szerediee19cc42011-07-07 13:06:09 +0200262 locks_init_lock_heads(fl);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200263
264 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200266EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500268void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500269{
270 if (fl->fl_ops) {
271 if (fl->fl_ops->fl_release_private)
272 fl->fl_ops->fl_release_private(fl);
273 fl->fl_ops = NULL;
274 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500275
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400276 if (fl->fl_lmops) {
277 if (fl->fl_lmops->lm_put_owner)
278 fl->fl_lmops->lm_put_owner(fl);
279 fl->fl_lmops = NULL;
280 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500281}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500282EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284/* Free a lock which is not in use. */
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400285void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286{
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800287 BUG_ON(waitqueue_active(&fl->fl_wait));
Jeff Layton6dee60f2015-01-16 15:05:54 -0500288 BUG_ON(!list_empty(&fl->fl_list));
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800289 BUG_ON(!list_empty(&fl->fl_block));
Jeff Layton139ca042013-06-21 08:58:17 -0400290 BUG_ON(!hlist_unhashed(&fl->fl_link));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
Trond Myklebust47831f32006-03-20 13:44:05 -0500292 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 kmem_cache_free(filelock_cache, fl);
294}
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400295EXPORT_SYMBOL(locks_free_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
Jeff Laytoned9814d2014-08-11 14:20:31 -0400297static void
298locks_dispose_list(struct list_head *dispose)
299{
300 struct file_lock *fl;
301
302 while (!list_empty(dispose)) {
Jeff Layton6dee60f2015-01-16 15:05:54 -0500303 fl = list_first_entry(dispose, struct file_lock, fl_list);
304 list_del_init(&fl->fl_list);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400305 locks_free_lock(fl);
306 }
307}
308
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309void locks_init_lock(struct file_lock *fl)
310{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200311 memset(fl, 0, sizeof(struct file_lock));
312 locks_init_lock_heads(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313}
314
315EXPORT_SYMBOL(locks_init_lock);
316
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317/*
318 * Initialize a new lock from an existing file_lock structure.
319 */
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400320void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321{
322 new->fl_owner = fl->fl_owner;
323 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500324 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 new->fl_flags = fl->fl_flags;
326 new->fl_type = fl->fl_type;
327 new->fl_start = fl->fl_start;
328 new->fl_end = fl->fl_end;
Kinglong Meef3282962014-08-22 10:18:43 -0400329 new->fl_lmops = fl->fl_lmops;
Trond Myklebust09969052006-03-20 13:44:38 -0500330 new->fl_ops = NULL;
Kinglong Meef3282962014-08-22 10:18:43 -0400331
332 if (fl->fl_lmops) {
333 if (fl->fl_lmops->lm_get_owner)
334 fl->fl_lmops->lm_get_owner(new, fl);
335 }
Trond Myklebust09969052006-03-20 13:44:38 -0500336}
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400337EXPORT_SYMBOL(locks_copy_conflock);
Trond Myklebust09969052006-03-20 13:44:38 -0500338
339void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
340{
Jeff Layton566709b2014-08-11 14:09:35 -0400341 /* "new" must be a freshly-initialized lock */
342 WARN_ON_ONCE(new->fl_ops);
Trond Myklebust09969052006-03-20 13:44:38 -0500343
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400344 locks_copy_conflock(new, fl);
Kinglong Meef3282962014-08-22 10:18:43 -0400345
Trond Myklebust09969052006-03-20 13:44:38 -0500346 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 new->fl_ops = fl->fl_ops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500348
Kinglong Meef3282962014-08-22 10:18:43 -0400349 if (fl->fl_ops) {
350 if (fl->fl_ops->fl_copy_lock)
351 fl->fl_ops->fl_copy_lock(new, fl);
352 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353}
354
355EXPORT_SYMBOL(locks_copy_lock);
356
357static inline int flock_translate_cmd(int cmd) {
358 if (cmd & LOCK_MAND)
359 return cmd & (LOCK_MAND | LOCK_RW);
360 switch (cmd) {
361 case LOCK_SH:
362 return F_RDLCK;
363 case LOCK_EX:
364 return F_WRLCK;
365 case LOCK_UN:
366 return F_UNLCK;
367 }
368 return -EINVAL;
369}
370
371/* Fill in a file_lock structure with an appropriate FLOCK lock. */
Jeff Layton6e129d002014-09-04 10:25:06 -0400372static struct file_lock *
373flock_make_lock(struct file *filp, unsigned int cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374{
375 struct file_lock *fl;
376 int type = flock_translate_cmd(cmd);
Jeff Layton6e129d002014-09-04 10:25:06 -0400377
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 if (type < 0)
Jeff Layton6e129d002014-09-04 10:25:06 -0400379 return ERR_PTR(type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
381 fl = locks_alloc_lock();
382 if (fl == NULL)
Jeff Layton6e129d002014-09-04 10:25:06 -0400383 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
385 fl->fl_file = filp;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +0200386 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 fl->fl_pid = current->tgid;
388 fl->fl_flags = FL_FLOCK;
389 fl->fl_type = type;
390 fl->fl_end = OFFSET_MAX;
391
Jeff Layton6e129d002014-09-04 10:25:06 -0400392 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393}
394
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400395static int assign_type(struct file_lock *fl, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396{
397 switch (type) {
398 case F_RDLCK:
399 case F_WRLCK:
400 case F_UNLCK:
401 fl->fl_type = type;
402 break;
403 default:
404 return -EINVAL;
405 }
406 return 0;
407}
408
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500409static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
410 struct flock64 *l)
411{
412 switch (l->l_whence) {
413 case SEEK_SET:
414 fl->fl_start = 0;
415 break;
416 case SEEK_CUR:
417 fl->fl_start = filp->f_pos;
418 break;
419 case SEEK_END:
420 fl->fl_start = i_size_read(file_inode(filp));
421 break;
422 default:
423 return -EINVAL;
424 }
425 if (l->l_start > OFFSET_MAX - fl->fl_start)
426 return -EOVERFLOW;
427 fl->fl_start += l->l_start;
428 if (fl->fl_start < 0)
429 return -EINVAL;
430
431 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
432 POSIX-2001 defines it. */
433 if (l->l_len > 0) {
434 if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
435 return -EOVERFLOW;
436 fl->fl_end = fl->fl_start + l->l_len - 1;
437
438 } else if (l->l_len < 0) {
439 if (fl->fl_start + l->l_len < 0)
440 return -EINVAL;
441 fl->fl_end = fl->fl_start - 1;
442 fl->fl_start += l->l_len;
443 } else
444 fl->fl_end = OFFSET_MAX;
445
446 fl->fl_owner = current->files;
447 fl->fl_pid = current->tgid;
448 fl->fl_file = filp;
449 fl->fl_flags = FL_POSIX;
450 fl->fl_ops = NULL;
451 fl->fl_lmops = NULL;
452
453 return assign_type(fl, l->l_type);
454}
455
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
457 * style lock.
458 */
459static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
460 struct flock *l)
461{
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500462 struct flock64 ll = {
463 .l_type = l->l_type,
464 .l_whence = l->l_whence,
465 .l_start = l->l_start,
466 .l_len = l->l_len,
467 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500469 return flock64_to_posix_lock(filp, fl, &ll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470}
471
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472/* default lease lock manager operations */
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400473static bool
474lease_break_callback(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475{
476 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400477 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478}
479
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400480static void
481lease_setup(struct file_lock *fl, void **priv)
482{
483 struct file *filp = fl->fl_file;
484 struct fasync_struct *fa = *priv;
485
486 /*
487 * fasync_insert_entry() returns the old entry if any. If there was no
488 * old entry, then it used "priv" and inserted it into the fasync list.
489 * Clear the pointer to indicate that it shouldn't be freed.
490 */
491 if (!fasync_insert_entry(fa->fa_fd, filp, &fl->fl_fasync, fa))
492 *priv = NULL;
493
494 __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
495}
496
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700497static const struct lock_manager_operations lease_manager_ops = {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400498 .lm_break = lease_break_callback,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400499 .lm_change = lease_modify,
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400500 .lm_setup = lease_setup,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501};
502
503/*
504 * Initialize a lease, use the default lock manager operations
505 */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400506static int lease_init(struct file *filp, long type, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 {
Trond Myklebust75dff552006-05-07 23:02:42 -0400508 if (assign_type(fl, type) != 0)
509 return -EINVAL;
510
Jeff Layton7ca76312014-09-01 19:04:48 -0400511 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 fl->fl_pid = current->tgid;
513
514 fl->fl_file = filp;
515 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 fl->fl_start = 0;
517 fl->fl_end = OFFSET_MAX;
518 fl->fl_ops = NULL;
519 fl->fl_lmops = &lease_manager_ops;
520 return 0;
521}
522
523/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400524static struct file_lock *lease_alloc(struct file *filp, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525{
526 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400527 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
529 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500530 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531
532 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400533 if (error) {
534 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500535 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400536 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500537 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538}
539
540/* Check if two locks overlap each other.
541 */
542static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
543{
544 return ((fl1->fl_end >= fl2->fl_start) &&
545 (fl2->fl_end >= fl1->fl_start));
546}
547
548/*
549 * Check whether two locks have the same owner.
550 */
Matt Mackall33443c42006-01-08 01:05:22 -0800551static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552{
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400553 if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 return fl2->fl_lmops == fl1->fl_lmops &&
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400555 fl1->fl_lmops->lm_compare_owner(fl1, fl2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 return fl1->fl_owner == fl2->fl_owner;
557}
558
Jeff Layton7012b022013-06-21 08:58:22 -0400559/* Must be called with the i_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500560static void locks_insert_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400561{
Jeff Layton7012b022013-06-21 08:58:22 -0400562 lg_local_lock(&file_lock_lglock);
563 fl->fl_link_cpu = smp_processor_id();
564 hlist_add_head(&fl->fl_link, this_cpu_ptr(&file_lock_list));
565 lg_local_unlock(&file_lock_lglock);
Jeff Layton88974692013-06-21 08:58:14 -0400566}
567
Jeff Layton7012b022013-06-21 08:58:22 -0400568/* Must be called with the i_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500569static void locks_delete_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400570{
Jeff Layton7012b022013-06-21 08:58:22 -0400571 /*
572 * Avoid taking lock if already unhashed. This is safe since this check
573 * is done while holding the i_lock, and new insertions into the list
574 * also require that it be held.
575 */
576 if (hlist_unhashed(&fl->fl_link))
577 return;
578 lg_local_lock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton139ca042013-06-21 08:58:17 -0400579 hlist_del_init(&fl->fl_link);
Jeff Layton7012b022013-06-21 08:58:22 -0400580 lg_local_unlock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton88974692013-06-21 08:58:14 -0400581}
582
Jeff Layton3999e492013-06-21 08:58:19 -0400583static unsigned long
584posix_owner_key(struct file_lock *fl)
585{
586 if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
587 return fl->fl_lmops->lm_owner_key(fl);
588 return (unsigned long)fl->fl_owner;
589}
590
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500591static void locks_insert_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400592{
Jeff Layton3999e492013-06-21 08:58:19 -0400593 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
Jeff Layton88974692013-06-21 08:58:14 -0400594}
595
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500596static void locks_delete_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400597{
Jeff Layton48f74182013-06-21 08:58:18 -0400598 hash_del(&waiter->fl_link);
Jeff Layton88974692013-06-21 08:58:14 -0400599}
600
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601/* Remove waiter from blocker's block list.
602 * When blocker ends up pointing to itself then the list is empty.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400603 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400604 * Must be called with blocked_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 */
Matt Mackall33443c42006-01-08 01:05:22 -0800606static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607{
Jeff Layton88974692013-06-21 08:58:14 -0400608 locks_delete_global_blocked(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 list_del_init(&waiter->fl_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 waiter->fl_next = NULL;
611}
612
Jeff Layton1a9e64a2013-06-21 08:58:10 -0400613static void locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400615 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 __locks_delete_block(waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400617 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618}
619
620/* Insert waiter into blocker's block list.
621 * We use a circular list so that processes can be easily woken up in
622 * the order they blocked. The documentation doesn't require this but
623 * it seems like the reasonable thing to do.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400624 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400625 * Must be called with both the i_lock and blocked_lock_lock held. The fl_block
Jeff Layton46dad762014-02-03 12:13:06 -0500626 * list itself is protected by the blocked_lock_lock, but by ensuring that the
Jeff Layton7b2296a2013-06-21 08:58:20 -0400627 * i_lock is also held on insertions we can avoid taking the blocked_lock_lock
Jeff Layton4e8c7652013-06-21 08:58:16 -0400628 * in some cases when we see that the fl_block list is empty.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400630static void __locks_insert_block(struct file_lock *blocker,
631 struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632{
J. Bruce Fields6dc0fe82006-03-26 01:37:24 -0800633 BUG_ON(!list_empty(&waiter->fl_block));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 waiter->fl_next = blocker;
Jeff Layton88974692013-06-21 08:58:14 -0400635 list_add_tail(&waiter->fl_block, &blocker->fl_block);
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400636 if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400637 locks_insert_global_blocked(waiter);
638}
639
640/* Must be called with i_lock held. */
641static void locks_insert_block(struct file_lock *blocker,
642 struct file_lock *waiter)
643{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400644 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400645 __locks_insert_block(blocker, waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400646 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647}
648
Jeff Layton1cb36012013-06-21 08:58:12 -0400649/*
650 * Wake up processes blocked waiting for blocker.
651 *
Jeff Layton1c8c6012013-06-21 08:58:15 -0400652 * Must be called with the inode->i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 */
654static void locks_wake_up_blocks(struct file_lock *blocker)
655{
Jeff Layton4e8c7652013-06-21 08:58:16 -0400656 /*
657 * Avoid taking global lock if list is empty. This is safe since new
658 * blocked requests are only added to the list under the i_lock, and
659 * the i_lock is always held here. Note that removal from the fl_block
660 * list does not require the i_lock, so we must recheck list_empty()
Jeff Layton7b2296a2013-06-21 08:58:20 -0400661 * after acquiring the blocked_lock_lock.
Jeff Layton4e8c7652013-06-21 08:58:16 -0400662 */
663 if (list_empty(&blocker->fl_block))
664 return;
665
Jeff Layton7b2296a2013-06-21 08:58:20 -0400666 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 while (!list_empty(&blocker->fl_block)) {
Pavel Emelyanovf0c1cd02007-09-19 16:44:07 +0400668 struct file_lock *waiter;
669
670 waiter = list_first_entry(&blocker->fl_block,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 struct file_lock, fl_block);
672 __locks_delete_block(waiter);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400673 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
674 waiter->fl_lmops->lm_notify(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 else
676 wake_up(&waiter->fl_wait);
677 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400678 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679}
680
681/* Insert file lock fl into an inode's lock list at the position indicated
682 * by pos. At the same time add the lock to the global file lock list.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400683 *
684 * Must be called with the i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 */
686static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
687{
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000688 fl->fl_nspid = get_pid(task_tgid(current));
689
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 /* insert into file's list */
691 fl->fl_next = *pos;
692 *pos = fl;
Jeff Layton88974692013-06-21 08:58:14 -0400693
694 locks_insert_global_locks(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695}
696
Jeff Layton5263e312015-01-16 15:05:55 -0500697static void
698locks_insert_lock_ctx(struct file_lock *fl, struct list_head *before)
699{
700 fl->fl_nspid = get_pid(task_tgid(current));
701 list_add_tail(&fl->fl_list, before);
702 locks_insert_global_locks(fl);
703}
704
Jeff Layton24cbe782014-02-03 12:13:06 -0500705/**
706 * locks_delete_lock - Delete a lock and then free it.
707 * @thisfl_p: pointer that points to the fl_next field of the previous
708 * inode->i_flock list entry
709 *
710 * Unlink a lock from all lists and free the namespace reference, but don't
711 * free it yet. Wake up processes that are blocked waiting for this lock and
712 * notify the FS that the lock has been cleared.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400713 *
714 * Must be called with the i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 */
Jeff Layton24cbe782014-02-03 12:13:06 -0500716static void locks_unlink_lock(struct file_lock **thisfl_p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717{
718 struct file_lock *fl = *thisfl_p;
719
Jeff Layton88974692013-06-21 08:58:14 -0400720 locks_delete_global_locks(fl);
721
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 *thisfl_p = fl->fl_next;
723 fl->fl_next = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000725 if (fl->fl_nspid) {
726 put_pid(fl->fl_nspid);
727 fl->fl_nspid = NULL;
728 }
729
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 locks_wake_up_blocks(fl);
Jeff Layton24cbe782014-02-03 12:13:06 -0500731}
732
733/*
734 * Unlink a lock from all lists and free it.
735 *
736 * Must be called with i_lock held!
737 */
Jeff Laytoned9814d2014-08-11 14:20:31 -0400738static void locks_delete_lock(struct file_lock **thisfl_p,
739 struct list_head *dispose)
Jeff Layton24cbe782014-02-03 12:13:06 -0500740{
741 struct file_lock *fl = *thisfl_p;
742
743 locks_unlink_lock(thisfl_p);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400744 if (dispose)
Jeff Layton6dee60f2015-01-16 15:05:54 -0500745 list_add(&fl->fl_list, dispose);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400746 else
747 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748}
749
Jeff Layton5263e312015-01-16 15:05:55 -0500750static void
751locks_delete_lock_ctx(struct file_lock *fl, struct list_head *dispose)
752{
753 locks_delete_global_locks(fl);
754 if (fl->fl_nspid) {
755 put_pid(fl->fl_nspid);
756 fl->fl_nspid = NULL;
757 }
758 locks_wake_up_blocks(fl);
759 list_move(&fl->fl_list, dispose);
760}
761
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
763 * checks for shared/exclusive status of overlapping locks.
764 */
765static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
766{
767 if (sys_fl->fl_type == F_WRLCK)
768 return 1;
769 if (caller_fl->fl_type == F_WRLCK)
770 return 1;
771 return 0;
772}
773
774/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
775 * checking before calling the locks_conflict().
776 */
777static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
778{
779 /* POSIX locks owned by the same process do not conflict with
780 * each other.
781 */
782 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
783 return (0);
784
785 /* Check whether they overlap */
786 if (!locks_overlap(caller_fl, sys_fl))
787 return 0;
788
789 return (locks_conflict(caller_fl, sys_fl));
790}
791
792/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
793 * checking before calling the locks_conflict().
794 */
795static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
796{
797 /* FLOCK locks referring to the same filp do not conflict with
798 * each other.
799 */
800 if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
801 return (0);
802 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
803 return 0;
804
805 return (locks_conflict(caller_fl, sys_fl));
806}
807
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400808void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500809posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810{
811 struct file_lock *cfl;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400812 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
Jeff Layton1c8c6012013-06-21 08:58:15 -0400814 spin_lock(&inode->i_lock);
Al Viro496ad9a2013-01-23 17:07:38 -0500815 for (cfl = file_inode(filp)->i_flock; cfl; cfl = cfl->fl_next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 if (!IS_POSIX(cfl))
817 continue;
J. Bruce Fieldsb842e242007-05-10 19:02:07 -0400818 if (posix_locks_conflict(fl, cfl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 break;
820 }
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000821 if (cfl) {
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400822 locks_copy_conflock(fl, cfl);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000823 if (cfl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -0800824 fl->fl_pid = pid_vnr(cfl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000825 } else
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400826 fl->fl_type = F_UNLCK;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400827 spin_unlock(&inode->i_lock);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400828 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830EXPORT_SYMBOL(posix_test_lock);
831
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400832/*
833 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400835 * We attempt to detect deadlocks that are due purely to posix file
836 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400838 * We assume that a task can be waiting for at most one lock at a time.
839 * So for any acquired lock, the process holding that lock may be
840 * waiting on at most one other lock. That lock in turns may be held by
841 * someone waiting for at most one other lock. Given a requested lock
842 * caller_fl which is about to wait for a conflicting lock block_fl, we
843 * follow this chain of waiters to ensure we are not about to create a
844 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400845 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400846 * Since we do this before we ever put a process to sleep on a lock, we
847 * are ensured that there is never a cycle; that is what guarantees that
848 * the while() loop in posix_locks_deadlock() eventually completes.
849 *
850 * Note: the above assumption may not be true when handling lock
851 * requests from a broken NFS client. It may also fail in the presence
852 * of tasks (such as posix threads) sharing the same open file table.
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400853 * To handle those cases, we just bail out after a few iterations.
Jeff Layton57b65322014-02-03 12:13:09 -0500854 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400855 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
Jeff Layton57b65322014-02-03 12:13:09 -0500856 * Because the owner is not even nominally tied to a thread of
857 * execution, the deadlock detection below can't reasonably work well. Just
858 * skip it for those.
859 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400860 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
Jeff Layton57b65322014-02-03 12:13:09 -0500861 * locks that just checks for the case where two tasks are attempting to
862 * upgrade from read to write locks on the same inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400864
865#define MAX_DEADLK_ITERATIONS 10
866
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400867/* Find a lock that the owner of the given block_fl is blocking on. */
868static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
869{
870 struct file_lock *fl;
871
Jeff Layton3999e492013-06-21 08:58:19 -0400872 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400873 if (posix_same_owner(fl, block_fl))
874 return fl->fl_next;
875 }
876 return NULL;
877}
878
Jeff Layton7b2296a2013-06-21 08:58:20 -0400879/* Must be called with the blocked_lock_lock held! */
Adrian Bunkb0904e12006-06-23 02:05:13 -0700880static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 struct file_lock *block_fl)
882{
J. Bruce Fields97855b42007-10-30 11:20:02 -0400883 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884
Jeff Layton57b65322014-02-03 12:13:09 -0500885 /*
886 * This deadlock detector can't reasonably detect deadlocks with
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400887 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
Jeff Layton57b65322014-02-03 12:13:09 -0500888 */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400889 if (IS_OFDLCK(caller_fl))
Jeff Layton57b65322014-02-03 12:13:09 -0500890 return 0;
891
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400892 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
893 if (i++ > MAX_DEADLK_ITERATIONS)
894 return 0;
895 if (posix_same_owner(caller_fl, block_fl))
896 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 }
898 return 0;
899}
900
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -0400902 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -0400903 *
904 * Note that if called with an FL_EXISTS argument, the caller may determine
905 * whether or not a lock was successfully freed by testing the return
906 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 */
Trond Myklebust993dfa82006-03-31 02:30:55 -0800908static int flock_lock_file(struct file *filp, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909{
Trond Myklebust993dfa82006-03-31 02:30:55 -0800910 struct file_lock *new_fl = NULL;
Jeff Layton5263e312015-01-16 15:05:55 -0500911 struct file_lock *fl;
912 struct file_lock_context *ctx;
913 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 int error = 0;
Jeff Layton5263e312015-01-16 15:05:55 -0500915 bool found = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -0400916 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917
Jeff Layton5263e312015-01-16 15:05:55 -0500918 ctx = locks_get_lock_context(inode);
919 if (!ctx)
920 return -ENOMEM;
921
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200922 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
923 new_fl = locks_alloc_lock();
924 if (!new_fl)
925 return -ENOMEM;
926 }
927
Jeff Layton1c8c6012013-06-21 08:58:15 -0400928 spin_lock(&inode->i_lock);
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400929 if (request->fl_flags & FL_ACCESS)
930 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +0400931
Jeff Layton5263e312015-01-16 15:05:55 -0500932 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 if (filp != fl->fl_file)
934 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800935 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 goto out;
Jeff Layton5263e312015-01-16 15:05:55 -0500937 found = true;
938 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 break;
940 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941
Trond Myklebustf475ae92006-06-29 16:38:32 -0400942 if (request->fl_type == F_UNLCK) {
943 if ((request->fl_flags & FL_EXISTS) && !found)
944 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800945 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400946 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947
948 /*
949 * If a higher-priority process was blocked on the old file lock,
950 * give it the opportunity to lock the file.
951 */
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200952 if (found) {
Jeff Layton1c8c6012013-06-21 08:58:15 -0400953 spin_unlock(&inode->i_lock);
Frederic Weisbeckerdef01bc2009-07-16 15:44:29 +0200954 cond_resched();
Jeff Layton1c8c6012013-06-21 08:58:15 -0400955 spin_lock(&inode->i_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200956 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400958find_conflict:
Jeff Layton5263e312015-01-16 15:05:55 -0500959 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Trond Myklebust993dfa82006-03-31 02:30:55 -0800960 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 continue;
962 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700963 if (!(request->fl_flags & FL_SLEEP))
964 goto out;
965 error = FILE_LOCK_DEFERRED;
966 locks_insert_block(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 goto out;
968 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400969 if (request->fl_flags & FL_ACCESS)
970 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800971 locks_copy_lock(new_fl, request);
Jeff Layton5263e312015-01-16 15:05:55 -0500972 locks_insert_lock_ctx(new_fl, &ctx->flc_flock);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800973 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +0400974 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975
976out:
Jeff Layton1c8c6012013-06-21 08:58:15 -0400977 spin_unlock(&inode->i_lock);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800978 if (new_fl)
979 locks_free_lock(new_fl);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400980 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 return error;
982}
983
Marc Eshel150b3932007-01-18 16:15:35 -0500984static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985{
986 struct file_lock *fl;
Miklos Szeredi39005d02006-06-23 02:05:10 -0700987 struct file_lock *new_fl = NULL;
988 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 struct file_lock *left = NULL;
990 struct file_lock *right = NULL;
991 struct file_lock **before;
Jeff Laytonb9746ef2013-06-21 08:58:13 -0400992 int error;
993 bool added = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -0400994 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995
996 /*
997 * We may need two file_lock structures for this operation,
998 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -0700999 *
1000 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 */
Miklos Szeredi39005d02006-06-23 02:05:10 -07001002 if (!(request->fl_flags & FL_ACCESS) &&
1003 (request->fl_type != F_UNLCK ||
1004 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
1005 new_fl = locks_alloc_lock();
1006 new_fl2 = locks_alloc_lock();
1007 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008
Jeff Layton1c8c6012013-06-21 08:58:15 -04001009 spin_lock(&inode->i_lock);
Jeff Layton1cb36012013-06-21 08:58:12 -04001010 /*
1011 * New lock request. Walk all POSIX locks and look for conflicts. If
1012 * there are any, either return error or put the request on the
Jeff Layton48f74182013-06-21 08:58:18 -04001013 * blocker's list of waiters and the global blocked_hash.
Jeff Layton1cb36012013-06-21 08:58:12 -04001014 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 if (request->fl_type != F_UNLCK) {
1016 for_each_lock(inode, before) {
J. Bruce Fields526985b2006-11-14 16:54:36 -05001017 fl = *before;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 if (!IS_POSIX(fl))
1019 continue;
1020 if (!posix_locks_conflict(request, fl))
1021 continue;
Andy Adamson5842add2006-03-26 01:37:26 -08001022 if (conflock)
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001023 locks_copy_conflock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 error = -EAGAIN;
1025 if (!(request->fl_flags & FL_SLEEP))
1026 goto out;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001027 /*
1028 * Deadlock detection and insertion into the blocked
1029 * locks list must be done while holding the same lock!
1030 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 error = -EDEADLK;
Jeff Layton7b2296a2013-06-21 08:58:20 -04001032 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001033 if (likely(!posix_locks_deadlock(request, fl))) {
1034 error = FILE_LOCK_DEFERRED;
1035 __locks_insert_block(fl, request);
1036 }
Jeff Layton7b2296a2013-06-21 08:58:20 -04001037 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 goto out;
1039 }
1040 }
1041
1042 /* If we're just looking for a conflict, we're done. */
1043 error = 0;
1044 if (request->fl_flags & FL_ACCESS)
1045 goto out;
1046
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 * Find the first old lock with the same owner as the new lock.
1049 */
1050
1051 before = &inode->i_flock;
1052
1053 /* First skip locks owned by other processes. */
1054 while ((fl = *before) && (!IS_POSIX(fl) ||
1055 !posix_same_owner(request, fl))) {
1056 before = &fl->fl_next;
1057 }
1058
Jeff Layton1cb36012013-06-21 08:58:12 -04001059 /* Process locks with this owner. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 while ((fl = *before) && posix_same_owner(request, fl)) {
1061 /* Detect adjacent or overlapping regions (if same lock type)
1062 */
1063 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -07001064 /* In all comparisons of start vs end, use
1065 * "start - 1" rather than "end + 1". If end
1066 * is OFFSET_MAX, end + 1 will become negative.
1067 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 if (fl->fl_end < request->fl_start - 1)
1069 goto next_lock;
1070 /* If the next lock in the list has entirely bigger
1071 * addresses than the new one, insert the lock here.
1072 */
Olaf Kirch449231d2005-08-25 16:25:35 -07001073 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 break;
1075
1076 /* If we come here, the new and old lock are of the
1077 * same type and adjacent or overlapping. Make one
1078 * lock yielding from the lower start address of both
1079 * locks to the higher end address.
1080 */
1081 if (fl->fl_start > request->fl_start)
1082 fl->fl_start = request->fl_start;
1083 else
1084 request->fl_start = fl->fl_start;
1085 if (fl->fl_end < request->fl_end)
1086 fl->fl_end = request->fl_end;
1087 else
1088 request->fl_end = fl->fl_end;
1089 if (added) {
Jeff Laytoned9814d2014-08-11 14:20:31 -04001090 locks_delete_lock(before, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 continue;
1092 }
1093 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001094 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 }
1096 else {
1097 /* Processing for different lock types is a bit
1098 * more complex.
1099 */
1100 if (fl->fl_end < request->fl_start)
1101 goto next_lock;
1102 if (fl->fl_start > request->fl_end)
1103 break;
1104 if (request->fl_type == F_UNLCK)
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001105 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106 if (fl->fl_start < request->fl_start)
1107 left = fl;
1108 /* If the next lock in the list has a higher end
1109 * address than the new one, insert the new one here.
1110 */
1111 if (fl->fl_end > request->fl_end) {
1112 right = fl;
1113 break;
1114 }
1115 if (fl->fl_start >= request->fl_start) {
1116 /* The new lock completely replaces an old
1117 * one (This may happen several times).
1118 */
1119 if (added) {
Jeff Laytoned9814d2014-08-11 14:20:31 -04001120 locks_delete_lock(before, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 continue;
1122 }
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001123 /*
1124 * Replace the old lock with new_fl, and
1125 * remove the old one. It's safe to do the
1126 * insert here since we know that we won't be
1127 * using new_fl later, and that the lock is
1128 * just replacing an existing lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 */
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001130 error = -ENOLCK;
1131 if (!new_fl)
1132 goto out;
1133 locks_copy_lock(new_fl, request);
1134 request = new_fl;
1135 new_fl = NULL;
Jeff Laytoned9814d2014-08-11 14:20:31 -04001136 locks_delete_lock(before, &dispose);
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001137 locks_insert_lock(before, request);
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001138 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 }
1140 }
1141 /* Go on to next lock.
1142 */
1143 next_lock:
1144 before = &fl->fl_next;
1145 }
1146
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001147 /*
Jeff Layton1cb36012013-06-21 08:58:12 -04001148 * The above code only modifies existing locks in case of merging or
1149 * replacing. If new lock(s) need to be inserted all modifications are
1150 * done below this, so it's safe yet to bail out.
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001151 */
1152 error = -ENOLCK; /* "no luck" */
1153 if (right && left == right && !new_fl2)
1154 goto out;
1155
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 error = 0;
1157 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -04001158 if (request->fl_type == F_UNLCK) {
1159 if (request->fl_flags & FL_EXISTS)
1160 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001162 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001163
1164 if (!new_fl) {
1165 error = -ENOLCK;
1166 goto out;
1167 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 locks_copy_lock(new_fl, request);
1169 locks_insert_lock(before, new_fl);
1170 new_fl = NULL;
1171 }
1172 if (right) {
1173 if (left == right) {
1174 /* The new lock breaks the old one in two pieces,
1175 * so we have to use the second new lock.
1176 */
1177 left = new_fl2;
1178 new_fl2 = NULL;
1179 locks_copy_lock(left, right);
1180 locks_insert_lock(before, left);
1181 }
1182 right->fl_start = request->fl_end + 1;
1183 locks_wake_up_blocks(right);
1184 }
1185 if (left) {
1186 left->fl_end = request->fl_start - 1;
1187 locks_wake_up_blocks(left);
1188 }
1189 out:
Jeff Layton1c8c6012013-06-21 08:58:15 -04001190 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 /*
1192 * Free any unused locks.
1193 */
1194 if (new_fl)
1195 locks_free_lock(new_fl);
1196 if (new_fl2)
1197 locks_free_lock(new_fl2);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001198 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199 return error;
1200}
1201
1202/**
1203 * posix_lock_file - Apply a POSIX-style lock to a file
1204 * @filp: The file to apply the lock to
1205 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001206 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 *
1208 * Add a POSIX style lock to a file.
1209 * We merge adjacent & overlapping locks whenever possible.
1210 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001211 *
1212 * Note that if called with an FL_EXISTS argument, the caller may determine
1213 * whether or not a lock was successfully freed by testing the return
1214 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 */
Marc Eshel150b3932007-01-18 16:15:35 -05001216int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001217 struct file_lock *conflock)
1218{
Al Viro496ad9a2013-01-23 17:07:38 -05001219 return __posix_lock_file(file_inode(filp), fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001220}
Marc Eshel150b3932007-01-18 16:15:35 -05001221EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222
1223/**
1224 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1225 * @filp: The file to apply the lock to
1226 * @fl: The lock to be applied
1227 *
1228 * Add a POSIX style lock to a file.
1229 * We merge adjacent & overlapping locks whenever possible.
1230 * POSIX locks are sorted by owner task, then by starting address
1231 */
1232int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1233{
1234 int error;
1235 might_sleep ();
1236 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001237 error = posix_lock_file(filp, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001238 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239 break;
1240 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1241 if (!error)
1242 continue;
1243
1244 locks_delete_block(fl);
1245 break;
1246 }
1247 return error;
1248}
1249EXPORT_SYMBOL(posix_lock_file_wait);
1250
1251/**
1252 * locks_mandatory_locked - Check for an active lock
Jeff Laytond7a06982014-03-10 09:54:15 -04001253 * @file: the file to check
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 *
1255 * Searches the inode's list of locks to find any POSIX locks which conflict.
1256 * This function is called from locks_verify_locked() only.
1257 */
Jeff Laytond7a06982014-03-10 09:54:15 -04001258int locks_mandatory_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259{
Jeff Laytond7a06982014-03-10 09:54:15 -04001260 struct inode *inode = file_inode(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 struct file_lock *fl;
1262
1263 /*
1264 * Search the lock list for this inode for any POSIX locks.
1265 */
Jeff Layton1c8c6012013-06-21 08:58:15 -04001266 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1268 if (!IS_POSIX(fl))
1269 continue;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001270 if (fl->fl_owner != current->files &&
1271 fl->fl_owner != file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 break;
1273 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04001274 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275 return fl ? -EAGAIN : 0;
1276}
1277
1278/**
1279 * locks_mandatory_area - Check for a conflicting lock
1280 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1281 * for shared
1282 * @inode: the file to check
1283 * @filp: how the file was opened (if it was)
1284 * @offset: start of area to check
1285 * @count: length of area to check
1286 *
1287 * Searches the inode's list of locks to find any POSIX locks which conflict.
1288 * This function is called from rw_verify_area() and
1289 * locks_verify_truncate().
1290 */
1291int locks_mandatory_area(int read_write, struct inode *inode,
1292 struct file *filp, loff_t offset,
1293 size_t count)
1294{
1295 struct file_lock fl;
1296 int error;
Jeff Layton29723ad2014-03-10 09:54:19 -04001297 bool sleep = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298
1299 locks_init_lock(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 fl.fl_pid = current->tgid;
1301 fl.fl_file = filp;
1302 fl.fl_flags = FL_POSIX | FL_ACCESS;
1303 if (filp && !(filp->f_flags & O_NONBLOCK))
Jeff Layton29723ad2014-03-10 09:54:19 -04001304 sleep = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1306 fl.fl_start = offset;
1307 fl.fl_end = offset + count - 1;
1308
1309 for (;;) {
Jeff Layton29723ad2014-03-10 09:54:19 -04001310 if (filp) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001311 fl.fl_owner = filp;
Jeff Layton29723ad2014-03-10 09:54:19 -04001312 fl.fl_flags &= ~FL_SLEEP;
1313 error = __posix_lock_file(inode, &fl, NULL);
1314 if (!error)
1315 break;
1316 }
1317
1318 if (sleep)
1319 fl.fl_flags |= FL_SLEEP;
1320 fl.fl_owner = current->files;
Marc Eshel150b3932007-01-18 16:15:35 -05001321 error = __posix_lock_file(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001322 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 break;
1324 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1325 if (!error) {
1326 /*
1327 * If we've been sleeping someone might have
1328 * changed the permissions behind our back.
1329 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001330 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 continue;
1332 }
1333
1334 locks_delete_block(&fl);
1335 break;
1336 }
1337
1338 return error;
1339}
1340
1341EXPORT_SYMBOL(locks_mandatory_area);
1342
J. Bruce Fields778fc542011-07-26 18:25:49 -04001343static void lease_clear_pending(struct file_lock *fl, int arg)
1344{
1345 switch (arg) {
1346 case F_UNLCK:
1347 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1348 /* fall through: */
1349 case F_RDLCK:
1350 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1351 }
1352}
1353
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354/* We already had a lease on this file; just change its type */
Jeff Laytonc45198e2014-09-01 07:12:07 -04001355int lease_modify(struct file_lock **before, int arg, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356{
1357 struct file_lock *fl = *before;
1358 int error = assign_type(fl, arg);
1359
1360 if (error)
1361 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001362 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001364 if (arg == F_UNLCK) {
1365 struct file *filp = fl->fl_file;
1366
1367 f_delown(filp);
1368 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001369 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1370 if (fl->fl_fasync != NULL) {
1371 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1372 fl->fl_fasync = NULL;
1373 }
Jeff Laytonc45198e2014-09-01 07:12:07 -04001374 locks_delete_lock(before, dispose);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001375 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 return 0;
1377}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378EXPORT_SYMBOL(lease_modify);
1379
J. Bruce Fields778fc542011-07-26 18:25:49 -04001380static bool past_time(unsigned long then)
1381{
1382 if (!then)
1383 /* 0 is a special value meaning "this never expires": */
1384 return false;
1385 return time_after(jiffies, then);
1386}
1387
Jeff Laytonc45198e2014-09-01 07:12:07 -04001388static void time_out_leases(struct inode *inode, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389{
1390 struct file_lock **before;
1391 struct file_lock *fl;
1392
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001393 lockdep_assert_held(&inode->i_lock);
1394
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 before = &inode->i_flock;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04001396 while ((fl = *before) && IS_LEASE(fl) && lease_breaking(fl)) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001397 trace_time_out_leases(inode, fl);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001398 if (past_time(fl->fl_downgrade_time))
Jeff Laytonc45198e2014-09-01 07:12:07 -04001399 lease_modify(before, F_RDLCK, dispose);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001400 if (past_time(fl->fl_break_time))
Jeff Laytonc45198e2014-09-01 07:12:07 -04001401 lease_modify(before, F_UNLCK, dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 if (fl == *before) /* lease_modify may have freed fl */
1403 before = &fl->fl_next;
1404 }
1405}
1406
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001407static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1408{
1409 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1410 return false;
1411 return locks_conflict(breaker, lease);
1412}
1413
Jeff Layton03d12dd2014-09-01 14:53:41 -04001414static bool
1415any_leases_conflict(struct inode *inode, struct file_lock *breaker)
1416{
1417 struct file_lock *fl;
1418
1419 lockdep_assert_held(&inode->i_lock);
1420
1421 for (fl = inode->i_flock ; fl && IS_LEASE(fl); fl = fl->fl_next) {
1422 if (leases_conflict(fl, breaker))
1423 return true;
1424 }
1425 return false;
1426}
1427
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428/**
1429 * __break_lease - revoke all outstanding leases on file
1430 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001431 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1432 * break all leases
1433 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1434 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 *
david m. richter87250dd2007-05-09 16:10:27 -04001436 * break_lease (inlined for speed) has checked there already is at least
1437 * some kind of lock (maybe a lease) on this file. Leases are broken on
1438 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 * specified %O_NONBLOCK to your open().
1440 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001441int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001443 int error = 0;
Jeff Layton03d12dd2014-09-01 14:53:41 -04001444 struct file_lock *new_fl;
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001445 struct file_lock *fl, **before;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 unsigned long break_time;
Al Viro8737c932009-12-24 06:47:55 -05001447 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001448 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449
Al Viro8737c932009-12-24 06:47:55 -05001450 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001451 if (IS_ERR(new_fl))
1452 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001453 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454
Jeff Layton1c8c6012013-06-21 08:58:15 -04001455 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456
Jeff Laytonc45198e2014-09-01 07:12:07 -04001457 time_out_leases(inode, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458
Jeff Layton03d12dd2014-09-01 14:53:41 -04001459 if (!any_leases_conflict(inode, new_fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001460 goto out;
1461
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 break_time = 0;
1463 if (lease_break_time > 0) {
1464 break_time = jiffies + lease_break_time * HZ;
1465 if (break_time == 0)
1466 break_time++; /* so that 0 means no break time */
1467 }
1468
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001469 for (before = &inode->i_flock;
1470 ((fl = *before) != NULL) && IS_LEASE(fl);
1471 before = &fl->fl_next) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001472 if (!leases_conflict(fl, new_fl))
1473 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001474 if (want_write) {
1475 if (fl->fl_flags & FL_UNLOCK_PENDING)
1476 continue;
1477 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001479 } else {
Jeff Layton03d12dd2014-09-01 14:53:41 -04001480 if (lease_breaking(inode->i_flock))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001481 continue;
1482 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1483 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 }
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001485 if (fl->fl_lmops->lm_break(fl))
1486 locks_delete_lock(before, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487 }
1488
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001489 fl = inode->i_flock;
1490 if (!fl || !IS_LEASE(fl))
1491 goto out;
1492
Jeff Layton843c6b22014-09-01 14:27:43 -04001493 if (mode & O_NONBLOCK) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001494 trace_break_lease_noblock(inode, new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495 error = -EWOULDBLOCK;
1496 goto out;
1497 }
1498
1499restart:
Jeff Layton03d12dd2014-09-01 14:53:41 -04001500 break_time = inode->i_flock->fl_break_time;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001501 if (break_time != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 break_time -= jiffies;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001503 if (break_time == 0)
1504 break_time++;
Jeff Layton03d12dd2014-09-01 14:53:41 -04001505 locks_insert_block(inode->i_flock, new_fl);
Jeff Layton62af4f12014-05-09 14:13:05 -04001506 trace_break_lease_block(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001507 spin_unlock(&inode->i_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001508 locks_dispose_list(&dispose);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001509 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1510 !new_fl->fl_next, break_time);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001511 spin_lock(&inode->i_lock);
Jeff Layton62af4f12014-05-09 14:13:05 -04001512 trace_break_lease_unblock(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001513 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 if (error >= 0) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001515 /*
1516 * Wait for the next conflicting lease that has not been
1517 * broken yet
1518 */
Jeff Layton03d12dd2014-09-01 14:53:41 -04001519 if (error == 0)
1520 time_out_leases(inode, &dispose);
1521 if (any_leases_conflict(inode, new_fl))
1522 goto restart;
1523
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 error = 0;
1525 }
1526
1527out:
Jeff Layton1c8c6012013-06-21 08:58:15 -04001528 spin_unlock(&inode->i_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001529 locks_dispose_list(&dispose);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001530 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531 return error;
1532}
1533
1534EXPORT_SYMBOL(__break_lease);
1535
1536/**
Randy Dunlapa6b91912008-03-19 17:01:00 -07001537 * lease_get_mtime - get the last modified time of an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538 * @inode: the inode
1539 * @time: pointer to a timespec which will contain the last modified time
1540 *
1541 * This is to force NFS clients to flush their caches for files with
1542 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001543 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 */
1545void lease_get_mtime(struct inode *inode, struct timespec *time)
1546{
Jeff Laytonbfe86022014-08-22 10:18:44 -04001547 bool has_lease = false;
1548 struct file_lock *flock;
1549
1550 if (inode->i_flock) {
1551 spin_lock(&inode->i_lock);
1552 flock = inode->i_flock;
1553 if (flock && IS_LEASE(flock) && (flock->fl_type == F_WRLCK))
1554 has_lease = true;
1555 spin_unlock(&inode->i_lock);
1556 }
1557
1558 if (has_lease)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 *time = current_fs_time(inode->i_sb);
1560 else
1561 *time = inode->i_mtime;
1562}
1563
1564EXPORT_SYMBOL(lease_get_mtime);
1565
1566/**
1567 * fcntl_getlease - Enquire what lease is currently active
1568 * @filp: the file
1569 *
1570 * The value returned by this function will be one of
1571 * (if no lease break is pending):
1572 *
1573 * %F_RDLCK to indicate a shared lease is held.
1574 *
1575 * %F_WRLCK to indicate an exclusive lease is held.
1576 *
1577 * %F_UNLCK to indicate no lease is held.
1578 *
1579 * (if a lease break is pending):
1580 *
1581 * %F_RDLCK to indicate an exclusive lease needs to be
1582 * changed to a shared lease (or removed).
1583 *
1584 * %F_UNLCK to indicate the lease needs to be removed.
1585 *
1586 * XXX: sfr & willy disagree over whether F_INPROGRESS
1587 * should be returned to userspace.
1588 */
1589int fcntl_getlease(struct file *filp)
1590{
1591 struct file_lock *fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001592 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 int type = F_UNLCK;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001594 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595
Jeff Layton1c8c6012013-06-21 08:58:15 -04001596 spin_lock(&inode->i_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001597 time_out_leases(file_inode(filp), &dispose);
Al Viro496ad9a2013-01-23 17:07:38 -05001598 for (fl = file_inode(filp)->i_flock; fl && IS_LEASE(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 fl = fl->fl_next) {
1600 if (fl->fl_file == filp) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001601 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 break;
1603 }
1604 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04001605 spin_unlock(&inode->i_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001606 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 return type;
1608}
1609
Jeff Layton24cbe782014-02-03 12:13:06 -05001610/**
1611 * check_conflicting_open - see if the given dentry points to a file that has
1612 * an existing open that would conflict with the
1613 * desired lease.
1614 * @dentry: dentry to check
1615 * @arg: type of lease that we're trying to acquire
1616 *
1617 * Check to see if there's an existing open fd on this file that would
1618 * conflict with the lease we're trying to set.
1619 */
1620static int
1621check_conflicting_open(const struct dentry *dentry, const long arg)
1622{
1623 int ret = 0;
1624 struct inode *inode = dentry->d_inode;
1625
1626 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1627 return -EAGAIN;
1628
1629 if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1630 (atomic_read(&inode->i_count) > 1)))
1631 ret = -EAGAIN;
1632
1633 return ret;
1634}
1635
Jeff Laytone6f5c782014-08-22 10:40:25 -04001636static int
1637generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638{
KAMBAROV, ZAUR7eaae282005-07-07 17:57:06 -07001639 struct file_lock *fl, **before, **my_before = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001640 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 struct inode *inode = dentry->d_inode;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001642 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001643 int error;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001644 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645
J. Bruce Fields096657b2010-10-30 17:31:14 -04001646 lease = *flp;
Jeff Layton62af4f12014-05-09 14:13:05 -04001647 trace_generic_add_lease(inode, lease);
1648
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001649 /*
1650 * In the delegation case we need mutual exclusion with
1651 * a number of operations that take the i_mutex. We trylock
1652 * because delegations are an optional optimization, and if
1653 * there's some chance of a conflict--we'd rather not
1654 * bother, maybe that's a sign this just isn't a good file to
1655 * hand out a delegation on.
1656 */
1657 if (is_deleg && !mutex_trylock(&inode->i_mutex))
1658 return -EAGAIN;
1659
1660 if (is_deleg && arg == F_WRLCK) {
1661 /* Write delegations are not currently supported: */
Dan Carpenter4fdb7932013-11-13 10:56:27 +03001662 mutex_unlock(&inode->i_mutex);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001663 WARN_ON_ONCE(1);
1664 return -EINVAL;
1665 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001666
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001667 spin_lock(&inode->i_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001668 time_out_leases(inode, &dispose);
Jeff Layton24cbe782014-02-03 12:13:06 -05001669 error = check_conflicting_open(dentry, arg);
1670 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001671 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001672
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 /*
1674 * At this point, we know that if there is an exclusive
1675 * lease on this file, then we hold it on this filp
1676 * (otherwise our open of this file would have blocked).
1677 * And if we are trying to acquire an exclusive lease,
1678 * then the file is not open by anyone (including us)
1679 * except for this filp.
1680 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001681 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 for (before = &inode->i_flock;
1683 ((fl = *before) != NULL) && IS_LEASE(fl);
1684 before = &fl->fl_next) {
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001685 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 my_before = before;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001687 continue;
1688 }
1689 /*
1690 * No exclusive leases if someone else has a lease on
1691 * this file:
1692 */
1693 if (arg == F_WRLCK)
1694 goto out;
1695 /*
1696 * Modifying our existing lease is OK, but no getting a
1697 * new lease if someone else is opening for write:
1698 */
1699 if (fl->fl_flags & FL_UNLOCK_PENDING)
1700 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 }
1702
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 if (my_before != NULL) {
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001704 lease = *my_before;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001705 error = lease->fl_lmops->lm_change(my_before, arg, &dispose);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001706 if (error)
1707 goto out;
1708 goto out_setup;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709 }
1710
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711 error = -EINVAL;
1712 if (!leases_enable)
1713 goto out;
1714
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001715 locks_insert_lock(before, lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001716 /*
1717 * The check in break_lease() is lockless. It's possible for another
1718 * open to race in after we did the earlier check for a conflicting
1719 * open but before the lease was inserted. Check again for a
1720 * conflicting open and cancel the lease if there is one.
1721 *
1722 * We also add a barrier here to ensure that the insertion of the lock
1723 * precedes these checks.
1724 */
1725 smp_mb();
1726 error = check_conflicting_open(dentry, arg);
1727 if (error)
Jeff Laytone6f5c782014-08-22 10:40:25 -04001728 goto out_unlink;
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001729
1730out_setup:
1731 if (lease->fl_lmops->lm_setup)
1732 lease->fl_lmops->lm_setup(lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733out:
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001734 spin_unlock(&inode->i_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001735 locks_dispose_list(&dispose);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001736 if (is_deleg)
1737 mutex_unlock(&inode->i_mutex);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001738 if (!error && !my_before)
1739 *flp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 return error;
Jeff Laytone6f5c782014-08-22 10:40:25 -04001741out_unlink:
1742 locks_unlink_lock(before);
1743 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001745
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001746static int generic_delete_lease(struct file *filp)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001747{
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001748 int error = -EAGAIN;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001749 struct file_lock *fl, **before;
1750 struct dentry *dentry = filp->f_path.dentry;
1751 struct inode *inode = dentry->d_inode;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001752 LIST_HEAD(dispose);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001753
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001754 spin_lock(&inode->i_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001755 time_out_leases(inode, &dispose);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001756 for (before = &inode->i_flock;
1757 ((fl = *before) != NULL) && IS_LEASE(fl);
1758 before = &fl->fl_next) {
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001759 if (fl->fl_file == filp)
1760 break;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001761 }
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001762 trace_generic_delete_lease(inode, fl);
NeilBrown52d304e2015-01-13 15:17:43 +13001763 if (fl && IS_LEASE(fl))
Jeff Laytonc45198e2014-09-01 07:12:07 -04001764 error = fl->fl_lmops->lm_change(before, F_UNLCK, &dispose);
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001765 spin_unlock(&inode->i_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001766 locks_dispose_list(&dispose);
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001767 return error;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001768}
1769
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770/**
1771 * generic_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001772 * @filp: file pointer
1773 * @arg: type of lease to obtain
1774 * @flp: input - file_lock to use, output - file_lock inserted
1775 * @priv: private data for lm_setup (may be NULL if lm_setup
1776 * doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777 *
1778 * The (input) flp->fl_lmops->lm_break function is required
1779 * by break_lease().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001781int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
1782 void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 struct dentry *dentry = filp->f_path.dentry;
1785 struct inode *inode = dentry->d_inode;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001786 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001788 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001789 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001791 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 error = security_file_lock(filp, arg);
1793 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001794 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001796 switch (arg) {
1797 case F_UNLCK:
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001798 return generic_delete_lease(filp);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001799 case F_RDLCK:
1800 case F_WRLCK:
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001801 if (!(*flp)->fl_lmops->lm_break) {
1802 WARN_ON_ONCE(1);
1803 return -ENOLCK;
1804 }
Jeff Laytone6f5c782014-08-22 10:40:25 -04001805 return generic_add_lease(filp, arg, flp, priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001806 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001807 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001810EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001812/**
Jeff Laytone51673a2014-08-22 18:13:28 -04001813 * vfs_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001814 * @filp: file pointer
1815 * @arg: type of lease to obtain
1816 * @lease: file_lock to use when adding a lease
1817 * @priv: private info for lm_setup when adding a lease (may be
1818 * NULL if lm_setup doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 *
Jeff Laytone51673a2014-08-22 18:13:28 -04001820 * Call this to establish a lease on the file. The "lease" argument is not
1821 * used for F_UNLCK requests and may be NULL. For commands that set or alter
1822 * an existing lease, the (*lease)->fl_lmops->lm_break operation must be set;
1823 * if not, this function will return -ENOLCK (and generate a scary-looking
1824 * stack trace).
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001825 *
1826 * The "priv" pointer is passed directly to the lm_setup function as-is. It
1827 * may be NULL if the lm_setup operation doesn't require it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001829int
1830vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831{
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001832 if (filp->f_op->setlease)
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001833 return filp->f_op->setlease(filp, arg, lease, priv);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001834 else
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001835 return generic_setlease(filp, arg, lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001837EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001839static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840{
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001841 struct file_lock *fl;
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001842 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 int error;
1844
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001845 fl = lease_alloc(filp, arg);
1846 if (IS_ERR(fl))
1847 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001849 new = fasync_alloc();
1850 if (!new) {
1851 locks_free_lock(fl);
1852 return -ENOMEM;
1853 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001854 new->fa_fd = fd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001856 error = vfs_setlease(filp, arg, &fl, (void **)&new);
Jeff Layton2dfb9282014-08-11 18:14:12 -04001857 if (fl)
1858 locks_free_lock(fl);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001859 if (new)
1860 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861 return error;
1862}
1863
1864/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001865 * fcntl_setlease - sets a lease on an open file
1866 * @fd: open file descriptor
1867 * @filp: file pointer
1868 * @arg: type of lease to obtain
1869 *
1870 * Call this fcntl to establish a lease on the file.
1871 * Note that you also need to call %F_SETSIG to
1872 * receive a signal when the lease is broken.
1873 */
1874int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1875{
1876 if (arg == F_UNLCK)
Jeff Laytone6f5c782014-08-22 10:40:25 -04001877 return vfs_setlease(filp, F_UNLCK, NULL, NULL);
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001878 return do_fcntl_add_lease(fd, filp, arg);
1879}
1880
1881/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1883 * @filp: The file to apply the lock to
1884 * @fl: The lock to be applied
1885 *
1886 * Add a FLOCK style lock to a file.
1887 */
1888int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1889{
1890 int error;
1891 might_sleep();
1892 for (;;) {
1893 error = flock_lock_file(filp, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001894 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895 break;
1896 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1897 if (!error)
1898 continue;
1899
1900 locks_delete_block(fl);
1901 break;
1902 }
1903 return error;
1904}
1905
1906EXPORT_SYMBOL(flock_lock_file_wait);
1907
1908/**
1909 * sys_flock: - flock() system call.
1910 * @fd: the file descriptor to lock.
1911 * @cmd: the type of lock to apply.
1912 *
1913 * Apply a %FL_FLOCK style lock to an open file descriptor.
1914 * The @cmd can be one of
1915 *
1916 * %LOCK_SH -- a shared lock.
1917 *
1918 * %LOCK_EX -- an exclusive lock.
1919 *
1920 * %LOCK_UN -- remove an existing lock.
1921 *
1922 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1923 *
1924 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1925 * processes read and write access respectively.
1926 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001927SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928{
Al Viro2903ff02012-08-28 12:52:22 -04001929 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930 struct file_lock *lock;
1931 int can_sleep, unlock;
1932 int error;
1933
1934 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001935 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 goto out;
1937
1938 can_sleep = !(cmd & LOCK_NB);
1939 cmd &= ~LOCK_NB;
1940 unlock = (cmd == LOCK_UN);
1941
Al Viroaeb5d722008-09-02 15:28:45 -04001942 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04001943 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 goto out_putf;
1945
Jeff Layton6e129d002014-09-04 10:25:06 -04001946 lock = flock_make_lock(f.file, cmd);
1947 if (IS_ERR(lock)) {
1948 error = PTR_ERR(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 goto out_putf;
Jeff Layton6e129d002014-09-04 10:25:06 -04001950 }
1951
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 if (can_sleep)
1953 lock->fl_flags |= FL_SLEEP;
1954
Al Viro2903ff02012-08-28 12:52:22 -04001955 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 if (error)
1957 goto out_free;
1958
Al Viro72c2d532013-09-22 16:27:52 -04001959 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04001960 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 (can_sleep) ? F_SETLKW : F_SETLK,
1962 lock);
1963 else
Al Viro2903ff02012-08-28 12:52:22 -04001964 error = flock_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965
1966 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08001967 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968
1969 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04001970 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 out:
1972 return error;
1973}
1974
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001975/**
1976 * vfs_test_lock - test file byte range lock
1977 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04001978 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001979 *
1980 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1981 * setting conf->fl_type to something other than F_UNLCK.
1982 */
1983int vfs_test_lock(struct file *filp, struct file_lock *fl)
1984{
Al Viro72c2d532013-09-22 16:27:52 -04001985 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001986 return filp->f_op->lock(filp, F_GETLK, fl);
1987 posix_test_lock(filp, fl);
1988 return 0;
1989}
1990EXPORT_SYMBOL_GPL(vfs_test_lock);
1991
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001992static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1993{
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001994 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001995#if BITS_PER_LONG == 32
1996 /*
1997 * Make sure we can represent the posix lock via
1998 * legacy 32bit flock.
1999 */
2000 if (fl->fl_start > OFFT_OFFSET_MAX)
2001 return -EOVERFLOW;
2002 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
2003 return -EOVERFLOW;
2004#endif
2005 flock->l_start = fl->fl_start;
2006 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2007 fl->fl_end - fl->fl_start + 1;
2008 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04002009 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002010 return 0;
2011}
2012
2013#if BITS_PER_LONG == 32
2014static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
2015{
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002016 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002017 flock->l_start = fl->fl_start;
2018 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2019 fl->fl_end - fl->fl_start + 1;
2020 flock->l_whence = 0;
2021 flock->l_type = fl->fl_type;
2022}
2023#endif
2024
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025/* Report the first existing lock that would conflict with l.
2026 * This implements the F_GETLK command of fcntl().
2027 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05002028int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002030 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031 struct flock flock;
2032 int error;
2033
2034 error = -EFAULT;
2035 if (copy_from_user(&flock, l, sizeof(flock)))
2036 goto out;
2037 error = -EINVAL;
2038 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2039 goto out;
2040
2041 error = flock_to_posix_lock(filp, &file_lock, &flock);
2042 if (error)
2043 goto out;
2044
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002045 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002046 error = -EINVAL;
2047 if (flock.l_pid != 0)
2048 goto out;
2049
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002050 cmd = F_GETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002051 file_lock.fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002052 file_lock.fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002053 }
2054
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002055 error = vfs_test_lock(filp, &file_lock);
2056 if (error)
2057 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002059 flock.l_type = file_lock.fl_type;
2060 if (file_lock.fl_type != F_UNLCK) {
2061 error = posix_lock_to_flock(&flock, &file_lock);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002062 if (error)
Kinglong Meef3282962014-08-22 10:18:43 -04002063 goto rel_priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 }
2065 error = -EFAULT;
2066 if (!copy_to_user(l, &flock, sizeof(flock)))
2067 error = 0;
Kinglong Meef3282962014-08-22 10:18:43 -04002068rel_priv:
2069 locks_release_private(&file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070out:
2071 return error;
2072}
2073
Marc Eshel7723ec92007-01-18 15:08:55 -05002074/**
2075 * vfs_lock_file - file byte range lock
2076 * @filp: The file to apply the lock to
2077 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2078 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05002079 * @conf: Place to return a copy of the conflicting lock, if found.
2080 *
2081 * A caller that doesn't care about the conflicting lock may pass NULL
2082 * as the final argument.
2083 *
2084 * If the filesystem defines a private ->lock() method, then @conf will
2085 * be left unchanged; so a caller that cares should initialize it to
2086 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05002087 *
2088 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2089 * locks, the ->lock() interface may return asynchronously, before the lock has
2090 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002091 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05002092 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2093 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002094 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05002095 * request completes.
2096 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07002097 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2098 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05002099 * nonzero return code and the file system should release the lock. The file
2100 * system is also responsible to keep a corresponding posix lock when it
2101 * grants a lock so the VFS can find out which locks are locally held and do
2102 * the correct lock cleanup when required.
2103 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002104 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05002105 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05002106 */
Marc Eshel150b3932007-01-18 16:15:35 -05002107int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05002108{
Al Viro72c2d532013-09-22 16:27:52 -04002109 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05002110 return filp->f_op->lock(filp, cmd, fl);
2111 else
Marc Eshel150b3932007-01-18 16:15:35 -05002112 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05002113}
2114EXPORT_SYMBOL_GPL(vfs_lock_file);
2115
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002116static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2117 struct file_lock *fl)
2118{
2119 int error;
2120
2121 error = security_file_lock(filp, fl->fl_type);
2122 if (error)
2123 return error;
2124
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002125 for (;;) {
2126 error = vfs_lock_file(filp, cmd, fl, NULL);
2127 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002128 break;
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002129 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
2130 if (!error)
2131 continue;
2132
2133 locks_delete_block(fl);
2134 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002135 }
2136
2137 return error;
2138}
2139
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002140/* Ensure that fl->fl_filp has compatible f_mode for F_SETLK calls */
2141static int
2142check_fmode_for_setlk(struct file_lock *fl)
2143{
2144 switch (fl->fl_type) {
2145 case F_RDLCK:
2146 if (!(fl->fl_file->f_mode & FMODE_READ))
2147 return -EBADF;
2148 break;
2149 case F_WRLCK:
2150 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2151 return -EBADF;
2152 }
2153 return 0;
2154}
2155
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156/* Apply the lock described by l to an open file descriptor.
2157 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2158 */
Peter Staubachc2936212005-07-27 11:45:09 -07002159int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
2160 struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161{
2162 struct file_lock *file_lock = locks_alloc_lock();
2163 struct flock flock;
2164 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002165 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 int error;
2167
2168 if (file_lock == NULL)
2169 return -ENOLCK;
2170
2171 /*
2172 * This might block, so we do it before checking the inode.
2173 */
2174 error = -EFAULT;
2175 if (copy_from_user(&flock, l, sizeof(flock)))
2176 goto out;
2177
Al Viro496ad9a2013-01-23 17:07:38 -05002178 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179
2180 /* Don't allow mandatory locks on files that may be memory mapped
2181 * and shared.
2182 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002183 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 error = -EAGAIN;
2185 goto out;
2186 }
2187
Peter Staubachc2936212005-07-27 11:45:09 -07002188again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 error = flock_to_posix_lock(filp, file_lock, &flock);
2190 if (error)
2191 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002192
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002193 error = check_fmode_for_setlk(file_lock);
2194 if (error)
2195 goto out;
2196
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002197 /*
2198 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002199 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002200 */
2201 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002202 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002203 error = -EINVAL;
2204 if (flock.l_pid != 0)
2205 goto out;
2206
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002207 cmd = F_SETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002208 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002209 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002210 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002211 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002212 error = -EINVAL;
2213 if (flock.l_pid != 0)
2214 goto out;
2215
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002216 cmd = F_SETLKW;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002217 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002218 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002219 /* Fallthrough */
2220 case F_SETLKW:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 file_lock->fl_flags |= FL_SLEEP;
2222 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002223
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002224 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225
Peter Staubachc2936212005-07-27 11:45:09 -07002226 /*
2227 * Attempt to detect a close/fcntl race and recover by
2228 * releasing the lock that was just acquired.
2229 */
Al Viro0b2bac22008-05-06 13:58:34 -04002230 /*
2231 * we need that spin_lock here - it prevents reordering between
2232 * update of inode->i_flock and check for it done in close().
2233 * rcu_read_lock() wouldn't do.
2234 */
2235 spin_lock(&current->files->file_lock);
2236 f = fcheck(fd);
2237 spin_unlock(&current->files->file_lock);
2238 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002239 flock.l_type = F_UNLCK;
2240 goto again;
2241 }
2242
2243out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244 locks_free_lock(file_lock);
2245 return error;
2246}
2247
2248#if BITS_PER_LONG == 32
2249/* Report the first existing lock that would conflict with l.
2250 * This implements the F_GETLK command of fcntl().
2251 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05002252int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002254 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255 struct flock64 flock;
2256 int error;
2257
2258 error = -EFAULT;
2259 if (copy_from_user(&flock, l, sizeof(flock)))
2260 goto out;
2261 error = -EINVAL;
2262 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2263 goto out;
2264
2265 error = flock64_to_posix_lock(filp, &file_lock, &flock);
2266 if (error)
2267 goto out;
2268
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002269 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002270 error = -EINVAL;
2271 if (flock.l_pid != 0)
2272 goto out;
2273
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002274 cmd = F_GETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002275 file_lock.fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002276 file_lock.fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002277 }
2278
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002279 error = vfs_test_lock(filp, &file_lock);
2280 if (error)
2281 goto out;
2282
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002283 flock.l_type = file_lock.fl_type;
2284 if (file_lock.fl_type != F_UNLCK)
2285 posix_lock_to_flock64(&flock, &file_lock);
2286
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 error = -EFAULT;
2288 if (!copy_to_user(l, &flock, sizeof(flock)))
2289 error = 0;
Kinglong Meef3282962014-08-22 10:18:43 -04002290
2291 locks_release_private(&file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292out:
2293 return error;
2294}
2295
2296/* Apply the lock described by l to an open file descriptor.
2297 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2298 */
Peter Staubachc2936212005-07-27 11:45:09 -07002299int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2300 struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301{
2302 struct file_lock *file_lock = locks_alloc_lock();
2303 struct flock64 flock;
2304 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002305 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 int error;
2307
2308 if (file_lock == NULL)
2309 return -ENOLCK;
2310
2311 /*
2312 * This might block, so we do it before checking the inode.
2313 */
2314 error = -EFAULT;
2315 if (copy_from_user(&flock, l, sizeof(flock)))
2316 goto out;
2317
Al Viro496ad9a2013-01-23 17:07:38 -05002318 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319
2320 /* Don't allow mandatory locks on files that may be memory mapped
2321 * and shared.
2322 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002323 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 error = -EAGAIN;
2325 goto out;
2326 }
2327
Peter Staubachc2936212005-07-27 11:45:09 -07002328again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 error = flock64_to_posix_lock(filp, file_lock, &flock);
2330 if (error)
2331 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002332
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002333 error = check_fmode_for_setlk(file_lock);
2334 if (error)
2335 goto out;
2336
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002337 /*
2338 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002339 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002340 */
2341 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002342 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002343 error = -EINVAL;
2344 if (flock.l_pid != 0)
2345 goto out;
2346
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002347 cmd = F_SETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002348 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002349 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002350 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002351 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002352 error = -EINVAL;
2353 if (flock.l_pid != 0)
2354 goto out;
2355
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002356 cmd = F_SETLKW64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002357 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002358 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002359 /* Fallthrough */
2360 case F_SETLKW64:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361 file_lock->fl_flags |= FL_SLEEP;
2362 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002363
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002364 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365
Peter Staubachc2936212005-07-27 11:45:09 -07002366 /*
2367 * Attempt to detect a close/fcntl race and recover by
2368 * releasing the lock that was just acquired.
2369 */
Al Viro0b2bac22008-05-06 13:58:34 -04002370 spin_lock(&current->files->file_lock);
2371 f = fcheck(fd);
2372 spin_unlock(&current->files->file_lock);
2373 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002374 flock.l_type = F_UNLCK;
2375 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376 }
2377
2378out:
2379 locks_free_lock(file_lock);
2380 return error;
2381}
2382#endif /* BITS_PER_LONG == 32 */
2383
2384/*
2385 * This function is called when the file is being removed
2386 * from the task's fd array. POSIX locks belonging to this task
2387 * are deleted at this time.
2388 */
2389void locks_remove_posix(struct file *filp, fl_owner_t owner)
2390{
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002391 struct file_lock lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392
2393 /*
2394 * If there are no locks held on this file, we don't need to call
2395 * posix_lock_file(). Another process could be setting a lock on this
2396 * file at the same time, but we wouldn't remove that lock anyway.
2397 */
Al Viro496ad9a2013-01-23 17:07:38 -05002398 if (!file_inode(filp)->i_flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399 return;
2400
2401 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002402 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403 lock.fl_start = 0;
2404 lock.fl_end = OFFSET_MAX;
2405 lock.fl_owner = owner;
2406 lock.fl_pid = current->tgid;
2407 lock.fl_file = filp;
2408 lock.fl_ops = NULL;
2409 lock.fl_lmops = NULL;
2410
Marc Eshel150b3932007-01-18 16:15:35 -05002411 vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002412
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2414 lock.fl_ops->fl_release_private(&lock);
2415}
2416
2417EXPORT_SYMBOL(locks_remove_posix);
2418
Jeff Laytondd459bb2015-01-16 15:05:54 -05002419static void
2420locks_remove_flock(struct file *filp)
2421{
2422 struct file_lock fl = {
2423 .fl_owner = filp,
2424 .fl_pid = current->tgid,
2425 .fl_file = filp,
2426 .fl_flags = FL_FLOCK,
2427 .fl_type = F_UNLCK,
2428 .fl_end = OFFSET_MAX,
2429 };
Jeff Layton5263e312015-01-16 15:05:55 -05002430 struct file_lock_context *flctx = file_inode(filp)->i_flctx;
Jeff Laytondd459bb2015-01-16 15:05:54 -05002431
Jeff Layton5263e312015-01-16 15:05:55 -05002432 if (!flctx || list_empty(&flctx->flc_flock))
Jeff Laytondd459bb2015-01-16 15:05:54 -05002433 return;
2434
2435 if (filp->f_op->flock)
2436 filp->f_op->flock(filp, F_SETLKW, &fl);
2437 else
2438 flock_lock_file(filp, &fl);
2439
2440 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2441 fl.fl_ops->fl_release_private(&fl);
2442}
2443
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444/*
2445 * This function is called on the last close of an open file.
2446 */
Jeff Layton78ed8a12014-02-03 12:13:08 -05002447void locks_remove_file(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448{
Al Viro496ad9a2013-01-23 17:07:38 -05002449 struct inode * inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450 struct file_lock *fl;
2451 struct file_lock **before;
Jeff Laytoned9814d2014-08-11 14:20:31 -04002452 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453
Jeff Laytondd459bb2015-01-16 15:05:54 -05002454 /* remove any OFD locks */
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002455 locks_remove_posix(filp, filp);
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002456
Jeff Laytondd459bb2015-01-16 15:05:54 -05002457 /* remove flock locks */
2458 locks_remove_flock(filp);
2459
2460 if (!inode->i_flock)
2461 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462
Jeff Layton1c8c6012013-06-21 08:58:15 -04002463 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464 before = &inode->i_flock;
2465
2466 while ((fl = *before) != NULL) {
2467 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468 if (IS_LEASE(fl)) {
Jeff Laytonc45198e2014-09-01 07:12:07 -04002469 lease_modify(before, F_UNLCK, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470 continue;
2471 }
Jeff Layton8c3cac52014-02-03 12:13:07 -05002472
2473 /*
2474 * There's a leftover lock on the list of a type that
2475 * we didn't expect to see. Most likely a classic
2476 * POSIX lock that ended up not getting released
2477 * properly, or that raced onto the list somehow. Log
2478 * some info about it and then just remove it from
2479 * the list.
2480 */
Jeff Laytondd459bb2015-01-16 15:05:54 -05002481 WARN(1, "leftover lock: dev=%u:%u ino=%lu type=%hhd flags=0x%x start=%lld end=%lld\n",
Jeff Layton8c3cac52014-02-03 12:13:07 -05002482 MAJOR(inode->i_sb->s_dev),
2483 MINOR(inode->i_sb->s_dev), inode->i_ino,
2484 fl->fl_type, fl->fl_flags,
2485 fl->fl_start, fl->fl_end);
2486
Jeff Laytoned9814d2014-08-11 14:20:31 -04002487 locks_delete_lock(before, &dispose);
Jeff Layton8c3cac52014-02-03 12:13:07 -05002488 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489 }
2490 before = &fl->fl_next;
2491 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002492 spin_unlock(&inode->i_lock);
Jeff Laytoned9814d2014-08-11 14:20:31 -04002493 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494}
2495
2496/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497 * posix_unblock_lock - stop waiting for a file lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07002498 * @waiter: the lock which was waiting
2499 *
2500 * lockd needs to block waiting for locks.
2501 */
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002502int
Jeff Laytonf891a292013-06-21 08:58:09 -04002503posix_unblock_lock(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504{
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002505 int status = 0;
2506
Jeff Layton7b2296a2013-06-21 08:58:20 -04002507 spin_lock(&blocked_lock_lock);
J. Bruce Fields5996a292006-01-03 09:55:44 +01002508 if (waiter->fl_next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509 __locks_delete_block(waiter);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002510 else
2511 status = -ENOENT;
Jeff Layton7b2296a2013-06-21 08:58:20 -04002512 spin_unlock(&blocked_lock_lock);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002513 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515EXPORT_SYMBOL(posix_unblock_lock);
2516
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002517/**
2518 * vfs_cancel_lock - file byte range unblock lock
2519 * @filp: The file to apply the unblock to
2520 * @fl: The lock to be unblocked
2521 *
2522 * Used by lock managers to cancel blocked requests
2523 */
2524int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2525{
Al Viro72c2d532013-09-22 16:27:52 -04002526 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002527 return filp->f_op->lock(filp, F_CANCELLK, fl);
2528 return 0;
2529}
2530
2531EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2532
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002533#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002534#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002535#include <linux/seq_file.h>
2536
Jeff Layton7012b022013-06-21 08:58:22 -04002537struct locks_iterator {
2538 int li_cpu;
2539 loff_t li_pos;
2540};
2541
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002542static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002543 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544{
2545 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002546 unsigned int fl_pid;
2547
2548 if (fl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -08002549 fl_pid = pid_vnr(fl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002550 else
2551 fl_pid = fl->fl_pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002552
2553 if (fl->fl_file != NULL)
Al Viro496ad9a2013-01-23 17:07:38 -05002554 inode = file_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555
Jerome Marchand99dc8292010-10-26 14:22:33 -07002556 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557 if (IS_POSIX(fl)) {
Jeff Laytonc918d422014-02-03 12:13:09 -05002558 if (fl->fl_flags & FL_ACCESS)
Fabian Frederick5315c262014-05-09 14:13:05 -04002559 seq_puts(f, "ACCESS");
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002560 else if (IS_OFDLCK(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002561 seq_puts(f, "OFDLCK");
Jeff Laytonc918d422014-02-03 12:13:09 -05002562 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002563 seq_puts(f, "POSIX ");
Jeff Laytonc918d422014-02-03 12:13:09 -05002564
2565 seq_printf(f, " %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002567 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568 } else if (IS_FLOCK(fl)) {
2569 if (fl->fl_type & LOCK_MAND) {
Fabian Frederick5315c262014-05-09 14:13:05 -04002570 seq_puts(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002571 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002572 seq_puts(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573 }
2574 } else if (IS_LEASE(fl)) {
Jeff Layton8144f1f2014-08-11 13:36:54 -04002575 if (fl->fl_flags & FL_DELEG)
2576 seq_puts(f, "DELEG ");
2577 else
2578 seq_puts(f, "LEASE ");
2579
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002580 if (lease_breaking(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002581 seq_puts(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582 else if (fl->fl_file)
Fabian Frederick5315c262014-05-09 14:13:05 -04002583 seq_puts(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002584 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002585 seq_puts(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002586 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002587 seq_puts(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588 }
2589 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002590 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591 (fl->fl_type & LOCK_READ)
2592 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2593 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2594 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002595 seq_printf(f, "%s ",
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002596 (lease_breaking(fl))
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04002597 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2598 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002599 }
2600 if (inode) {
2601#ifdef WE_CAN_BREAK_LSLK_NOW
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002602 seq_printf(f, "%d %s:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 inode->i_sb->s_id, inode->i_ino);
2604#else
2605 /* userspace relies on this representation of dev_t ;-( */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002606 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607 MAJOR(inode->i_sb->s_dev),
2608 MINOR(inode->i_sb->s_dev), inode->i_ino);
2609#endif
2610 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002611 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612 }
2613 if (IS_POSIX(fl)) {
2614 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002615 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002616 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002617 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002618 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002619 seq_puts(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620 }
2621}
2622
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002623static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002624{
Jeff Layton7012b022013-06-21 08:58:22 -04002625 struct locks_iterator *iter = f->private;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002626 struct file_lock *fl, *bfl;
2627
Jeff Layton139ca042013-06-21 08:58:17 -04002628 fl = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002629
Jeff Layton7012b022013-06-21 08:58:22 -04002630 lock_get_status(f, fl, iter->li_pos, "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002631
2632 list_for_each_entry(bfl, &fl->fl_block, fl_block)
Jeff Layton7012b022013-06-21 08:58:22 -04002633 lock_get_status(f, bfl, iter->li_pos, " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002634
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002635 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636}
2637
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002638static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002639 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640{
Jeff Layton7012b022013-06-21 08:58:22 -04002641 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002642
Jeff Layton7012b022013-06-21 08:58:22 -04002643 iter->li_pos = *pos + 1;
2644 lg_global_lock(&file_lock_lglock);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002645 spin_lock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002646 return seq_hlist_start_percpu(&file_lock_list, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647}
2648
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002649static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2650{
Jeff Layton7012b022013-06-21 08:58:22 -04002651 struct locks_iterator *iter = f->private;
2652
2653 ++iter->li_pos;
2654 return seq_hlist_next_percpu(v, &file_lock_list, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002655}
2656
2657static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002658 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002659{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002660 spin_unlock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002661 lg_global_unlock(&file_lock_lglock);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002662}
2663
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002664static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002665 .start = locks_start,
2666 .next = locks_next,
2667 .stop = locks_stop,
2668 .show = locks_show,
2669};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002670
2671static int locks_open(struct inode *inode, struct file *filp)
2672{
Jeff Layton7012b022013-06-21 08:58:22 -04002673 return seq_open_private(filp, &locks_seq_operations,
2674 sizeof(struct locks_iterator));
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002675}
2676
2677static const struct file_operations proc_locks_operations = {
2678 .open = locks_open,
2679 .read = seq_read,
2680 .llseek = seq_lseek,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002681 .release = seq_release_private,
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002682};
2683
2684static int __init proc_locks_init(void)
2685{
2686 proc_create("locks", 0, NULL, &proc_locks_operations);
2687 return 0;
2688}
2689module_init(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002690#endif
2691
Linus Torvalds1da177e2005-04-16 15:20:36 -07002692static int __init filelock_init(void)
2693{
Jeff Layton7012b022013-06-21 08:58:22 -04002694 int i;
2695
Jeff Layton4a075e32015-01-16 15:05:54 -05002696 flctx_cache = kmem_cache_create("file_lock_ctx",
2697 sizeof(struct file_lock_context), 0, SLAB_PANIC, NULL);
2698
Linus Torvalds1da177e2005-04-16 15:20:36 -07002699 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002700 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2701
Jeff Layton7012b022013-06-21 08:58:22 -04002702 lg_lock_init(&file_lock_lglock, "file_lock_lglock");
2703
2704 for_each_possible_cpu(i)
2705 INIT_HLIST_HEAD(per_cpu_ptr(&file_lock_list, i));
2706
Linus Torvalds1da177e2005-04-16 15:20:36 -07002707 return 0;
2708}
2709
2710core_initcall(filelock_init);