blob: 5e83f3a993775517039e1ad0af596335bac9ccc0 [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
Christoph Lametere18b8902006-12-06 20:33:20 -0800205static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Miklos Szerediee19cc42011-07-07 13:06:09 +0200207static void locks_init_lock_heads(struct file_lock *fl)
Miklos Szeredia51cb912011-07-06 12:33:55 +0200208{
Jeff Layton139ca042013-06-21 08:58:17 -0400209 INIT_HLIST_NODE(&fl->fl_link);
Miklos Szerediee19cc42011-07-07 13:06:09 +0200210 INIT_LIST_HEAD(&fl->fl_block);
211 init_waitqueue_head(&fl->fl_wait);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200212}
213
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200215struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200217 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200218
219 if (fl)
Miklos Szerediee19cc42011-07-07 13:06:09 +0200220 locks_init_lock_heads(fl);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200221
222 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200224EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500226void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500227{
228 if (fl->fl_ops) {
229 if (fl->fl_ops->fl_release_private)
230 fl->fl_ops->fl_release_private(fl);
231 fl->fl_ops = NULL;
232 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500233
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400234 if (fl->fl_lmops) {
235 if (fl->fl_lmops->lm_put_owner)
236 fl->fl_lmops->lm_put_owner(fl);
237 fl->fl_lmops = NULL;
238 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500239}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500240EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500241
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242/* Free a lock which is not in use. */
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400243void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244{
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800245 BUG_ON(waitqueue_active(&fl->fl_wait));
246 BUG_ON(!list_empty(&fl->fl_block));
Jeff Layton139ca042013-06-21 08:58:17 -0400247 BUG_ON(!hlist_unhashed(&fl->fl_link));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
Trond Myklebust47831f32006-03-20 13:44:05 -0500249 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 kmem_cache_free(filelock_cache, fl);
251}
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400252EXPORT_SYMBOL(locks_free_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253
Jeff Laytoned9814d2014-08-11 14:20:31 -0400254static void
255locks_dispose_list(struct list_head *dispose)
256{
257 struct file_lock *fl;
258
259 while (!list_empty(dispose)) {
260 fl = list_first_entry(dispose, struct file_lock, fl_block);
261 list_del_init(&fl->fl_block);
262 locks_free_lock(fl);
263 }
264}
265
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266void locks_init_lock(struct file_lock *fl)
267{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200268 memset(fl, 0, sizeof(struct file_lock));
269 locks_init_lock_heads(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270}
271
272EXPORT_SYMBOL(locks_init_lock);
273
Trond Myklebust47831f32006-03-20 13:44:05 -0500274static void locks_copy_private(struct file_lock *new, struct file_lock *fl)
275{
276 if (fl->fl_ops) {
277 if (fl->fl_ops->fl_copy_lock)
278 fl->fl_ops->fl_copy_lock(new, fl);
279 new->fl_ops = fl->fl_ops;
280 }
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400281
282 if (fl->fl_lmops) {
283 if (fl->fl_lmops->lm_get_owner)
284 fl->fl_lmops->lm_get_owner(new, fl);
Trond Myklebust47831f32006-03-20 13:44:05 -0500285 new->fl_lmops = fl->fl_lmops;
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400286 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500287}
288
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289/*
290 * Initialize a new lock from an existing file_lock structure.
291 */
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400292void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293{
294 new->fl_owner = fl->fl_owner;
295 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500296 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 new->fl_flags = fl->fl_flags;
298 new->fl_type = fl->fl_type;
299 new->fl_start = fl->fl_start;
300 new->fl_end = fl->fl_end;
Trond Myklebust09969052006-03-20 13:44:38 -0500301 new->fl_ops = NULL;
302 new->fl_lmops = NULL;
303}
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400304EXPORT_SYMBOL(locks_copy_conflock);
Trond Myklebust09969052006-03-20 13:44:38 -0500305
306void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
307{
Jeff Layton566709b2014-08-11 14:09:35 -0400308 /* "new" must be a freshly-initialized lock */
309 WARN_ON_ONCE(new->fl_ops);
Trond Myklebust09969052006-03-20 13:44:38 -0500310
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400311 locks_copy_conflock(new, fl);
Trond Myklebust09969052006-03-20 13:44:38 -0500312 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 new->fl_ops = fl->fl_ops;
314 new->fl_lmops = fl->fl_lmops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500315
316 locks_copy_private(new, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317}
318
319EXPORT_SYMBOL(locks_copy_lock);
320
321static inline int flock_translate_cmd(int cmd) {
322 if (cmd & LOCK_MAND)
323 return cmd & (LOCK_MAND | LOCK_RW);
324 switch (cmd) {
325 case LOCK_SH:
326 return F_RDLCK;
327 case LOCK_EX:
328 return F_WRLCK;
329 case LOCK_UN:
330 return F_UNLCK;
331 }
332 return -EINVAL;
333}
334
335/* Fill in a file_lock structure with an appropriate FLOCK lock. */
336static int flock_make_lock(struct file *filp, struct file_lock **lock,
337 unsigned int cmd)
338{
339 struct file_lock *fl;
340 int type = flock_translate_cmd(cmd);
341 if (type < 0)
342 return type;
343
344 fl = locks_alloc_lock();
345 if (fl == NULL)
346 return -ENOMEM;
347
348 fl->fl_file = filp;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +0200349 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 fl->fl_pid = current->tgid;
351 fl->fl_flags = FL_FLOCK;
352 fl->fl_type = type;
353 fl->fl_end = OFFSET_MAX;
354
355 *lock = fl;
356 return 0;
357}
358
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400359static int assign_type(struct file_lock *fl, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360{
361 switch (type) {
362 case F_RDLCK:
363 case F_WRLCK:
364 case F_UNLCK:
365 fl->fl_type = type;
366 break;
367 default:
368 return -EINVAL;
369 }
370 return 0;
371}
372
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500373static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
374 struct flock64 *l)
375{
376 switch (l->l_whence) {
377 case SEEK_SET:
378 fl->fl_start = 0;
379 break;
380 case SEEK_CUR:
381 fl->fl_start = filp->f_pos;
382 break;
383 case SEEK_END:
384 fl->fl_start = i_size_read(file_inode(filp));
385 break;
386 default:
387 return -EINVAL;
388 }
389 if (l->l_start > OFFSET_MAX - fl->fl_start)
390 return -EOVERFLOW;
391 fl->fl_start += l->l_start;
392 if (fl->fl_start < 0)
393 return -EINVAL;
394
395 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
396 POSIX-2001 defines it. */
397 if (l->l_len > 0) {
398 if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
399 return -EOVERFLOW;
400 fl->fl_end = fl->fl_start + l->l_len - 1;
401
402 } else if (l->l_len < 0) {
403 if (fl->fl_start + l->l_len < 0)
404 return -EINVAL;
405 fl->fl_end = fl->fl_start - 1;
406 fl->fl_start += l->l_len;
407 } else
408 fl->fl_end = OFFSET_MAX;
409
410 fl->fl_owner = current->files;
411 fl->fl_pid = current->tgid;
412 fl->fl_file = filp;
413 fl->fl_flags = FL_POSIX;
414 fl->fl_ops = NULL;
415 fl->fl_lmops = NULL;
416
417 return assign_type(fl, l->l_type);
418}
419
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
421 * style lock.
422 */
423static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
424 struct flock *l)
425{
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500426 struct flock64 ll = {
427 .l_type = l->l_type,
428 .l_whence = l->l_whence,
429 .l_start = l->l_start,
430 .l_len = l->l_len,
431 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500433 return flock64_to_posix_lock(filp, fl, &ll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434}
435
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436/* default lease lock manager operations */
437static void lease_break_callback(struct file_lock *fl)
438{
439 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
440}
441
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700442static const struct lock_manager_operations lease_manager_ops = {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400443 .lm_break = lease_break_callback,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400444 .lm_change = lease_modify,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445};
446
447/*
448 * Initialize a lease, use the default lock manager operations
449 */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400450static int lease_init(struct file *filp, long type, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 {
Trond Myklebust75dff552006-05-07 23:02:42 -0400452 if (assign_type(fl, type) != 0)
453 return -EINVAL;
454
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +0200455 fl->fl_owner = current->files;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 fl->fl_pid = current->tgid;
457
458 fl->fl_file = filp;
459 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 fl->fl_start = 0;
461 fl->fl_end = OFFSET_MAX;
462 fl->fl_ops = NULL;
463 fl->fl_lmops = &lease_manager_ops;
464 return 0;
465}
466
467/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400468static struct file_lock *lease_alloc(struct file *filp, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469{
470 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400471 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
473 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500474 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
476 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400477 if (error) {
478 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500479 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400480 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500481 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482}
483
484/* Check if two locks overlap each other.
485 */
486static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
487{
488 return ((fl1->fl_end >= fl2->fl_start) &&
489 (fl2->fl_end >= fl1->fl_start));
490}
491
492/*
493 * Check whether two locks have the same owner.
494 */
Matt Mackall33443c42006-01-08 01:05:22 -0800495static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496{
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400497 if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 return fl2->fl_lmops == fl1->fl_lmops &&
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400499 fl1->fl_lmops->lm_compare_owner(fl1, fl2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 return fl1->fl_owner == fl2->fl_owner;
501}
502
Jeff Layton7012b022013-06-21 08:58:22 -0400503/* Must be called with the i_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500504static void locks_insert_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400505{
Jeff Layton7012b022013-06-21 08:58:22 -0400506 lg_local_lock(&file_lock_lglock);
507 fl->fl_link_cpu = smp_processor_id();
508 hlist_add_head(&fl->fl_link, this_cpu_ptr(&file_lock_list));
509 lg_local_unlock(&file_lock_lglock);
Jeff Layton88974692013-06-21 08:58:14 -0400510}
511
Jeff Layton7012b022013-06-21 08:58:22 -0400512/* Must be called with the i_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500513static void locks_delete_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400514{
Jeff Layton7012b022013-06-21 08:58:22 -0400515 /*
516 * Avoid taking lock if already unhashed. This is safe since this check
517 * is done while holding the i_lock, and new insertions into the list
518 * also require that it be held.
519 */
520 if (hlist_unhashed(&fl->fl_link))
521 return;
522 lg_local_lock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton139ca042013-06-21 08:58:17 -0400523 hlist_del_init(&fl->fl_link);
Jeff Layton7012b022013-06-21 08:58:22 -0400524 lg_local_unlock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton88974692013-06-21 08:58:14 -0400525}
526
Jeff Layton3999e492013-06-21 08:58:19 -0400527static unsigned long
528posix_owner_key(struct file_lock *fl)
529{
530 if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
531 return fl->fl_lmops->lm_owner_key(fl);
532 return (unsigned long)fl->fl_owner;
533}
534
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500535static void locks_insert_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400536{
Jeff Layton3999e492013-06-21 08:58:19 -0400537 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
Jeff Layton88974692013-06-21 08:58:14 -0400538}
539
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500540static void locks_delete_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400541{
Jeff Layton48f74182013-06-21 08:58:18 -0400542 hash_del(&waiter->fl_link);
Jeff Layton88974692013-06-21 08:58:14 -0400543}
544
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545/* Remove waiter from blocker's block list.
546 * When blocker ends up pointing to itself then the list is empty.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400547 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400548 * Must be called with blocked_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 */
Matt Mackall33443c42006-01-08 01:05:22 -0800550static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551{
Jeff Layton88974692013-06-21 08:58:14 -0400552 locks_delete_global_blocked(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 list_del_init(&waiter->fl_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 waiter->fl_next = NULL;
555}
556
Jeff Layton1a9e64a2013-06-21 08:58:10 -0400557static void locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400559 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 __locks_delete_block(waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400561 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562}
563
564/* Insert waiter into blocker's block list.
565 * We use a circular list so that processes can be easily woken up in
566 * the order they blocked. The documentation doesn't require this but
567 * it seems like the reasonable thing to do.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400568 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400569 * Must be called with both the i_lock and blocked_lock_lock held. The fl_block
Jeff Layton46dad762014-02-03 12:13:06 -0500570 * list itself is protected by the blocked_lock_lock, but by ensuring that the
Jeff Layton7b2296a2013-06-21 08:58:20 -0400571 * i_lock is also held on insertions we can avoid taking the blocked_lock_lock
Jeff Layton4e8c7652013-06-21 08:58:16 -0400572 * in some cases when we see that the fl_block list is empty.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400574static void __locks_insert_block(struct file_lock *blocker,
575 struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576{
J. Bruce Fields6dc0fe82006-03-26 01:37:24 -0800577 BUG_ON(!list_empty(&waiter->fl_block));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 waiter->fl_next = blocker;
Jeff Layton88974692013-06-21 08:58:14 -0400579 list_add_tail(&waiter->fl_block, &blocker->fl_block);
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400580 if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400581 locks_insert_global_blocked(waiter);
582}
583
584/* Must be called with i_lock held. */
585static void locks_insert_block(struct file_lock *blocker,
586 struct file_lock *waiter)
587{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400588 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400589 __locks_insert_block(blocker, waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400590 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591}
592
Jeff Layton1cb36012013-06-21 08:58:12 -0400593/*
594 * Wake up processes blocked waiting for blocker.
595 *
Jeff Layton1c8c6012013-06-21 08:58:15 -0400596 * Must be called with the inode->i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 */
598static void locks_wake_up_blocks(struct file_lock *blocker)
599{
Jeff Layton4e8c7652013-06-21 08:58:16 -0400600 /*
601 * Avoid taking global lock if list is empty. This is safe since new
602 * blocked requests are only added to the list under the i_lock, and
603 * the i_lock is always held here. Note that removal from the fl_block
604 * list does not require the i_lock, so we must recheck list_empty()
Jeff Layton7b2296a2013-06-21 08:58:20 -0400605 * after acquiring the blocked_lock_lock.
Jeff Layton4e8c7652013-06-21 08:58:16 -0400606 */
607 if (list_empty(&blocker->fl_block))
608 return;
609
Jeff Layton7b2296a2013-06-21 08:58:20 -0400610 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 while (!list_empty(&blocker->fl_block)) {
Pavel Emelyanovf0c1cd02007-09-19 16:44:07 +0400612 struct file_lock *waiter;
613
614 waiter = list_first_entry(&blocker->fl_block,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 struct file_lock, fl_block);
616 __locks_delete_block(waiter);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400617 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
618 waiter->fl_lmops->lm_notify(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 else
620 wake_up(&waiter->fl_wait);
621 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400622 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623}
624
625/* Insert file lock fl into an inode's lock list at the position indicated
626 * by pos. At the same time add the lock to the global file lock list.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400627 *
628 * Must be called with the i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 */
630static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
631{
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000632 fl->fl_nspid = get_pid(task_tgid(current));
633
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 /* insert into file's list */
635 fl->fl_next = *pos;
636 *pos = fl;
Jeff Layton88974692013-06-21 08:58:14 -0400637
638 locks_insert_global_locks(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639}
640
Jeff Layton24cbe782014-02-03 12:13:06 -0500641/**
642 * locks_delete_lock - Delete a lock and then free it.
643 * @thisfl_p: pointer that points to the fl_next field of the previous
644 * inode->i_flock list entry
645 *
646 * Unlink a lock from all lists and free the namespace reference, but don't
647 * free it yet. Wake up processes that are blocked waiting for this lock and
648 * notify the FS that the lock has been cleared.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400649 *
650 * Must be called with the i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 */
Jeff Layton24cbe782014-02-03 12:13:06 -0500652static void locks_unlink_lock(struct file_lock **thisfl_p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653{
654 struct file_lock *fl = *thisfl_p;
655
Jeff Layton88974692013-06-21 08:58:14 -0400656 locks_delete_global_locks(fl);
657
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 *thisfl_p = fl->fl_next;
659 fl->fl_next = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000661 if (fl->fl_nspid) {
662 put_pid(fl->fl_nspid);
663 fl->fl_nspid = NULL;
664 }
665
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 locks_wake_up_blocks(fl);
Jeff Layton24cbe782014-02-03 12:13:06 -0500667}
668
669/*
670 * Unlink a lock from all lists and free it.
671 *
672 * Must be called with i_lock held!
673 */
Jeff Laytoned9814d2014-08-11 14:20:31 -0400674static void locks_delete_lock(struct file_lock **thisfl_p,
675 struct list_head *dispose)
Jeff Layton24cbe782014-02-03 12:13:06 -0500676{
677 struct file_lock *fl = *thisfl_p;
678
679 locks_unlink_lock(thisfl_p);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400680 if (dispose)
681 list_add(&fl->fl_block, dispose);
682 else
683 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684}
685
686/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
687 * checks for shared/exclusive status of overlapping locks.
688 */
689static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
690{
691 if (sys_fl->fl_type == F_WRLCK)
692 return 1;
693 if (caller_fl->fl_type == F_WRLCK)
694 return 1;
695 return 0;
696}
697
698/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
699 * checking before calling the locks_conflict().
700 */
701static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
702{
703 /* POSIX locks owned by the same process do not conflict with
704 * each other.
705 */
706 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
707 return (0);
708
709 /* Check whether they overlap */
710 if (!locks_overlap(caller_fl, sys_fl))
711 return 0;
712
713 return (locks_conflict(caller_fl, sys_fl));
714}
715
716/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
717 * checking before calling the locks_conflict().
718 */
719static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
720{
721 /* FLOCK locks referring to the same filp do not conflict with
722 * each other.
723 */
724 if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
725 return (0);
726 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
727 return 0;
728
729 return (locks_conflict(caller_fl, sys_fl));
730}
731
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400732void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500733posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734{
735 struct file_lock *cfl;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400736 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
Jeff Layton1c8c6012013-06-21 08:58:15 -0400738 spin_lock(&inode->i_lock);
Al Viro496ad9a2013-01-23 17:07:38 -0500739 for (cfl = file_inode(filp)->i_flock; cfl; cfl = cfl->fl_next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 if (!IS_POSIX(cfl))
741 continue;
J. Bruce Fieldsb842e242007-05-10 19:02:07 -0400742 if (posix_locks_conflict(fl, cfl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 break;
744 }
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000745 if (cfl) {
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400746 locks_copy_conflock(fl, cfl);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000747 if (cfl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -0800748 fl->fl_pid = pid_vnr(cfl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000749 } else
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400750 fl->fl_type = F_UNLCK;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400751 spin_unlock(&inode->i_lock);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400752 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754EXPORT_SYMBOL(posix_test_lock);
755
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400756/*
757 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400759 * We attempt to detect deadlocks that are due purely to posix file
760 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400762 * We assume that a task can be waiting for at most one lock at a time.
763 * So for any acquired lock, the process holding that lock may be
764 * waiting on at most one other lock. That lock in turns may be held by
765 * someone waiting for at most one other lock. Given a requested lock
766 * caller_fl which is about to wait for a conflicting lock block_fl, we
767 * follow this chain of waiters to ensure we are not about to create a
768 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400769 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400770 * Since we do this before we ever put a process to sleep on a lock, we
771 * are ensured that there is never a cycle; that is what guarantees that
772 * the while() loop in posix_locks_deadlock() eventually completes.
773 *
774 * Note: the above assumption may not be true when handling lock
775 * requests from a broken NFS client. It may also fail in the presence
776 * of tasks (such as posix threads) sharing the same open file table.
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400777 * To handle those cases, we just bail out after a few iterations.
Jeff Layton57b65322014-02-03 12:13:09 -0500778 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400779 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
Jeff Layton57b65322014-02-03 12:13:09 -0500780 * Because the owner is not even nominally tied to a thread of
781 * execution, the deadlock detection below can't reasonably work well. Just
782 * skip it for those.
783 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400784 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
Jeff Layton57b65322014-02-03 12:13:09 -0500785 * locks that just checks for the case where two tasks are attempting to
786 * upgrade from read to write locks on the same inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400788
789#define MAX_DEADLK_ITERATIONS 10
790
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400791/* Find a lock that the owner of the given block_fl is blocking on. */
792static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
793{
794 struct file_lock *fl;
795
Jeff Layton3999e492013-06-21 08:58:19 -0400796 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400797 if (posix_same_owner(fl, block_fl))
798 return fl->fl_next;
799 }
800 return NULL;
801}
802
Jeff Layton7b2296a2013-06-21 08:58:20 -0400803/* Must be called with the blocked_lock_lock held! */
Adrian Bunkb0904e12006-06-23 02:05:13 -0700804static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 struct file_lock *block_fl)
806{
J. Bruce Fields97855b42007-10-30 11:20:02 -0400807 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808
Jeff Layton57b65322014-02-03 12:13:09 -0500809 /*
810 * This deadlock detector can't reasonably detect deadlocks with
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400811 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
Jeff Layton57b65322014-02-03 12:13:09 -0500812 */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400813 if (IS_OFDLCK(caller_fl))
Jeff Layton57b65322014-02-03 12:13:09 -0500814 return 0;
815
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400816 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
817 if (i++ > MAX_DEADLK_ITERATIONS)
818 return 0;
819 if (posix_same_owner(caller_fl, block_fl))
820 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 }
822 return 0;
823}
824
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -0400826 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -0400827 *
828 * Note that if called with an FL_EXISTS argument, the caller may determine
829 * whether or not a lock was successfully freed by testing the return
830 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 */
Trond Myklebust993dfa82006-03-31 02:30:55 -0800832static int flock_lock_file(struct file *filp, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833{
Trond Myklebust993dfa82006-03-31 02:30:55 -0800834 struct file_lock *new_fl = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 struct file_lock **before;
Al Viro496ad9a2013-01-23 17:07:38 -0500836 struct inode * inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 int error = 0;
838 int found = 0;
Jeff Laytoned9814d2014-08-11 14:20:31 -0400839 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200841 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
842 new_fl = locks_alloc_lock();
843 if (!new_fl)
844 return -ENOMEM;
845 }
846
Jeff Layton1c8c6012013-06-21 08:58:15 -0400847 spin_lock(&inode->i_lock);
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400848 if (request->fl_flags & FL_ACCESS)
849 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +0400850
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 for_each_lock(inode, before) {
852 struct file_lock *fl = *before;
853 if (IS_POSIX(fl))
854 break;
855 if (IS_LEASE(fl))
856 continue;
857 if (filp != fl->fl_file)
858 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800859 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 goto out;
861 found = 1;
Jeff Laytoned9814d2014-08-11 14:20:31 -0400862 locks_delete_lock(before, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 break;
864 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865
Trond Myklebustf475ae92006-06-29 16:38:32 -0400866 if (request->fl_type == F_UNLCK) {
867 if ((request->fl_flags & FL_EXISTS) && !found)
868 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800869 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400870 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871
872 /*
873 * If a higher-priority process was blocked on the old file lock,
874 * give it the opportunity to lock the file.
875 */
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200876 if (found) {
Jeff Layton1c8c6012013-06-21 08:58:15 -0400877 spin_unlock(&inode->i_lock);
Frederic Weisbeckerdef01bc2009-07-16 15:44:29 +0200878 cond_resched();
Jeff Layton1c8c6012013-06-21 08:58:15 -0400879 spin_lock(&inode->i_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200880 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400882find_conflict:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 for_each_lock(inode, before) {
884 struct file_lock *fl = *before;
885 if (IS_POSIX(fl))
886 break;
887 if (IS_LEASE(fl))
888 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800889 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 continue;
891 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700892 if (!(request->fl_flags & FL_SLEEP))
893 goto out;
894 error = FILE_LOCK_DEFERRED;
895 locks_insert_block(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 goto out;
897 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400898 if (request->fl_flags & FL_ACCESS)
899 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800900 locks_copy_lock(new_fl, request);
Pavel Emelyanov0e2f6db2007-09-11 15:24:01 -0700901 locks_insert_lock(before, new_fl);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800902 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +0400903 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
905out:
Jeff Layton1c8c6012013-06-21 08:58:15 -0400906 spin_unlock(&inode->i_lock);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800907 if (new_fl)
908 locks_free_lock(new_fl);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400909 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 return error;
911}
912
Marc Eshel150b3932007-01-18 16:15:35 -0500913static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914{
915 struct file_lock *fl;
Miklos Szeredi39005d02006-06-23 02:05:10 -0700916 struct file_lock *new_fl = NULL;
917 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 struct file_lock *left = NULL;
919 struct file_lock *right = NULL;
920 struct file_lock **before;
Jeff Laytonb9746ef2013-06-21 08:58:13 -0400921 int error;
922 bool added = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -0400923 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924
925 /*
926 * We may need two file_lock structures for this operation,
927 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -0700928 *
929 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 */
Miklos Szeredi39005d02006-06-23 02:05:10 -0700931 if (!(request->fl_flags & FL_ACCESS) &&
932 (request->fl_type != F_UNLCK ||
933 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
934 new_fl = locks_alloc_lock();
935 new_fl2 = locks_alloc_lock();
936 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937
Jeff Layton1c8c6012013-06-21 08:58:15 -0400938 spin_lock(&inode->i_lock);
Jeff Layton1cb36012013-06-21 08:58:12 -0400939 /*
940 * New lock request. Walk all POSIX locks and look for conflicts. If
941 * there are any, either return error or put the request on the
Jeff Layton48f74182013-06-21 08:58:18 -0400942 * blocker's list of waiters and the global blocked_hash.
Jeff Layton1cb36012013-06-21 08:58:12 -0400943 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 if (request->fl_type != F_UNLCK) {
945 for_each_lock(inode, before) {
J. Bruce Fields526985b2006-11-14 16:54:36 -0500946 fl = *before;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 if (!IS_POSIX(fl))
948 continue;
949 if (!posix_locks_conflict(request, fl))
950 continue;
Andy Adamson5842add2006-03-26 01:37:26 -0800951 if (conflock)
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400952 locks_copy_conflock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 error = -EAGAIN;
954 if (!(request->fl_flags & FL_SLEEP))
955 goto out;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400956 /*
957 * Deadlock detection and insertion into the blocked
958 * locks list must be done while holding the same lock!
959 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 error = -EDEADLK;
Jeff Layton7b2296a2013-06-21 08:58:20 -0400961 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400962 if (likely(!posix_locks_deadlock(request, fl))) {
963 error = FILE_LOCK_DEFERRED;
964 __locks_insert_block(fl, request);
965 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400966 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 goto out;
968 }
969 }
970
971 /* If we're just looking for a conflict, we're done. */
972 error = 0;
973 if (request->fl_flags & FL_ACCESS)
974 goto out;
975
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 * Find the first old lock with the same owner as the new lock.
978 */
979
980 before = &inode->i_flock;
981
982 /* First skip locks owned by other processes. */
983 while ((fl = *before) && (!IS_POSIX(fl) ||
984 !posix_same_owner(request, fl))) {
985 before = &fl->fl_next;
986 }
987
Jeff Layton1cb36012013-06-21 08:58:12 -0400988 /* Process locks with this owner. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 while ((fl = *before) && posix_same_owner(request, fl)) {
990 /* Detect adjacent or overlapping regions (if same lock type)
991 */
992 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -0700993 /* In all comparisons of start vs end, use
994 * "start - 1" rather than "end + 1". If end
995 * is OFFSET_MAX, end + 1 will become negative.
996 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 if (fl->fl_end < request->fl_start - 1)
998 goto next_lock;
999 /* If the next lock in the list has entirely bigger
1000 * addresses than the new one, insert the lock here.
1001 */
Olaf Kirch449231d2005-08-25 16:25:35 -07001002 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 break;
1004
1005 /* If we come here, the new and old lock are of the
1006 * same type and adjacent or overlapping. Make one
1007 * lock yielding from the lower start address of both
1008 * locks to the higher end address.
1009 */
1010 if (fl->fl_start > request->fl_start)
1011 fl->fl_start = request->fl_start;
1012 else
1013 request->fl_start = fl->fl_start;
1014 if (fl->fl_end < request->fl_end)
1015 fl->fl_end = request->fl_end;
1016 else
1017 request->fl_end = fl->fl_end;
1018 if (added) {
Jeff Laytoned9814d2014-08-11 14:20:31 -04001019 locks_delete_lock(before, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 continue;
1021 }
1022 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001023 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 }
1025 else {
1026 /* Processing for different lock types is a bit
1027 * more complex.
1028 */
1029 if (fl->fl_end < request->fl_start)
1030 goto next_lock;
1031 if (fl->fl_start > request->fl_end)
1032 break;
1033 if (request->fl_type == F_UNLCK)
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001034 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 if (fl->fl_start < request->fl_start)
1036 left = fl;
1037 /* If the next lock in the list has a higher end
1038 * address than the new one, insert the new one here.
1039 */
1040 if (fl->fl_end > request->fl_end) {
1041 right = fl;
1042 break;
1043 }
1044 if (fl->fl_start >= request->fl_start) {
1045 /* The new lock completely replaces an old
1046 * one (This may happen several times).
1047 */
1048 if (added) {
Jeff Laytoned9814d2014-08-11 14:20:31 -04001049 locks_delete_lock(before, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 continue;
1051 }
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001052 /*
1053 * Replace the old lock with new_fl, and
1054 * remove the old one. It's safe to do the
1055 * insert here since we know that we won't be
1056 * using new_fl later, and that the lock is
1057 * just replacing an existing lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 */
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001059 error = -ENOLCK;
1060 if (!new_fl)
1061 goto out;
1062 locks_copy_lock(new_fl, request);
1063 request = new_fl;
1064 new_fl = NULL;
Jeff Laytoned9814d2014-08-11 14:20:31 -04001065 locks_delete_lock(before, &dispose);
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001066 locks_insert_lock(before, request);
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001067 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 }
1069 }
1070 /* Go on to next lock.
1071 */
1072 next_lock:
1073 before = &fl->fl_next;
1074 }
1075
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001076 /*
Jeff Layton1cb36012013-06-21 08:58:12 -04001077 * The above code only modifies existing locks in case of merging or
1078 * replacing. If new lock(s) need to be inserted all modifications are
1079 * done below this, so it's safe yet to bail out.
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001080 */
1081 error = -ENOLCK; /* "no luck" */
1082 if (right && left == right && !new_fl2)
1083 goto out;
1084
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 error = 0;
1086 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -04001087 if (request->fl_type == F_UNLCK) {
1088 if (request->fl_flags & FL_EXISTS)
1089 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001091 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001092
1093 if (!new_fl) {
1094 error = -ENOLCK;
1095 goto out;
1096 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 locks_copy_lock(new_fl, request);
1098 locks_insert_lock(before, new_fl);
1099 new_fl = NULL;
1100 }
1101 if (right) {
1102 if (left == right) {
1103 /* The new lock breaks the old one in two pieces,
1104 * so we have to use the second new lock.
1105 */
1106 left = new_fl2;
1107 new_fl2 = NULL;
1108 locks_copy_lock(left, right);
1109 locks_insert_lock(before, left);
1110 }
1111 right->fl_start = request->fl_end + 1;
1112 locks_wake_up_blocks(right);
1113 }
1114 if (left) {
1115 left->fl_end = request->fl_start - 1;
1116 locks_wake_up_blocks(left);
1117 }
1118 out:
Jeff Layton1c8c6012013-06-21 08:58:15 -04001119 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 /*
1121 * Free any unused locks.
1122 */
1123 if (new_fl)
1124 locks_free_lock(new_fl);
1125 if (new_fl2)
1126 locks_free_lock(new_fl2);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001127 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 return error;
1129}
1130
1131/**
1132 * posix_lock_file - Apply a POSIX-style lock to a file
1133 * @filp: The file to apply the lock to
1134 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001135 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 *
1137 * Add a POSIX style lock to a file.
1138 * We merge adjacent & overlapping locks whenever possible.
1139 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001140 *
1141 * Note that if called with an FL_EXISTS argument, the caller may determine
1142 * whether or not a lock was successfully freed by testing the return
1143 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 */
Marc Eshel150b3932007-01-18 16:15:35 -05001145int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001146 struct file_lock *conflock)
1147{
Al Viro496ad9a2013-01-23 17:07:38 -05001148 return __posix_lock_file(file_inode(filp), fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001149}
Marc Eshel150b3932007-01-18 16:15:35 -05001150EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151
1152/**
1153 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1154 * @filp: The file to apply the lock to
1155 * @fl: The lock to be applied
1156 *
1157 * Add a POSIX style lock to a file.
1158 * We merge adjacent & overlapping locks whenever possible.
1159 * POSIX locks are sorted by owner task, then by starting address
1160 */
1161int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1162{
1163 int error;
1164 might_sleep ();
1165 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001166 error = posix_lock_file(filp, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001167 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 break;
1169 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1170 if (!error)
1171 continue;
1172
1173 locks_delete_block(fl);
1174 break;
1175 }
1176 return error;
1177}
1178EXPORT_SYMBOL(posix_lock_file_wait);
1179
1180/**
1181 * locks_mandatory_locked - Check for an active lock
Jeff Laytond7a06982014-03-10 09:54:15 -04001182 * @file: the file to check
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 *
1184 * Searches the inode's list of locks to find any POSIX locks which conflict.
1185 * This function is called from locks_verify_locked() only.
1186 */
Jeff Laytond7a06982014-03-10 09:54:15 -04001187int locks_mandatory_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188{
Jeff Laytond7a06982014-03-10 09:54:15 -04001189 struct inode *inode = file_inode(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190 struct file_lock *fl;
1191
1192 /*
1193 * Search the lock list for this inode for any POSIX locks.
1194 */
Jeff Layton1c8c6012013-06-21 08:58:15 -04001195 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1197 if (!IS_POSIX(fl))
1198 continue;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001199 if (fl->fl_owner != current->files &&
1200 fl->fl_owner != file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 break;
1202 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04001203 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 return fl ? -EAGAIN : 0;
1205}
1206
1207/**
1208 * locks_mandatory_area - Check for a conflicting lock
1209 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1210 * for shared
1211 * @inode: the file to check
1212 * @filp: how the file was opened (if it was)
1213 * @offset: start of area to check
1214 * @count: length of area to check
1215 *
1216 * Searches the inode's list of locks to find any POSIX locks which conflict.
1217 * This function is called from rw_verify_area() and
1218 * locks_verify_truncate().
1219 */
1220int locks_mandatory_area(int read_write, struct inode *inode,
1221 struct file *filp, loff_t offset,
1222 size_t count)
1223{
1224 struct file_lock fl;
1225 int error;
Jeff Layton29723ad2014-03-10 09:54:19 -04001226 bool sleep = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227
1228 locks_init_lock(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 fl.fl_pid = current->tgid;
1230 fl.fl_file = filp;
1231 fl.fl_flags = FL_POSIX | FL_ACCESS;
1232 if (filp && !(filp->f_flags & O_NONBLOCK))
Jeff Layton29723ad2014-03-10 09:54:19 -04001233 sleep = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1235 fl.fl_start = offset;
1236 fl.fl_end = offset + count - 1;
1237
1238 for (;;) {
Jeff Layton29723ad2014-03-10 09:54:19 -04001239 if (filp) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001240 fl.fl_owner = filp;
Jeff Layton29723ad2014-03-10 09:54:19 -04001241 fl.fl_flags &= ~FL_SLEEP;
1242 error = __posix_lock_file(inode, &fl, NULL);
1243 if (!error)
1244 break;
1245 }
1246
1247 if (sleep)
1248 fl.fl_flags |= FL_SLEEP;
1249 fl.fl_owner = current->files;
Marc Eshel150b3932007-01-18 16:15:35 -05001250 error = __posix_lock_file(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001251 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 break;
1253 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1254 if (!error) {
1255 /*
1256 * If we've been sleeping someone might have
1257 * changed the permissions behind our back.
1258 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001259 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 continue;
1261 }
1262
1263 locks_delete_block(&fl);
1264 break;
1265 }
1266
1267 return error;
1268}
1269
1270EXPORT_SYMBOL(locks_mandatory_area);
1271
J. Bruce Fields778fc542011-07-26 18:25:49 -04001272static void lease_clear_pending(struct file_lock *fl, int arg)
1273{
1274 switch (arg) {
1275 case F_UNLCK:
1276 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1277 /* fall through: */
1278 case F_RDLCK:
1279 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1280 }
1281}
1282
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283/* We already had a lease on this file; just change its type */
1284int lease_modify(struct file_lock **before, int arg)
1285{
1286 struct file_lock *fl = *before;
1287 int error = assign_type(fl, arg);
1288
1289 if (error)
1290 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001291 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001293 if (arg == F_UNLCK) {
1294 struct file *filp = fl->fl_file;
1295
1296 f_delown(filp);
1297 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001298 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1299 if (fl->fl_fasync != NULL) {
1300 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1301 fl->fl_fasync = NULL;
1302 }
Jeff Laytoned9814d2014-08-11 14:20:31 -04001303 locks_delete_lock(before, NULL);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001304 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305 return 0;
1306}
1307
1308EXPORT_SYMBOL(lease_modify);
1309
J. Bruce Fields778fc542011-07-26 18:25:49 -04001310static bool past_time(unsigned long then)
1311{
1312 if (!then)
1313 /* 0 is a special value meaning "this never expires": */
1314 return false;
1315 return time_after(jiffies, then);
1316}
1317
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318static void time_out_leases(struct inode *inode)
1319{
1320 struct file_lock **before;
1321 struct file_lock *fl;
1322
1323 before = &inode->i_flock;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04001324 while ((fl = *before) && IS_LEASE(fl) && lease_breaking(fl)) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001325 trace_time_out_leases(inode, fl);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001326 if (past_time(fl->fl_downgrade_time))
1327 lease_modify(before, F_RDLCK);
1328 if (past_time(fl->fl_break_time))
1329 lease_modify(before, F_UNLCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 if (fl == *before) /* lease_modify may have freed fl */
1331 before = &fl->fl_next;
1332 }
1333}
1334
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001335static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1336{
1337 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1338 return false;
1339 return locks_conflict(breaker, lease);
1340}
1341
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342/**
1343 * __break_lease - revoke all outstanding leases on file
1344 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001345 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1346 * break all leases
1347 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1348 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 *
david m. richter87250dd2007-05-09 16:10:27 -04001350 * break_lease (inlined for speed) has checked there already is at least
1351 * some kind of lock (maybe a lease) on this file. Leases are broken on
1352 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 * specified %O_NONBLOCK to your open().
1354 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001355int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001357 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 struct file_lock *new_fl, *flock;
1359 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 unsigned long break_time;
1361 int i_have_this_lease = 0;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001362 bool lease_conflict = false;
Al Viro8737c932009-12-24 06:47:55 -05001363 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364
Al Viro8737c932009-12-24 06:47:55 -05001365 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001366 if (IS_ERR(new_fl))
1367 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001368 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369
Jeff Layton1c8c6012013-06-21 08:58:15 -04001370 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371
1372 time_out_leases(inode);
1373
1374 flock = inode->i_flock;
1375 if ((flock == NULL) || !IS_LEASE(flock))
1376 goto out;
1377
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001378 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1379 if (leases_conflict(fl, new_fl)) {
1380 lease_conflict = true;
1381 if (fl->fl_owner == current->files)
1382 i_have_this_lease = 1;
1383 }
1384 }
1385 if (!lease_conflict)
J. Bruce Fields778fc542011-07-26 18:25:49 -04001386 goto out;
1387
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 break_time = 0;
1389 if (lease_break_time > 0) {
1390 break_time = jiffies + lease_break_time * HZ;
1391 if (break_time == 0)
1392 break_time++; /* so that 0 means no break time */
1393 }
1394
1395 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001396 if (!leases_conflict(fl, new_fl))
1397 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001398 if (want_write) {
1399 if (fl->fl_flags & FL_UNLOCK_PENDING)
1400 continue;
1401 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001403 } else {
1404 if (lease_breaking(flock))
1405 continue;
1406 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1407 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 }
J. Bruce Fields778fc542011-07-26 18:25:49 -04001409 fl->fl_lmops->lm_break(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 }
1411
1412 if (i_have_this_lease || (mode & O_NONBLOCK)) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001413 trace_break_lease_noblock(inode, new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 error = -EWOULDBLOCK;
1415 goto out;
1416 }
1417
1418restart:
1419 break_time = flock->fl_break_time;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001420 if (break_time != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 break_time -= jiffies;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001422 if (break_time == 0)
1423 break_time++;
Matthew Wilcox4321e012008-01-14 21:28:30 -07001424 locks_insert_block(flock, new_fl);
Jeff Layton62af4f12014-05-09 14:13:05 -04001425 trace_break_lease_block(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001426 spin_unlock(&inode->i_lock);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001427 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1428 !new_fl->fl_next, break_time);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001429 spin_lock(&inode->i_lock);
Jeff Layton62af4f12014-05-09 14:13:05 -04001430 trace_break_lease_unblock(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001431 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 if (error >= 0) {
1433 if (error == 0)
1434 time_out_leases(inode);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001435 /*
1436 * Wait for the next conflicting lease that has not been
1437 * broken yet
1438 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1440 flock = flock->fl_next) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001441 if (leases_conflict(new_fl, flock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 goto restart;
1443 }
1444 error = 0;
1445 }
1446
1447out:
Jeff Layton1c8c6012013-06-21 08:58:15 -04001448 spin_unlock(&inode->i_lock);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001449 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 return error;
1451}
1452
1453EXPORT_SYMBOL(__break_lease);
1454
1455/**
Randy Dunlapa6b91912008-03-19 17:01:00 -07001456 * lease_get_mtime - get the last modified time of an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 * @inode: the inode
1458 * @time: pointer to a timespec which will contain the last modified time
1459 *
1460 * This is to force NFS clients to flush their caches for files with
1461 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001462 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 */
1464void lease_get_mtime(struct inode *inode, struct timespec *time)
1465{
1466 struct file_lock *flock = inode->i_flock;
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04001467 if (flock && IS_LEASE(flock) && (flock->fl_type == F_WRLCK))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 *time = current_fs_time(inode->i_sb);
1469 else
1470 *time = inode->i_mtime;
1471}
1472
1473EXPORT_SYMBOL(lease_get_mtime);
1474
1475/**
1476 * fcntl_getlease - Enquire what lease is currently active
1477 * @filp: the file
1478 *
1479 * The value returned by this function will be one of
1480 * (if no lease break is pending):
1481 *
1482 * %F_RDLCK to indicate a shared lease is held.
1483 *
1484 * %F_WRLCK to indicate an exclusive lease is held.
1485 *
1486 * %F_UNLCK to indicate no lease is held.
1487 *
1488 * (if a lease break is pending):
1489 *
1490 * %F_RDLCK to indicate an exclusive lease needs to be
1491 * changed to a shared lease (or removed).
1492 *
1493 * %F_UNLCK to indicate the lease needs to be removed.
1494 *
1495 * XXX: sfr & willy disagree over whether F_INPROGRESS
1496 * should be returned to userspace.
1497 */
1498int fcntl_getlease(struct file *filp)
1499{
1500 struct file_lock *fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001501 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 int type = F_UNLCK;
1503
Jeff Layton1c8c6012013-06-21 08:58:15 -04001504 spin_lock(&inode->i_lock);
Al Viro496ad9a2013-01-23 17:07:38 -05001505 time_out_leases(file_inode(filp));
1506 for (fl = file_inode(filp)->i_flock; fl && IS_LEASE(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 fl = fl->fl_next) {
1508 if (fl->fl_file == filp) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001509 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 break;
1511 }
1512 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04001513 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 return type;
1515}
1516
Jeff Layton24cbe782014-02-03 12:13:06 -05001517/**
1518 * check_conflicting_open - see if the given dentry points to a file that has
1519 * an existing open that would conflict with the
1520 * desired lease.
1521 * @dentry: dentry to check
1522 * @arg: type of lease that we're trying to acquire
1523 *
1524 * Check to see if there's an existing open fd on this file that would
1525 * conflict with the lease we're trying to set.
1526 */
1527static int
1528check_conflicting_open(const struct dentry *dentry, const long arg)
1529{
1530 int ret = 0;
1531 struct inode *inode = dentry->d_inode;
1532
1533 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1534 return -EAGAIN;
1535
1536 if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1537 (atomic_read(&inode->i_count) > 1)))
1538 ret = -EAGAIN;
1539
1540 return ret;
1541}
1542
Jeff Laytond4f22d12013-06-21 08:58:11 -04001543static int generic_add_lease(struct file *filp, long arg, struct file_lock **flp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544{
KAMBAROV, ZAUR7eaae282005-07-07 17:57:06 -07001545 struct file_lock *fl, **before, **my_before = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001546 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 struct inode *inode = dentry->d_inode;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001548 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001549 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550
J. Bruce Fields096657b2010-10-30 17:31:14 -04001551 lease = *flp;
Jeff Layton62af4f12014-05-09 14:13:05 -04001552 trace_generic_add_lease(inode, lease);
1553
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001554 /*
1555 * In the delegation case we need mutual exclusion with
1556 * a number of operations that take the i_mutex. We trylock
1557 * because delegations are an optional optimization, and if
1558 * there's some chance of a conflict--we'd rather not
1559 * bother, maybe that's a sign this just isn't a good file to
1560 * hand out a delegation on.
1561 */
1562 if (is_deleg && !mutex_trylock(&inode->i_mutex))
1563 return -EAGAIN;
1564
1565 if (is_deleg && arg == F_WRLCK) {
1566 /* Write delegations are not currently supported: */
Dan Carpenter4fdb7932013-11-13 10:56:27 +03001567 mutex_unlock(&inode->i_mutex);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001568 WARN_ON_ONCE(1);
1569 return -EINVAL;
1570 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001571
Jeff Layton24cbe782014-02-03 12:13:06 -05001572 error = check_conflicting_open(dentry, arg);
1573 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001574 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001575
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 /*
1577 * At this point, we know that if there is an exclusive
1578 * lease on this file, then we hold it on this filp
1579 * (otherwise our open of this file would have blocked).
1580 * And if we are trying to acquire an exclusive lease,
1581 * then the file is not open by anyone (including us)
1582 * except for this filp.
1583 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001584 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 for (before = &inode->i_flock;
1586 ((fl = *before) != NULL) && IS_LEASE(fl);
1587 before = &fl->fl_next) {
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001588 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 my_before = before;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001590 continue;
1591 }
1592 /*
1593 * No exclusive leases if someone else has a lease on
1594 * this file:
1595 */
1596 if (arg == F_WRLCK)
1597 goto out;
1598 /*
1599 * Modifying our existing lease is OK, but no getting a
1600 * new lease if someone else is opening for write:
1601 */
1602 if (fl->fl_flags & FL_UNLOCK_PENDING)
1603 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 }
1605
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 if (my_before != NULL) {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001607 error = lease->fl_lmops->lm_change(my_before, arg);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001608 if (!error)
1609 *flp = *my_before;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 goto out;
1611 }
1612
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 error = -EINVAL;
1614 if (!leases_enable)
1615 goto out;
1616
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001617 locks_insert_lock(before, lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001618 /*
1619 * The check in break_lease() is lockless. It's possible for another
1620 * open to race in after we did the earlier check for a conflicting
1621 * open but before the lease was inserted. Check again for a
1622 * conflicting open and cancel the lease if there is one.
1623 *
1624 * We also add a barrier here to ensure that the insertion of the lock
1625 * precedes these checks.
1626 */
1627 smp_mb();
1628 error = check_conflicting_open(dentry, arg);
1629 if (error)
Jeff Laytonf39b9132014-09-09 16:00:51 -04001630 locks_unlink_lock(before);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631out:
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001632 if (is_deleg)
1633 mutex_unlock(&inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 return error;
1635}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001636
Jeff Laytond4f22d12013-06-21 08:58:11 -04001637static int generic_delete_lease(struct file *filp, struct file_lock **flp)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001638{
1639 struct file_lock *fl, **before;
1640 struct dentry *dentry = filp->f_path.dentry;
1641 struct inode *inode = dentry->d_inode;
1642
Jeff Layton62af4f12014-05-09 14:13:05 -04001643 trace_generic_delete_lease(inode, *flp);
1644
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001645 for (before = &inode->i_flock;
1646 ((fl = *before) != NULL) && IS_LEASE(fl);
1647 before = &fl->fl_next) {
1648 if (fl->fl_file != filp)
1649 continue;
1650 return (*flp)->fl_lmops->lm_change(before, F_UNLCK);
1651 }
1652 return -EAGAIN;
1653}
1654
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655/**
1656 * generic_setlease - sets a lease on an open file
1657 * @filp: file pointer
1658 * @arg: type of lease to obtain
1659 * @flp: input - file_lock to use, output - file_lock inserted
1660 *
1661 * The (input) flp->fl_lmops->lm_break function is required
1662 * by break_lease().
1663 *
Jeff Layton1c8c6012013-06-21 08:58:15 -04001664 * Called with inode->i_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 */
1666int generic_setlease(struct file *filp, long arg, struct file_lock **flp)
1667{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 struct dentry *dentry = filp->f_path.dentry;
1669 struct inode *inode = dentry->d_inode;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001670 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001672 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001673 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001675 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 error = security_file_lock(filp, arg);
1677 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001678 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679
1680 time_out_leases(inode);
1681
1682 BUG_ON(!(*flp)->fl_lmops->lm_break);
1683
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001684 switch (arg) {
1685 case F_UNLCK:
1686 return generic_delete_lease(filp, flp);
1687 case F_RDLCK:
1688 case F_WRLCK:
1689 return generic_add_lease(filp, arg, flp);
1690 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001691 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001694EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001696static int __vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
1697{
Al Viro72c2d532013-09-22 16:27:52 -04001698 if (filp->f_op->setlease)
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001699 return filp->f_op->setlease(filp, arg, lease);
1700 else
1701 return generic_setlease(filp, arg, lease);
1702}
1703
1704/**
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001705 * vfs_setlease - sets a lease on an open file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 * @filp: file pointer
1707 * @arg: type of lease to obtain
1708 * @lease: file_lock to use
1709 *
1710 * Call this to establish a lease on the file.
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001711 * The (*lease)->fl_lmops->lm_break operation must be set; if not,
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001712 * break_lease will oops!
1713 *
1714 * This will call the filesystem's setlease file method, if
1715 * defined. Note that there is no getlease method; instead, the
1716 * filesystem setlease method should call back to setlease() to
1717 * add a lease to the inode's lease list, where fcntl_getlease() can
1718 * find it. Since fcntl_getlease() only reports whether the current
1719 * task holds a lease, a cluster filesystem need only do this for
1720 * leases held by processes on this node.
1721 *
1722 * There is also no break_lease method; filesystems that
Adam Buchbinderc9404c92009-12-18 15:40:42 -05001723 * handle their own leases should break leases themselves from the
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001724 * filesystem's open, create, and (on truncate) setattr methods.
1725 *
1726 * Warning: the only current setlease methods exist only to disable
1727 * leases in certain cases. More vfs changes may be required to
1728 * allow a full filesystem lease implementation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729 */
1730
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001731int vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732{
Jeff Layton1c8c6012013-06-21 08:58:15 -04001733 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 int error;
1735
Jeff Layton1c8c6012013-06-21 08:58:15 -04001736 spin_lock(&inode->i_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001737 error = __vfs_setlease(filp, arg, lease);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001738 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739
1740 return error;
1741}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001742EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001744static int do_fcntl_delete_lease(struct file *filp)
1745{
1746 struct file_lock fl, *flp = &fl;
1747
1748 lease_init(filp, F_UNLCK, flp);
1749
1750 return vfs_setlease(filp, F_UNLCK, &flp);
1751}
1752
1753static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754{
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001755 struct file_lock *fl, *ret;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001756 struct inode *inode = file_inode(filp);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001757 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 int error;
1759
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001760 fl = lease_alloc(filp, arg);
1761 if (IS_ERR(fl))
1762 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001764 new = fasync_alloc();
1765 if (!new) {
1766 locks_free_lock(fl);
1767 return -ENOMEM;
1768 }
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001769 ret = fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001770 spin_lock(&inode->i_lock);
J. Bruce Fields8896b932010-11-03 18:09:18 -04001771 error = __vfs_setlease(filp, arg, &ret);
Jeff Layton2dfb9282014-08-11 18:14:12 -04001772 if (error)
1773 goto out_unlock;
1774 if (ret == fl)
1775 fl = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001777 /*
1778 * fasync_insert_entry() returns the old entry if any.
1779 * If there was no old entry, then it used 'new' and
1780 * inserted it into the fasync list. Clear new so that
1781 * we don't release it here.
1782 */
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001783 if (!fasync_insert_entry(fd, filp, &ret->fl_fasync, new))
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001784 new = NULL;
1785
J. Bruce Fields8896b932010-11-03 18:09:18 -04001786 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
Jeff Layton2dfb9282014-08-11 18:14:12 -04001787out_unlock:
Jeff Layton1c8c6012013-06-21 08:58:15 -04001788 spin_unlock(&inode->i_lock);
Jeff Layton2dfb9282014-08-11 18:14:12 -04001789 if (fl)
1790 locks_free_lock(fl);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001791 if (new)
1792 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 return error;
1794}
1795
1796/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001797 * fcntl_setlease - sets a lease on an open file
1798 * @fd: open file descriptor
1799 * @filp: file pointer
1800 * @arg: type of lease to obtain
1801 *
1802 * Call this fcntl to establish a lease on the file.
1803 * Note that you also need to call %F_SETSIG to
1804 * receive a signal when the lease is broken.
1805 */
1806int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1807{
1808 if (arg == F_UNLCK)
1809 return do_fcntl_delete_lease(filp);
1810 return do_fcntl_add_lease(fd, filp, arg);
1811}
1812
1813/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1815 * @filp: The file to apply the lock to
1816 * @fl: The lock to be applied
1817 *
1818 * Add a FLOCK style lock to a file.
1819 */
1820int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1821{
1822 int error;
1823 might_sleep();
1824 for (;;) {
1825 error = flock_lock_file(filp, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001826 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827 break;
1828 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1829 if (!error)
1830 continue;
1831
1832 locks_delete_block(fl);
1833 break;
1834 }
1835 return error;
1836}
1837
1838EXPORT_SYMBOL(flock_lock_file_wait);
1839
1840/**
1841 * sys_flock: - flock() system call.
1842 * @fd: the file descriptor to lock.
1843 * @cmd: the type of lock to apply.
1844 *
1845 * Apply a %FL_FLOCK style lock to an open file descriptor.
1846 * The @cmd can be one of
1847 *
1848 * %LOCK_SH -- a shared lock.
1849 *
1850 * %LOCK_EX -- an exclusive lock.
1851 *
1852 * %LOCK_UN -- remove an existing lock.
1853 *
1854 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1855 *
1856 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1857 * processes read and write access respectively.
1858 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001859SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860{
Al Viro2903ff02012-08-28 12:52:22 -04001861 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 struct file_lock *lock;
1863 int can_sleep, unlock;
1864 int error;
1865
1866 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001867 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 goto out;
1869
1870 can_sleep = !(cmd & LOCK_NB);
1871 cmd &= ~LOCK_NB;
1872 unlock = (cmd == LOCK_UN);
1873
Al Viroaeb5d722008-09-02 15:28:45 -04001874 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04001875 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 goto out_putf;
1877
Al Viro2903ff02012-08-28 12:52:22 -04001878 error = flock_make_lock(f.file, &lock, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879 if (error)
1880 goto out_putf;
1881 if (can_sleep)
1882 lock->fl_flags |= FL_SLEEP;
1883
Al Viro2903ff02012-08-28 12:52:22 -04001884 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 if (error)
1886 goto out_free;
1887
Al Viro72c2d532013-09-22 16:27:52 -04001888 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04001889 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 (can_sleep) ? F_SETLKW : F_SETLK,
1891 lock);
1892 else
Al Viro2903ff02012-08-28 12:52:22 -04001893 error = flock_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894
1895 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08001896 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897
1898 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04001899 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900 out:
1901 return error;
1902}
1903
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001904/**
1905 * vfs_test_lock - test file byte range lock
1906 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04001907 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001908 *
1909 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1910 * setting conf->fl_type to something other than F_UNLCK.
1911 */
1912int vfs_test_lock(struct file *filp, struct file_lock *fl)
1913{
Al Viro72c2d532013-09-22 16:27:52 -04001914 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001915 return filp->f_op->lock(filp, F_GETLK, fl);
1916 posix_test_lock(filp, fl);
1917 return 0;
1918}
1919EXPORT_SYMBOL_GPL(vfs_test_lock);
1920
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001921static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1922{
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001923 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001924#if BITS_PER_LONG == 32
1925 /*
1926 * Make sure we can represent the posix lock via
1927 * legacy 32bit flock.
1928 */
1929 if (fl->fl_start > OFFT_OFFSET_MAX)
1930 return -EOVERFLOW;
1931 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1932 return -EOVERFLOW;
1933#endif
1934 flock->l_start = fl->fl_start;
1935 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1936 fl->fl_end - fl->fl_start + 1;
1937 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04001938 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001939 return 0;
1940}
1941
1942#if BITS_PER_LONG == 32
1943static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1944{
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001945 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001946 flock->l_start = fl->fl_start;
1947 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1948 fl->fl_end - fl->fl_start + 1;
1949 flock->l_whence = 0;
1950 flock->l_type = fl->fl_type;
1951}
1952#endif
1953
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954/* Report the first existing lock that would conflict with l.
1955 * This implements the F_GETLK command of fcntl().
1956 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001957int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001959 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960 struct flock flock;
1961 int error;
1962
1963 error = -EFAULT;
1964 if (copy_from_user(&flock, l, sizeof(flock)))
1965 goto out;
1966 error = -EINVAL;
1967 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1968 goto out;
1969
1970 error = flock_to_posix_lock(filp, &file_lock, &flock);
1971 if (error)
1972 goto out;
1973
Jeff Layton0d3f7a22014-04-22 08:23:58 -04001974 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05001975 error = -EINVAL;
1976 if (flock.l_pid != 0)
1977 goto out;
1978
Jeff Layton5d50ffd2014-02-03 12:13:10 -05001979 cmd = F_GETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001980 file_lock.fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001981 file_lock.fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05001982 }
1983
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001984 error = vfs_test_lock(filp, &file_lock);
1985 if (error)
1986 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001988 flock.l_type = file_lock.fl_type;
1989 if (file_lock.fl_type != F_UNLCK) {
1990 error = posix_lock_to_flock(&flock, &file_lock);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001991 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 }
1994 error = -EFAULT;
1995 if (!copy_to_user(l, &flock, sizeof(flock)))
1996 error = 0;
1997out:
1998 return error;
1999}
2000
Marc Eshel7723ec92007-01-18 15:08:55 -05002001/**
2002 * vfs_lock_file - file byte range lock
2003 * @filp: The file to apply the lock to
2004 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2005 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05002006 * @conf: Place to return a copy of the conflicting lock, if found.
2007 *
2008 * A caller that doesn't care about the conflicting lock may pass NULL
2009 * as the final argument.
2010 *
2011 * If the filesystem defines a private ->lock() method, then @conf will
2012 * be left unchanged; so a caller that cares should initialize it to
2013 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05002014 *
2015 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2016 * locks, the ->lock() interface may return asynchronously, before the lock has
2017 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002018 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05002019 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2020 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002021 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05002022 * request completes.
2023 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07002024 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2025 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05002026 * nonzero return code and the file system should release the lock. The file
2027 * system is also responsible to keep a corresponding posix lock when it
2028 * grants a lock so the VFS can find out which locks are locally held and do
2029 * the correct lock cleanup when required.
2030 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002031 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05002032 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05002033 */
Marc Eshel150b3932007-01-18 16:15:35 -05002034int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05002035{
Al Viro72c2d532013-09-22 16:27:52 -04002036 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05002037 return filp->f_op->lock(filp, cmd, fl);
2038 else
Marc Eshel150b3932007-01-18 16:15:35 -05002039 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05002040}
2041EXPORT_SYMBOL_GPL(vfs_lock_file);
2042
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002043static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2044 struct file_lock *fl)
2045{
2046 int error;
2047
2048 error = security_file_lock(filp, fl->fl_type);
2049 if (error)
2050 return error;
2051
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002052 for (;;) {
2053 error = vfs_lock_file(filp, cmd, fl, NULL);
2054 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002055 break;
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002056 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
2057 if (!error)
2058 continue;
2059
2060 locks_delete_block(fl);
2061 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002062 }
2063
2064 return error;
2065}
2066
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002067/* Ensure that fl->fl_filp has compatible f_mode for F_SETLK calls */
2068static int
2069check_fmode_for_setlk(struct file_lock *fl)
2070{
2071 switch (fl->fl_type) {
2072 case F_RDLCK:
2073 if (!(fl->fl_file->f_mode & FMODE_READ))
2074 return -EBADF;
2075 break;
2076 case F_WRLCK:
2077 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2078 return -EBADF;
2079 }
2080 return 0;
2081}
2082
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083/* Apply the lock described by l to an open file descriptor.
2084 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2085 */
Peter Staubachc2936212005-07-27 11:45:09 -07002086int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
2087 struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088{
2089 struct file_lock *file_lock = locks_alloc_lock();
2090 struct flock flock;
2091 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002092 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 int error;
2094
2095 if (file_lock == NULL)
2096 return -ENOLCK;
2097
2098 /*
2099 * This might block, so we do it before checking the inode.
2100 */
2101 error = -EFAULT;
2102 if (copy_from_user(&flock, l, sizeof(flock)))
2103 goto out;
2104
Al Viro496ad9a2013-01-23 17:07:38 -05002105 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106
2107 /* Don't allow mandatory locks on files that may be memory mapped
2108 * and shared.
2109 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002110 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 error = -EAGAIN;
2112 goto out;
2113 }
2114
Peter Staubachc2936212005-07-27 11:45:09 -07002115again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116 error = flock_to_posix_lock(filp, file_lock, &flock);
2117 if (error)
2118 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002119
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002120 error = check_fmode_for_setlk(file_lock);
2121 if (error)
2122 goto out;
2123
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002124 /*
2125 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002126 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002127 */
2128 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002129 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002130 error = -EINVAL;
2131 if (flock.l_pid != 0)
2132 goto out;
2133
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002134 cmd = F_SETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002135 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002136 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002137 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002138 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002139 error = -EINVAL;
2140 if (flock.l_pid != 0)
2141 goto out;
2142
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002143 cmd = F_SETLKW;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002144 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002145 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002146 /* Fallthrough */
2147 case F_SETLKW:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148 file_lock->fl_flags |= FL_SLEEP;
2149 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002150
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002151 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152
Peter Staubachc2936212005-07-27 11:45:09 -07002153 /*
2154 * Attempt to detect a close/fcntl race and recover by
2155 * releasing the lock that was just acquired.
2156 */
Al Viro0b2bac22008-05-06 13:58:34 -04002157 /*
2158 * we need that spin_lock here - it prevents reordering between
2159 * update of inode->i_flock and check for it done in close().
2160 * rcu_read_lock() wouldn't do.
2161 */
2162 spin_lock(&current->files->file_lock);
2163 f = fcheck(fd);
2164 spin_unlock(&current->files->file_lock);
2165 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002166 flock.l_type = F_UNLCK;
2167 goto again;
2168 }
2169
2170out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 locks_free_lock(file_lock);
2172 return error;
2173}
2174
2175#if BITS_PER_LONG == 32
2176/* Report the first existing lock that would conflict with l.
2177 * This implements the F_GETLK command of fcntl().
2178 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05002179int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002181 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 struct flock64 flock;
2183 int error;
2184
2185 error = -EFAULT;
2186 if (copy_from_user(&flock, l, sizeof(flock)))
2187 goto out;
2188 error = -EINVAL;
2189 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2190 goto out;
2191
2192 error = flock64_to_posix_lock(filp, &file_lock, &flock);
2193 if (error)
2194 goto out;
2195
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002196 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002197 error = -EINVAL;
2198 if (flock.l_pid != 0)
2199 goto out;
2200
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002201 cmd = F_GETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002202 file_lock.fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002203 file_lock.fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002204 }
2205
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002206 error = vfs_test_lock(filp, &file_lock);
2207 if (error)
2208 goto out;
2209
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002210 flock.l_type = file_lock.fl_type;
2211 if (file_lock.fl_type != F_UNLCK)
2212 posix_lock_to_flock64(&flock, &file_lock);
2213
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 error = -EFAULT;
2215 if (!copy_to_user(l, &flock, sizeof(flock)))
2216 error = 0;
2217
2218out:
2219 return error;
2220}
2221
2222/* Apply the lock described by l to an open file descriptor.
2223 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2224 */
Peter Staubachc2936212005-07-27 11:45:09 -07002225int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2226 struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227{
2228 struct file_lock *file_lock = locks_alloc_lock();
2229 struct flock64 flock;
2230 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002231 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232 int error;
2233
2234 if (file_lock == NULL)
2235 return -ENOLCK;
2236
2237 /*
2238 * This might block, so we do it before checking the inode.
2239 */
2240 error = -EFAULT;
2241 if (copy_from_user(&flock, l, sizeof(flock)))
2242 goto out;
2243
Al Viro496ad9a2013-01-23 17:07:38 -05002244 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245
2246 /* Don't allow mandatory locks on files that may be memory mapped
2247 * and shared.
2248 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002249 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 error = -EAGAIN;
2251 goto out;
2252 }
2253
Peter Staubachc2936212005-07-27 11:45:09 -07002254again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255 error = flock64_to_posix_lock(filp, file_lock, &flock);
2256 if (error)
2257 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002258
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002259 error = check_fmode_for_setlk(file_lock);
2260 if (error)
2261 goto out;
2262
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002263 /*
2264 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002265 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002266 */
2267 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002268 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002269 error = -EINVAL;
2270 if (flock.l_pid != 0)
2271 goto out;
2272
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002273 cmd = F_SETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002274 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002275 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002276 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002277 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002278 error = -EINVAL;
2279 if (flock.l_pid != 0)
2280 goto out;
2281
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002282 cmd = F_SETLKW64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002283 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002284 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002285 /* Fallthrough */
2286 case F_SETLKW64:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 file_lock->fl_flags |= FL_SLEEP;
2288 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002289
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002290 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291
Peter Staubachc2936212005-07-27 11:45:09 -07002292 /*
2293 * Attempt to detect a close/fcntl race and recover by
2294 * releasing the lock that was just acquired.
2295 */
Al Viro0b2bac22008-05-06 13:58:34 -04002296 spin_lock(&current->files->file_lock);
2297 f = fcheck(fd);
2298 spin_unlock(&current->files->file_lock);
2299 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002300 flock.l_type = F_UNLCK;
2301 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 }
2303
2304out:
2305 locks_free_lock(file_lock);
2306 return error;
2307}
2308#endif /* BITS_PER_LONG == 32 */
2309
2310/*
2311 * This function is called when the file is being removed
2312 * from the task's fd array. POSIX locks belonging to this task
2313 * are deleted at this time.
2314 */
2315void locks_remove_posix(struct file *filp, fl_owner_t owner)
2316{
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002317 struct file_lock lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318
2319 /*
2320 * If there are no locks held on this file, we don't need to call
2321 * posix_lock_file(). Another process could be setting a lock on this
2322 * file at the same time, but we wouldn't remove that lock anyway.
2323 */
Al Viro496ad9a2013-01-23 17:07:38 -05002324 if (!file_inode(filp)->i_flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 return;
2326
2327 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002328 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 lock.fl_start = 0;
2330 lock.fl_end = OFFSET_MAX;
2331 lock.fl_owner = owner;
2332 lock.fl_pid = current->tgid;
2333 lock.fl_file = filp;
2334 lock.fl_ops = NULL;
2335 lock.fl_lmops = NULL;
2336
Marc Eshel150b3932007-01-18 16:15:35 -05002337 vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2340 lock.fl_ops->fl_release_private(&lock);
2341}
2342
2343EXPORT_SYMBOL(locks_remove_posix);
2344
2345/*
2346 * This function is called on the last close of an open file.
2347 */
Jeff Layton78ed8a12014-02-03 12:13:08 -05002348void locks_remove_file(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349{
Al Viro496ad9a2013-01-23 17:07:38 -05002350 struct inode * inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351 struct file_lock *fl;
2352 struct file_lock **before;
Jeff Laytoned9814d2014-08-11 14:20:31 -04002353 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354
2355 if (!inode->i_flock)
2356 return;
2357
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002358 locks_remove_posix(filp, filp);
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002359
Al Viro72c2d532013-09-22 16:27:52 -04002360 if (filp->f_op->flock) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361 struct file_lock fl = {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002362 .fl_owner = filp,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363 .fl_pid = current->tgid,
2364 .fl_file = filp,
2365 .fl_flags = FL_FLOCK,
2366 .fl_type = F_UNLCK,
2367 .fl_end = OFFSET_MAX,
2368 };
2369 filp->f_op->flock(filp, F_SETLKW, &fl);
Trond Myklebust80fec4c2005-06-22 17:16:31 +00002370 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2371 fl.fl_ops->fl_release_private(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372 }
2373
Jeff Layton1c8c6012013-06-21 08:58:15 -04002374 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375 before = &inode->i_flock;
2376
2377 while ((fl = *before) != NULL) {
2378 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 if (IS_LEASE(fl)) {
2380 lease_modify(before, F_UNLCK);
2381 continue;
2382 }
Jeff Layton8c3cac52014-02-03 12:13:07 -05002383
2384 /*
2385 * There's a leftover lock on the list of a type that
2386 * we didn't expect to see. Most likely a classic
2387 * POSIX lock that ended up not getting released
2388 * properly, or that raced onto the list somehow. Log
2389 * some info about it and then just remove it from
2390 * the list.
2391 */
2392 WARN(!IS_FLOCK(fl),
2393 "leftover lock: dev=%u:%u ino=%lu type=%hhd flags=0x%x start=%lld end=%lld\n",
2394 MAJOR(inode->i_sb->s_dev),
2395 MINOR(inode->i_sb->s_dev), inode->i_ino,
2396 fl->fl_type, fl->fl_flags,
2397 fl->fl_start, fl->fl_end);
2398
Jeff Laytoned9814d2014-08-11 14:20:31 -04002399 locks_delete_lock(before, &dispose);
Jeff Layton8c3cac52014-02-03 12:13:07 -05002400 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401 }
2402 before = &fl->fl_next;
2403 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002404 spin_unlock(&inode->i_lock);
Jeff Laytoned9814d2014-08-11 14:20:31 -04002405 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002406}
2407
2408/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 * posix_unblock_lock - stop waiting for a file lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07002410 * @waiter: the lock which was waiting
2411 *
2412 * lockd needs to block waiting for locks.
2413 */
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002414int
Jeff Laytonf891a292013-06-21 08:58:09 -04002415posix_unblock_lock(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002416{
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002417 int status = 0;
2418
Jeff Layton7b2296a2013-06-21 08:58:20 -04002419 spin_lock(&blocked_lock_lock);
J. Bruce Fields5996a292006-01-03 09:55:44 +01002420 if (waiter->fl_next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421 __locks_delete_block(waiter);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002422 else
2423 status = -ENOENT;
Jeff Layton7b2296a2013-06-21 08:58:20 -04002424 spin_unlock(&blocked_lock_lock);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002425 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002426}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427EXPORT_SYMBOL(posix_unblock_lock);
2428
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002429/**
2430 * vfs_cancel_lock - file byte range unblock lock
2431 * @filp: The file to apply the unblock to
2432 * @fl: The lock to be unblocked
2433 *
2434 * Used by lock managers to cancel blocked requests
2435 */
2436int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2437{
Al Viro72c2d532013-09-22 16:27:52 -04002438 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002439 return filp->f_op->lock(filp, F_CANCELLK, fl);
2440 return 0;
2441}
2442
2443EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2444
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002445#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002446#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002447#include <linux/seq_file.h>
2448
Jeff Layton7012b022013-06-21 08:58:22 -04002449struct locks_iterator {
2450 int li_cpu;
2451 loff_t li_pos;
2452};
2453
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002454static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002455 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456{
2457 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002458 unsigned int fl_pid;
2459
2460 if (fl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -08002461 fl_pid = pid_vnr(fl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002462 else
2463 fl_pid = fl->fl_pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464
2465 if (fl->fl_file != NULL)
Al Viro496ad9a2013-01-23 17:07:38 -05002466 inode = file_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467
Jerome Marchand99dc8292010-10-26 14:22:33 -07002468 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469 if (IS_POSIX(fl)) {
Jeff Laytonc918d422014-02-03 12:13:09 -05002470 if (fl->fl_flags & FL_ACCESS)
Fabian Frederick5315c262014-05-09 14:13:05 -04002471 seq_puts(f, "ACCESS");
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002472 else if (IS_OFDLCK(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002473 seq_puts(f, "OFDLCK");
Jeff Laytonc918d422014-02-03 12:13:09 -05002474 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002475 seq_puts(f, "POSIX ");
Jeff Laytonc918d422014-02-03 12:13:09 -05002476
2477 seq_printf(f, " %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002479 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480 } else if (IS_FLOCK(fl)) {
2481 if (fl->fl_type & LOCK_MAND) {
Fabian Frederick5315c262014-05-09 14:13:05 -04002482 seq_puts(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002484 seq_puts(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485 }
2486 } else if (IS_LEASE(fl)) {
Jeff Layton8144f1f2014-08-11 13:36:54 -04002487 if (fl->fl_flags & FL_DELEG)
2488 seq_puts(f, "DELEG ");
2489 else
2490 seq_puts(f, "LEASE ");
2491
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002492 if (lease_breaking(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002493 seq_puts(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494 else if (fl->fl_file)
Fabian Frederick5315c262014-05-09 14:13:05 -04002495 seq_puts(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002497 seq_puts(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002498 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002499 seq_puts(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002500 }
2501 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002502 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002503 (fl->fl_type & LOCK_READ)
2504 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2505 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2506 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002507 seq_printf(f, "%s ",
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002508 (lease_breaking(fl))
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04002509 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2510 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002511 }
2512 if (inode) {
2513#ifdef WE_CAN_BREAK_LSLK_NOW
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002514 seq_printf(f, "%d %s:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515 inode->i_sb->s_id, inode->i_ino);
2516#else
2517 /* userspace relies on this representation of dev_t ;-( */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002518 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002519 MAJOR(inode->i_sb->s_dev),
2520 MINOR(inode->i_sb->s_dev), inode->i_ino);
2521#endif
2522 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002523 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002524 }
2525 if (IS_POSIX(fl)) {
2526 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002527 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002529 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002531 seq_puts(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532 }
2533}
2534
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002535static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536{
Jeff Layton7012b022013-06-21 08:58:22 -04002537 struct locks_iterator *iter = f->private;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002538 struct file_lock *fl, *bfl;
2539
Jeff Layton139ca042013-06-21 08:58:17 -04002540 fl = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002541
Jeff Layton7012b022013-06-21 08:58:22 -04002542 lock_get_status(f, fl, iter->li_pos, "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002543
2544 list_for_each_entry(bfl, &fl->fl_block, fl_block)
Jeff Layton7012b022013-06-21 08:58:22 -04002545 lock_get_status(f, bfl, iter->li_pos, " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002546
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002547 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548}
2549
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002550static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002551 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002552{
Jeff Layton7012b022013-06-21 08:58:22 -04002553 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002554
Jeff Layton7012b022013-06-21 08:58:22 -04002555 iter->li_pos = *pos + 1;
2556 lg_global_lock(&file_lock_lglock);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002557 spin_lock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002558 return seq_hlist_start_percpu(&file_lock_list, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559}
2560
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002561static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2562{
Jeff Layton7012b022013-06-21 08:58:22 -04002563 struct locks_iterator *iter = f->private;
2564
2565 ++iter->li_pos;
2566 return seq_hlist_next_percpu(v, &file_lock_list, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002567}
2568
2569static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002570 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002571{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002572 spin_unlock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002573 lg_global_unlock(&file_lock_lglock);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002574}
2575
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002576static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002577 .start = locks_start,
2578 .next = locks_next,
2579 .stop = locks_stop,
2580 .show = locks_show,
2581};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002582
2583static int locks_open(struct inode *inode, struct file *filp)
2584{
Jeff Layton7012b022013-06-21 08:58:22 -04002585 return seq_open_private(filp, &locks_seq_operations,
2586 sizeof(struct locks_iterator));
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002587}
2588
2589static const struct file_operations proc_locks_operations = {
2590 .open = locks_open,
2591 .read = seq_read,
2592 .llseek = seq_lseek,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002593 .release = seq_release_private,
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002594};
2595
2596static int __init proc_locks_init(void)
2597{
2598 proc_create("locks", 0, NULL, &proc_locks_operations);
2599 return 0;
2600}
2601module_init(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002602#endif
2603
Linus Torvalds1da177e2005-04-16 15:20:36 -07002604/**
2605 * lock_may_read - checks that the region is free of locks
2606 * @inode: the inode that is being read
2607 * @start: the first byte to read
2608 * @len: the number of bytes to read
2609 *
2610 * Emulates Windows locking requirements. Whole-file
2611 * mandatory locks (share modes) can prohibit a read and
2612 * byte-range POSIX locks can prohibit a read if they overlap.
2613 *
2614 * N.B. this function is only ever called
2615 * from knfsd and ownership of locks is never checked.
2616 */
2617int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2618{
2619 struct file_lock *fl;
2620 int result = 1;
Jeff Layton1c8c6012013-06-21 08:58:15 -04002621
2622 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2624 if (IS_POSIX(fl)) {
2625 if (fl->fl_type == F_RDLCK)
2626 continue;
2627 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2628 continue;
2629 } else if (IS_FLOCK(fl)) {
2630 if (!(fl->fl_type & LOCK_MAND))
2631 continue;
2632 if (fl->fl_type & LOCK_READ)
2633 continue;
2634 } else
2635 continue;
2636 result = 0;
2637 break;
2638 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002639 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640 return result;
2641}
2642
2643EXPORT_SYMBOL(lock_may_read);
2644
2645/**
2646 * lock_may_write - checks that the region is free of locks
2647 * @inode: the inode that is being written
2648 * @start: the first byte to write
2649 * @len: the number of bytes to write
2650 *
2651 * Emulates Windows locking requirements. Whole-file
2652 * mandatory locks (share modes) can prohibit a write and
2653 * byte-range POSIX locks can prohibit a write if they overlap.
2654 *
2655 * N.B. this function is only ever called
2656 * from knfsd and ownership of locks is never checked.
2657 */
2658int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2659{
2660 struct file_lock *fl;
2661 int result = 1;
Jeff Layton1c8c6012013-06-21 08:58:15 -04002662
2663 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002664 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2665 if (IS_POSIX(fl)) {
2666 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2667 continue;
2668 } else if (IS_FLOCK(fl)) {
2669 if (!(fl->fl_type & LOCK_MAND))
2670 continue;
2671 if (fl->fl_type & LOCK_WRITE)
2672 continue;
2673 } else
2674 continue;
2675 result = 0;
2676 break;
2677 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002678 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679 return result;
2680}
2681
2682EXPORT_SYMBOL(lock_may_write);
2683
Linus Torvalds1da177e2005-04-16 15:20:36 -07002684static int __init filelock_init(void)
2685{
Jeff Layton7012b022013-06-21 08:58:22 -04002686 int i;
2687
Linus Torvalds1da177e2005-04-16 15:20:36 -07002688 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002689 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2690
Jeff Layton7012b022013-06-21 08:58:22 -04002691 lg_lock_init(&file_lock_lglock, "file_lock_lglock");
2692
2693 for_each_possible_cpu(i)
2694 INIT_HLIST_HEAD(per_cpu_ptr(&file_lock_list, i));
2695
Linus Torvalds1da177e2005-04-16 15:20:36 -07002696 return 0;
2697}
2698
2699core_initcall(filelock_init);