blob: 442052b413afee39c49ce6307ab5402a67eef971 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133#include <asm/uaccess.h>
134
135#define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
136#define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
J. Bruce Fields617588d2011-07-01 15:18:34 -0400137#define IS_LEASE(fl) (fl->fl_flags & (FL_LEASE|FL_DELEG))
Jeff Laytonc918d422014-02-03 12:13:09 -0500138#define IS_FILE_PVT(fl) (fl->fl_flags & FL_FILE_PVT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400140static bool lease_breaking(struct file_lock *fl)
141{
J. Bruce Fields778fc542011-07-26 18:25:49 -0400142 return fl->fl_flags & (FL_UNLOCK_PENDING | FL_DOWNGRADE_PENDING);
143}
144
145static int target_leasetype(struct file_lock *fl)
146{
147 if (fl->fl_flags & FL_UNLOCK_PENDING)
148 return F_UNLCK;
149 if (fl->fl_flags & FL_DOWNGRADE_PENDING)
150 return F_RDLCK;
151 return fl->fl_type;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400152}
153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154int leases_enable = 1;
155int lease_break_time = 45;
156
157#define for_each_lock(inode, lockp) \
158 for (lockp = &inode->i_flock; *lockp != NULL; lockp = &(*lockp)->fl_next)
159
Jeff Layton1c8c6012013-06-21 08:58:15 -0400160/*
Jeff Layton7012b022013-06-21 08:58:22 -0400161 * The global file_lock_list is only used for displaying /proc/locks, so we
162 * keep a list on each CPU, with each list protected by its own spinlock via
163 * the file_lock_lglock. Note that alterations to the list also require that
164 * the relevant i_lock is held.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400165 */
Jeff Layton7012b022013-06-21 08:58:22 -0400166DEFINE_STATIC_LGLOCK(file_lock_lglock);
167static DEFINE_PER_CPU(struct hlist_head, file_lock_list);
Jeff Layton88974692013-06-21 08:58:14 -0400168
Jeff Layton1c8c6012013-06-21 08:58:15 -0400169/*
Jeff Layton48f74182013-06-21 08:58:18 -0400170 * The blocked_hash is used to find POSIX lock loops for deadlock detection.
Jeff Layton7b2296a2013-06-21 08:58:20 -0400171 * It is protected by blocked_lock_lock.
Jeff Layton48f74182013-06-21 08:58:18 -0400172 *
173 * We hash locks by lockowner in order to optimize searching for the lock a
174 * particular lockowner is waiting on.
175 *
176 * FIXME: make this value scale via some heuristic? We generally will want more
177 * buckets when we have more lockowners holding locks, but that's a little
178 * difficult to determine without knowing what the workload will look like.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400179 */
Jeff Layton48f74182013-06-21 08:58:18 -0400180#define BLOCKED_HASH_BITS 7
181static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
Jeff Layton88974692013-06-21 08:58:14 -0400182
Jeff Layton1c8c6012013-06-21 08:58:15 -0400183/*
Jeff Layton7b2296a2013-06-21 08:58:20 -0400184 * This lock protects the blocked_hash. Generally, if you're accessing it, you
185 * want to be holding this lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400186 *
187 * In addition, it also protects the fl->fl_block list, and the fl->fl_next
188 * pointer for file_lock structures that are acting as lock requests (in
189 * contrast to those that are acting as records of acquired locks).
190 *
191 * Note that when we acquire this lock in order to change the above fields,
192 * we often hold the i_lock as well. In certain cases, when reading the fields
193 * protected by this lock, we can skip acquiring it iff we already hold the
194 * i_lock.
195 *
196 * In particular, adding an entry to the fl_block list requires that you hold
197 * both the i_lock and the blocked_lock_lock (acquired in that order). Deleting
198 * an entry from the list however only requires the file_lock_lock.
199 */
Jeff Layton7b2296a2013-06-21 08:58:20 -0400200static DEFINE_SPINLOCK(blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
Christoph Lametere18b8902006-12-06 20:33:20 -0800202static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
Miklos Szerediee19cc42011-07-07 13:06:09 +0200204static void locks_init_lock_heads(struct file_lock *fl)
Miklos Szeredia51cb912011-07-06 12:33:55 +0200205{
Jeff Layton139ca042013-06-21 08:58:17 -0400206 INIT_HLIST_NODE(&fl->fl_link);
Miklos Szerediee19cc42011-07-07 13:06:09 +0200207 INIT_LIST_HEAD(&fl->fl_block);
208 init_waitqueue_head(&fl->fl_wait);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200209}
210
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200212struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200214 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200215
216 if (fl)
Miklos Szerediee19cc42011-07-07 13:06:09 +0200217 locks_init_lock_heads(fl);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200218
219 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200221EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500223void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500224{
225 if (fl->fl_ops) {
226 if (fl->fl_ops->fl_release_private)
227 fl->fl_ops->fl_release_private(fl);
228 fl->fl_ops = NULL;
229 }
J. Bruce Fields068535f2012-08-01 07:56:16 -0400230 fl->fl_lmops = NULL;
Trond Myklebust47831f32006-03-20 13:44:05 -0500231
232}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500233EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500234
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235/* Free a lock which is not in use. */
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400236void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237{
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800238 BUG_ON(waitqueue_active(&fl->fl_wait));
239 BUG_ON(!list_empty(&fl->fl_block));
Jeff Layton139ca042013-06-21 08:58:17 -0400240 BUG_ON(!hlist_unhashed(&fl->fl_link));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
Trond Myklebust47831f32006-03-20 13:44:05 -0500242 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 kmem_cache_free(filelock_cache, fl);
244}
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400245EXPORT_SYMBOL(locks_free_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
247void locks_init_lock(struct file_lock *fl)
248{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200249 memset(fl, 0, sizeof(struct file_lock));
250 locks_init_lock_heads(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251}
252
253EXPORT_SYMBOL(locks_init_lock);
254
Trond Myklebust47831f32006-03-20 13:44:05 -0500255static void locks_copy_private(struct file_lock *new, struct file_lock *fl)
256{
257 if (fl->fl_ops) {
258 if (fl->fl_ops->fl_copy_lock)
259 fl->fl_ops->fl_copy_lock(new, fl);
260 new->fl_ops = fl->fl_ops;
261 }
Christoph Hellwigbb8430a2010-10-31 08:35:31 -0400262 if (fl->fl_lmops)
Trond Myklebust47831f32006-03-20 13:44:05 -0500263 new->fl_lmops = fl->fl_lmops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500264}
265
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266/*
267 * Initialize a new lock from an existing file_lock structure.
268 */
J. Bruce Fields1a747ee2008-04-24 10:08:22 -0400269void __locks_copy_lock(struct file_lock *new, const struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270{
271 new->fl_owner = fl->fl_owner;
272 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500273 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 new->fl_flags = fl->fl_flags;
275 new->fl_type = fl->fl_type;
276 new->fl_start = fl->fl_start;
277 new->fl_end = fl->fl_end;
Trond Myklebust09969052006-03-20 13:44:38 -0500278 new->fl_ops = NULL;
279 new->fl_lmops = NULL;
280}
Roland Dreier3dd7b712008-04-25 15:32:51 -0700281EXPORT_SYMBOL(__locks_copy_lock);
Trond Myklebust09969052006-03-20 13:44:38 -0500282
283void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
284{
285 locks_release_private(new);
286
287 __locks_copy_lock(new, fl);
288 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 new->fl_ops = fl->fl_ops;
290 new->fl_lmops = fl->fl_lmops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500291
292 locks_copy_private(new, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293}
294
295EXPORT_SYMBOL(locks_copy_lock);
296
297static inline int flock_translate_cmd(int cmd) {
298 if (cmd & LOCK_MAND)
299 return cmd & (LOCK_MAND | LOCK_RW);
300 switch (cmd) {
301 case LOCK_SH:
302 return F_RDLCK;
303 case LOCK_EX:
304 return F_WRLCK;
305 case LOCK_UN:
306 return F_UNLCK;
307 }
308 return -EINVAL;
309}
310
311/* Fill in a file_lock structure with an appropriate FLOCK lock. */
312static int flock_make_lock(struct file *filp, struct file_lock **lock,
313 unsigned int cmd)
314{
315 struct file_lock *fl;
316 int type = flock_translate_cmd(cmd);
317 if (type < 0)
318 return type;
319
320 fl = locks_alloc_lock();
321 if (fl == NULL)
322 return -ENOMEM;
323
324 fl->fl_file = filp;
325 fl->fl_pid = current->tgid;
326 fl->fl_flags = FL_FLOCK;
327 fl->fl_type = type;
328 fl->fl_end = OFFSET_MAX;
329
330 *lock = fl;
331 return 0;
332}
333
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400334static int assign_type(struct file_lock *fl, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335{
336 switch (type) {
337 case F_RDLCK:
338 case F_WRLCK:
339 case F_UNLCK:
340 fl->fl_type = type;
341 break;
342 default:
343 return -EINVAL;
344 }
345 return 0;
346}
347
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500348static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
349 struct flock64 *l)
350{
351 switch (l->l_whence) {
352 case SEEK_SET:
353 fl->fl_start = 0;
354 break;
355 case SEEK_CUR:
356 fl->fl_start = filp->f_pos;
357 break;
358 case SEEK_END:
359 fl->fl_start = i_size_read(file_inode(filp));
360 break;
361 default:
362 return -EINVAL;
363 }
364 if (l->l_start > OFFSET_MAX - fl->fl_start)
365 return -EOVERFLOW;
366 fl->fl_start += l->l_start;
367 if (fl->fl_start < 0)
368 return -EINVAL;
369
370 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
371 POSIX-2001 defines it. */
372 if (l->l_len > 0) {
373 if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
374 return -EOVERFLOW;
375 fl->fl_end = fl->fl_start + l->l_len - 1;
376
377 } else if (l->l_len < 0) {
378 if (fl->fl_start + l->l_len < 0)
379 return -EINVAL;
380 fl->fl_end = fl->fl_start - 1;
381 fl->fl_start += l->l_len;
382 } else
383 fl->fl_end = OFFSET_MAX;
384
385 fl->fl_owner = current->files;
386 fl->fl_pid = current->tgid;
387 fl->fl_file = filp;
388 fl->fl_flags = FL_POSIX;
389 fl->fl_ops = NULL;
390 fl->fl_lmops = NULL;
391
Jeff Laytonbce75602014-02-03 12:13:08 -0500392 /* Ensure that fl->fl_filp has compatible f_mode */
393 switch (l->l_type) {
394 case F_RDLCK:
395 if (!(filp->f_mode & FMODE_READ))
396 return -EBADF;
397 break;
398 case F_WRLCK:
399 if (!(filp->f_mode & FMODE_WRITE))
400 return -EBADF;
401 break;
402 }
403
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500404 return assign_type(fl, l->l_type);
405}
406
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
408 * style lock.
409 */
410static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
411 struct flock *l)
412{
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500413 struct flock64 ll = {
414 .l_type = l->l_type,
415 .l_whence = l->l_whence,
416 .l_start = l->l_start,
417 .l_len = l->l_len,
418 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500420 return flock64_to_posix_lock(filp, fl, &ll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421}
422
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423/* default lease lock manager operations */
424static void lease_break_callback(struct file_lock *fl)
425{
426 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
427}
428
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700429static const struct lock_manager_operations lease_manager_ops = {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400430 .lm_break = lease_break_callback,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400431 .lm_change = lease_modify,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432};
433
434/*
435 * Initialize a lease, use the default lock manager operations
436 */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400437static int lease_init(struct file *filp, long type, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 {
Trond Myklebust75dff552006-05-07 23:02:42 -0400439 if (assign_type(fl, type) != 0)
440 return -EINVAL;
441
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 fl->fl_owner = current->files;
443 fl->fl_pid = current->tgid;
444
445 fl->fl_file = filp;
446 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 fl->fl_start = 0;
448 fl->fl_end = OFFSET_MAX;
449 fl->fl_ops = NULL;
450 fl->fl_lmops = &lease_manager_ops;
451 return 0;
452}
453
454/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400455static struct file_lock *lease_alloc(struct file *filp, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456{
457 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400458 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
460 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500461 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462
463 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400464 if (error) {
465 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500466 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400467 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500468 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469}
470
471/* Check if two locks overlap each other.
472 */
473static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
474{
475 return ((fl1->fl_end >= fl2->fl_start) &&
476 (fl2->fl_end >= fl1->fl_start));
477}
478
479/*
480 * Check whether two locks have the same owner.
481 */
Matt Mackall33443c42006-01-08 01:05:22 -0800482static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483{
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400484 if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 return fl2->fl_lmops == fl1->fl_lmops &&
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400486 fl1->fl_lmops->lm_compare_owner(fl1, fl2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 return fl1->fl_owner == fl2->fl_owner;
488}
489
Jeff Layton7012b022013-06-21 08:58:22 -0400490/* Must be called with the i_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500491static void locks_insert_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400492{
Jeff Layton7012b022013-06-21 08:58:22 -0400493 lg_local_lock(&file_lock_lglock);
494 fl->fl_link_cpu = smp_processor_id();
495 hlist_add_head(&fl->fl_link, this_cpu_ptr(&file_lock_list));
496 lg_local_unlock(&file_lock_lglock);
Jeff Layton88974692013-06-21 08:58:14 -0400497}
498
Jeff Layton7012b022013-06-21 08:58:22 -0400499/* Must be called with the i_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500500static void locks_delete_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400501{
Jeff Layton7012b022013-06-21 08:58:22 -0400502 /*
503 * Avoid taking lock if already unhashed. This is safe since this check
504 * is done while holding the i_lock, and new insertions into the list
505 * also require that it be held.
506 */
507 if (hlist_unhashed(&fl->fl_link))
508 return;
509 lg_local_lock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton139ca042013-06-21 08:58:17 -0400510 hlist_del_init(&fl->fl_link);
Jeff Layton7012b022013-06-21 08:58:22 -0400511 lg_local_unlock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton88974692013-06-21 08:58:14 -0400512}
513
Jeff Layton3999e492013-06-21 08:58:19 -0400514static unsigned long
515posix_owner_key(struct file_lock *fl)
516{
517 if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
518 return fl->fl_lmops->lm_owner_key(fl);
519 return (unsigned long)fl->fl_owner;
520}
521
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500522static void locks_insert_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400523{
Jeff Layton3999e492013-06-21 08:58:19 -0400524 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
Jeff Layton88974692013-06-21 08:58:14 -0400525}
526
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500527static void locks_delete_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400528{
Jeff Layton48f74182013-06-21 08:58:18 -0400529 hash_del(&waiter->fl_link);
Jeff Layton88974692013-06-21 08:58:14 -0400530}
531
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532/* Remove waiter from blocker's block list.
533 * When blocker ends up pointing to itself then the list is empty.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400534 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400535 * Must be called with blocked_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 */
Matt Mackall33443c42006-01-08 01:05:22 -0800537static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538{
Jeff Layton88974692013-06-21 08:58:14 -0400539 locks_delete_global_blocked(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 list_del_init(&waiter->fl_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 waiter->fl_next = NULL;
542}
543
Jeff Layton1a9e64a2013-06-21 08:58:10 -0400544static void locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400546 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 __locks_delete_block(waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400548 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549}
550
551/* Insert waiter into blocker's block list.
552 * We use a circular list so that processes can be easily woken up in
553 * the order they blocked. The documentation doesn't require this but
554 * it seems like the reasonable thing to do.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400555 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400556 * Must be called with both the i_lock and blocked_lock_lock held. The fl_block
Jeff Layton46dad762014-02-03 12:13:06 -0500557 * list itself is protected by the blocked_lock_lock, but by ensuring that the
Jeff Layton7b2296a2013-06-21 08:58:20 -0400558 * i_lock is also held on insertions we can avoid taking the blocked_lock_lock
Jeff Layton4e8c7652013-06-21 08:58:16 -0400559 * in some cases when we see that the fl_block list is empty.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400561static void __locks_insert_block(struct file_lock *blocker,
562 struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563{
J. Bruce Fields6dc0fe82006-03-26 01:37:24 -0800564 BUG_ON(!list_empty(&waiter->fl_block));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 waiter->fl_next = blocker;
Jeff Layton88974692013-06-21 08:58:14 -0400566 list_add_tail(&waiter->fl_block, &blocker->fl_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 if (IS_POSIX(blocker))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400568 locks_insert_global_blocked(waiter);
569}
570
571/* Must be called with i_lock held. */
572static void locks_insert_block(struct file_lock *blocker,
573 struct file_lock *waiter)
574{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400575 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400576 __locks_insert_block(blocker, waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400577 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578}
579
Jeff Layton1cb36012013-06-21 08:58:12 -0400580/*
581 * Wake up processes blocked waiting for blocker.
582 *
Jeff Layton1c8c6012013-06-21 08:58:15 -0400583 * Must be called with the inode->i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 */
585static void locks_wake_up_blocks(struct file_lock *blocker)
586{
Jeff Layton4e8c7652013-06-21 08:58:16 -0400587 /*
588 * Avoid taking global lock if list is empty. This is safe since new
589 * blocked requests are only added to the list under the i_lock, and
590 * the i_lock is always held here. Note that removal from the fl_block
591 * list does not require the i_lock, so we must recheck list_empty()
Jeff Layton7b2296a2013-06-21 08:58:20 -0400592 * after acquiring the blocked_lock_lock.
Jeff Layton4e8c7652013-06-21 08:58:16 -0400593 */
594 if (list_empty(&blocker->fl_block))
595 return;
596
Jeff Layton7b2296a2013-06-21 08:58:20 -0400597 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 while (!list_empty(&blocker->fl_block)) {
Pavel Emelyanovf0c1cd02007-09-19 16:44:07 +0400599 struct file_lock *waiter;
600
601 waiter = list_first_entry(&blocker->fl_block,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 struct file_lock, fl_block);
603 __locks_delete_block(waiter);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400604 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
605 waiter->fl_lmops->lm_notify(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 else
607 wake_up(&waiter->fl_wait);
608 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400609 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610}
611
612/* Insert file lock fl into an inode's lock list at the position indicated
613 * by pos. At the same time add the lock to the global file lock list.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400614 *
615 * Must be called with the i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 */
617static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
618{
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000619 fl->fl_nspid = get_pid(task_tgid(current));
620
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 /* insert into file's list */
622 fl->fl_next = *pos;
623 *pos = fl;
Jeff Layton88974692013-06-21 08:58:14 -0400624
625 locks_insert_global_locks(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626}
627
Jeff Layton24cbe782014-02-03 12:13:06 -0500628/**
629 * locks_delete_lock - Delete a lock and then free it.
630 * @thisfl_p: pointer that points to the fl_next field of the previous
631 * inode->i_flock list entry
632 *
633 * Unlink a lock from all lists and free the namespace reference, but don't
634 * free it yet. Wake up processes that are blocked waiting for this lock and
635 * notify the FS that the lock has been cleared.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400636 *
637 * Must be called with the i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 */
Jeff Layton24cbe782014-02-03 12:13:06 -0500639static void locks_unlink_lock(struct file_lock **thisfl_p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640{
641 struct file_lock *fl = *thisfl_p;
642
Jeff Layton88974692013-06-21 08:58:14 -0400643 locks_delete_global_locks(fl);
644
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 *thisfl_p = fl->fl_next;
646 fl->fl_next = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000648 if (fl->fl_nspid) {
649 put_pid(fl->fl_nspid);
650 fl->fl_nspid = NULL;
651 }
652
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 locks_wake_up_blocks(fl);
Jeff Layton24cbe782014-02-03 12:13:06 -0500654}
655
656/*
657 * Unlink a lock from all lists and free it.
658 *
659 * Must be called with i_lock held!
660 */
661static void locks_delete_lock(struct file_lock **thisfl_p)
662{
663 struct file_lock *fl = *thisfl_p;
664
665 locks_unlink_lock(thisfl_p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 locks_free_lock(fl);
667}
668
669/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
670 * checks for shared/exclusive status of overlapping locks.
671 */
672static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
673{
674 if (sys_fl->fl_type == F_WRLCK)
675 return 1;
676 if (caller_fl->fl_type == F_WRLCK)
677 return 1;
678 return 0;
679}
680
681/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
682 * checking before calling the locks_conflict().
683 */
684static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
685{
686 /* POSIX locks owned by the same process do not conflict with
687 * each other.
688 */
689 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
690 return (0);
691
692 /* Check whether they overlap */
693 if (!locks_overlap(caller_fl, sys_fl))
694 return 0;
695
696 return (locks_conflict(caller_fl, sys_fl));
697}
698
699/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
700 * checking before calling the locks_conflict().
701 */
702static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
703{
704 /* FLOCK locks referring to the same filp do not conflict with
705 * each other.
706 */
707 if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
708 return (0);
709 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
710 return 0;
711
712 return (locks_conflict(caller_fl, sys_fl));
713}
714
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400715void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500716posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717{
718 struct file_lock *cfl;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400719 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720
Jeff Layton1c8c6012013-06-21 08:58:15 -0400721 spin_lock(&inode->i_lock);
Al Viro496ad9a2013-01-23 17:07:38 -0500722 for (cfl = file_inode(filp)->i_flock; cfl; cfl = cfl->fl_next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 if (!IS_POSIX(cfl))
724 continue;
J. Bruce Fieldsb842e242007-05-10 19:02:07 -0400725 if (posix_locks_conflict(fl, cfl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 break;
727 }
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000728 if (cfl) {
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500729 __locks_copy_lock(fl, cfl);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000730 if (cfl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -0800731 fl->fl_pid = pid_vnr(cfl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000732 } else
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400733 fl->fl_type = F_UNLCK;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400734 spin_unlock(&inode->i_lock);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400735 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737EXPORT_SYMBOL(posix_test_lock);
738
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400739/*
740 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400742 * We attempt to detect deadlocks that are due purely to posix file
743 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400745 * We assume that a task can be waiting for at most one lock at a time.
746 * So for any acquired lock, the process holding that lock may be
747 * waiting on at most one other lock. That lock in turns may be held by
748 * someone waiting for at most one other lock. Given a requested lock
749 * caller_fl which is about to wait for a conflicting lock block_fl, we
750 * follow this chain of waiters to ensure we are not about to create a
751 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400752 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400753 * Since we do this before we ever put a process to sleep on a lock, we
754 * are ensured that there is never a cycle; that is what guarantees that
755 * the while() loop in posix_locks_deadlock() eventually completes.
756 *
757 * Note: the above assumption may not be true when handling lock
758 * requests from a broken NFS client. It may also fail in the presence
759 * of tasks (such as posix threads) sharing the same open file table.
760 *
761 * To handle those cases, we just bail out after a few iterations.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400763
764#define MAX_DEADLK_ITERATIONS 10
765
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400766/* Find a lock that the owner of the given block_fl is blocking on. */
767static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
768{
769 struct file_lock *fl;
770
Jeff Layton3999e492013-06-21 08:58:19 -0400771 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400772 if (posix_same_owner(fl, block_fl))
773 return fl->fl_next;
774 }
775 return NULL;
776}
777
Jeff Layton7b2296a2013-06-21 08:58:20 -0400778/* Must be called with the blocked_lock_lock held! */
Adrian Bunkb0904e12006-06-23 02:05:13 -0700779static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 struct file_lock *block_fl)
781{
J. Bruce Fields97855b42007-10-30 11:20:02 -0400782 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400784 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
785 if (i++ > MAX_DEADLK_ITERATIONS)
786 return 0;
787 if (posix_same_owner(caller_fl, block_fl))
788 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 }
790 return 0;
791}
792
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -0400794 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -0400795 *
796 * Note that if called with an FL_EXISTS argument, the caller may determine
797 * whether or not a lock was successfully freed by testing the return
798 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 */
Trond Myklebust993dfa82006-03-31 02:30:55 -0800800static int flock_lock_file(struct file *filp, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801{
Trond Myklebust993dfa82006-03-31 02:30:55 -0800802 struct file_lock *new_fl = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 struct file_lock **before;
Al Viro496ad9a2013-01-23 17:07:38 -0500804 struct inode * inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 int error = 0;
806 int found = 0;
807
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200808 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
809 new_fl = locks_alloc_lock();
810 if (!new_fl)
811 return -ENOMEM;
812 }
813
Jeff Layton1c8c6012013-06-21 08:58:15 -0400814 spin_lock(&inode->i_lock);
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400815 if (request->fl_flags & FL_ACCESS)
816 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +0400817
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 for_each_lock(inode, before) {
819 struct file_lock *fl = *before;
820 if (IS_POSIX(fl))
821 break;
822 if (IS_LEASE(fl))
823 continue;
824 if (filp != fl->fl_file)
825 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800826 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 goto out;
828 found = 1;
829 locks_delete_lock(before);
830 break;
831 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832
Trond Myklebustf475ae92006-06-29 16:38:32 -0400833 if (request->fl_type == F_UNLCK) {
834 if ((request->fl_flags & FL_EXISTS) && !found)
835 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800836 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400837 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838
839 /*
840 * If a higher-priority process was blocked on the old file lock,
841 * give it the opportunity to lock the file.
842 */
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200843 if (found) {
Jeff Layton1c8c6012013-06-21 08:58:15 -0400844 spin_unlock(&inode->i_lock);
Frederic Weisbeckerdef01bc2009-07-16 15:44:29 +0200845 cond_resched();
Jeff Layton1c8c6012013-06-21 08:58:15 -0400846 spin_lock(&inode->i_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200847 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400849find_conflict:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 for_each_lock(inode, before) {
851 struct file_lock *fl = *before;
852 if (IS_POSIX(fl))
853 break;
854 if (IS_LEASE(fl))
855 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800856 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 continue;
858 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700859 if (!(request->fl_flags & FL_SLEEP))
860 goto out;
861 error = FILE_LOCK_DEFERRED;
862 locks_insert_block(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 goto out;
864 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400865 if (request->fl_flags & FL_ACCESS)
866 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800867 locks_copy_lock(new_fl, request);
Pavel Emelyanov0e2f6db2007-09-11 15:24:01 -0700868 locks_insert_lock(before, new_fl);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800869 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +0400870 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871
872out:
Jeff Layton1c8c6012013-06-21 08:58:15 -0400873 spin_unlock(&inode->i_lock);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800874 if (new_fl)
875 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 return error;
877}
878
Marc Eshel150b3932007-01-18 16:15:35 -0500879static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880{
881 struct file_lock *fl;
Miklos Szeredi39005d02006-06-23 02:05:10 -0700882 struct file_lock *new_fl = NULL;
883 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 struct file_lock *left = NULL;
885 struct file_lock *right = NULL;
886 struct file_lock **before;
Jeff Laytonb9746ef2013-06-21 08:58:13 -0400887 int error;
888 bool added = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889
890 /*
891 * We may need two file_lock structures for this operation,
892 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -0700893 *
894 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 */
Miklos Szeredi39005d02006-06-23 02:05:10 -0700896 if (!(request->fl_flags & FL_ACCESS) &&
897 (request->fl_type != F_UNLCK ||
898 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
899 new_fl = locks_alloc_lock();
900 new_fl2 = locks_alloc_lock();
901 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
Jeff Layton1c8c6012013-06-21 08:58:15 -0400903 spin_lock(&inode->i_lock);
Jeff Layton1cb36012013-06-21 08:58:12 -0400904 /*
905 * New lock request. Walk all POSIX locks and look for conflicts. If
906 * there are any, either return error or put the request on the
Jeff Layton48f74182013-06-21 08:58:18 -0400907 * blocker's list of waiters and the global blocked_hash.
Jeff Layton1cb36012013-06-21 08:58:12 -0400908 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 if (request->fl_type != F_UNLCK) {
910 for_each_lock(inode, before) {
J. Bruce Fields526985b2006-11-14 16:54:36 -0500911 fl = *before;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 if (!IS_POSIX(fl))
913 continue;
914 if (!posix_locks_conflict(request, fl))
915 continue;
Andy Adamson5842add2006-03-26 01:37:26 -0800916 if (conflock)
J. Bruce Fields1a747ee2008-04-24 10:08:22 -0400917 __locks_copy_lock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 error = -EAGAIN;
919 if (!(request->fl_flags & FL_SLEEP))
920 goto out;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400921 /*
922 * Deadlock detection and insertion into the blocked
923 * locks list must be done while holding the same lock!
924 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 error = -EDEADLK;
Jeff Layton7b2296a2013-06-21 08:58:20 -0400926 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400927 if (likely(!posix_locks_deadlock(request, fl))) {
928 error = FILE_LOCK_DEFERRED;
929 __locks_insert_block(fl, request);
930 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400931 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 goto out;
933 }
934 }
935
936 /* If we're just looking for a conflict, we're done. */
937 error = 0;
938 if (request->fl_flags & FL_ACCESS)
939 goto out;
940
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 * Find the first old lock with the same owner as the new lock.
943 */
944
945 before = &inode->i_flock;
946
947 /* First skip locks owned by other processes. */
948 while ((fl = *before) && (!IS_POSIX(fl) ||
949 !posix_same_owner(request, fl))) {
950 before = &fl->fl_next;
951 }
952
Jeff Layton1cb36012013-06-21 08:58:12 -0400953 /* Process locks with this owner. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 while ((fl = *before) && posix_same_owner(request, fl)) {
955 /* Detect adjacent or overlapping regions (if same lock type)
956 */
957 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -0700958 /* In all comparisons of start vs end, use
959 * "start - 1" rather than "end + 1". If end
960 * is OFFSET_MAX, end + 1 will become negative.
961 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 if (fl->fl_end < request->fl_start - 1)
963 goto next_lock;
964 /* If the next lock in the list has entirely bigger
965 * addresses than the new one, insert the lock here.
966 */
Olaf Kirch449231d2005-08-25 16:25:35 -0700967 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 break;
969
970 /* If we come here, the new and old lock are of the
971 * same type and adjacent or overlapping. Make one
972 * lock yielding from the lower start address of both
973 * locks to the higher end address.
974 */
975 if (fl->fl_start > request->fl_start)
976 fl->fl_start = request->fl_start;
977 else
978 request->fl_start = fl->fl_start;
979 if (fl->fl_end < request->fl_end)
980 fl->fl_end = request->fl_end;
981 else
982 request->fl_end = fl->fl_end;
983 if (added) {
984 locks_delete_lock(before);
985 continue;
986 }
987 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -0400988 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 }
990 else {
991 /* Processing for different lock types is a bit
992 * more complex.
993 */
994 if (fl->fl_end < request->fl_start)
995 goto next_lock;
996 if (fl->fl_start > request->fl_end)
997 break;
998 if (request->fl_type == F_UNLCK)
Jeff Laytonb9746ef2013-06-21 08:58:13 -0400999 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 if (fl->fl_start < request->fl_start)
1001 left = fl;
1002 /* If the next lock in the list has a higher end
1003 * address than the new one, insert the new one here.
1004 */
1005 if (fl->fl_end > request->fl_end) {
1006 right = fl;
1007 break;
1008 }
1009 if (fl->fl_start >= request->fl_start) {
1010 /* The new lock completely replaces an old
1011 * one (This may happen several times).
1012 */
1013 if (added) {
1014 locks_delete_lock(before);
1015 continue;
1016 }
1017 /* Replace the old lock with the new one.
1018 * Wake up anybody waiting for the old one,
1019 * as the change in lock type might satisfy
1020 * their needs.
1021 */
1022 locks_wake_up_blocks(fl);
1023 fl->fl_start = request->fl_start;
1024 fl->fl_end = request->fl_end;
1025 fl->fl_type = request->fl_type;
Trond Myklebust47831f32006-03-20 13:44:05 -05001026 locks_release_private(fl);
1027 locks_copy_private(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001029 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 }
1031 }
1032 /* Go on to next lock.
1033 */
1034 next_lock:
1035 before = &fl->fl_next;
1036 }
1037
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001038 /*
Jeff Layton1cb36012013-06-21 08:58:12 -04001039 * The above code only modifies existing locks in case of merging or
1040 * replacing. If new lock(s) need to be inserted all modifications are
1041 * done below this, so it's safe yet to bail out.
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001042 */
1043 error = -ENOLCK; /* "no luck" */
1044 if (right && left == right && !new_fl2)
1045 goto out;
1046
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 error = 0;
1048 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -04001049 if (request->fl_type == F_UNLCK) {
1050 if (request->fl_flags & FL_EXISTS)
1051 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001053 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001054
1055 if (!new_fl) {
1056 error = -ENOLCK;
1057 goto out;
1058 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 locks_copy_lock(new_fl, request);
1060 locks_insert_lock(before, new_fl);
1061 new_fl = NULL;
1062 }
1063 if (right) {
1064 if (left == right) {
1065 /* The new lock breaks the old one in two pieces,
1066 * so we have to use the second new lock.
1067 */
1068 left = new_fl2;
1069 new_fl2 = NULL;
1070 locks_copy_lock(left, right);
1071 locks_insert_lock(before, left);
1072 }
1073 right->fl_start = request->fl_end + 1;
1074 locks_wake_up_blocks(right);
1075 }
1076 if (left) {
1077 left->fl_end = request->fl_start - 1;
1078 locks_wake_up_blocks(left);
1079 }
1080 out:
Jeff Layton1c8c6012013-06-21 08:58:15 -04001081 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 /*
1083 * Free any unused locks.
1084 */
1085 if (new_fl)
1086 locks_free_lock(new_fl);
1087 if (new_fl2)
1088 locks_free_lock(new_fl2);
1089 return error;
1090}
1091
1092/**
1093 * posix_lock_file - Apply a POSIX-style lock to a file
1094 * @filp: The file to apply the lock to
1095 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001096 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 *
1098 * Add a POSIX style lock to a file.
1099 * We merge adjacent & overlapping locks whenever possible.
1100 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001101 *
1102 * Note that if called with an FL_EXISTS argument, the caller may determine
1103 * whether or not a lock was successfully freed by testing the return
1104 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105 */
Marc Eshel150b3932007-01-18 16:15:35 -05001106int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001107 struct file_lock *conflock)
1108{
Al Viro496ad9a2013-01-23 17:07:38 -05001109 return __posix_lock_file(file_inode(filp), fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001110}
Marc Eshel150b3932007-01-18 16:15:35 -05001111EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112
1113/**
1114 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1115 * @filp: The file to apply the lock to
1116 * @fl: The lock to be applied
1117 *
1118 * Add a POSIX style lock to a file.
1119 * We merge adjacent & overlapping locks whenever possible.
1120 * POSIX locks are sorted by owner task, then by starting address
1121 */
1122int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1123{
1124 int error;
1125 might_sleep ();
1126 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001127 error = posix_lock_file(filp, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001128 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 break;
1130 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1131 if (!error)
1132 continue;
1133
1134 locks_delete_block(fl);
1135 break;
1136 }
1137 return error;
1138}
1139EXPORT_SYMBOL(posix_lock_file_wait);
1140
1141/**
1142 * locks_mandatory_locked - Check for an active lock
1143 * @inode: the file to check
1144 *
1145 * Searches the inode's list of locks to find any POSIX locks which conflict.
1146 * This function is called from locks_verify_locked() only.
1147 */
1148int locks_mandatory_locked(struct inode *inode)
1149{
1150 fl_owner_t owner = current->files;
1151 struct file_lock *fl;
1152
1153 /*
1154 * Search the lock list for this inode for any POSIX locks.
1155 */
Jeff Layton1c8c6012013-06-21 08:58:15 -04001156 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1158 if (!IS_POSIX(fl))
1159 continue;
1160 if (fl->fl_owner != owner)
1161 break;
1162 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04001163 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 return fl ? -EAGAIN : 0;
1165}
1166
1167/**
1168 * locks_mandatory_area - Check for a conflicting lock
1169 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1170 * for shared
1171 * @inode: the file to check
1172 * @filp: how the file was opened (if it was)
1173 * @offset: start of area to check
1174 * @count: length of area to check
1175 *
1176 * Searches the inode's list of locks to find any POSIX locks which conflict.
1177 * This function is called from rw_verify_area() and
1178 * locks_verify_truncate().
1179 */
1180int locks_mandatory_area(int read_write, struct inode *inode,
1181 struct file *filp, loff_t offset,
1182 size_t count)
1183{
1184 struct file_lock fl;
1185 int error;
1186
1187 locks_init_lock(&fl);
1188 fl.fl_owner = current->files;
1189 fl.fl_pid = current->tgid;
1190 fl.fl_file = filp;
1191 fl.fl_flags = FL_POSIX | FL_ACCESS;
1192 if (filp && !(filp->f_flags & O_NONBLOCK))
1193 fl.fl_flags |= FL_SLEEP;
1194 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1195 fl.fl_start = offset;
1196 fl.fl_end = offset + count - 1;
1197
1198 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001199 error = __posix_lock_file(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001200 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 break;
1202 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1203 if (!error) {
1204 /*
1205 * If we've been sleeping someone might have
1206 * changed the permissions behind our back.
1207 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001208 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 continue;
1210 }
1211
1212 locks_delete_block(&fl);
1213 break;
1214 }
1215
1216 return error;
1217}
1218
1219EXPORT_SYMBOL(locks_mandatory_area);
1220
J. Bruce Fields778fc542011-07-26 18:25:49 -04001221static void lease_clear_pending(struct file_lock *fl, int arg)
1222{
1223 switch (arg) {
1224 case F_UNLCK:
1225 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1226 /* fall through: */
1227 case F_RDLCK:
1228 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1229 }
1230}
1231
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232/* We already had a lease on this file; just change its type */
1233int lease_modify(struct file_lock **before, int arg)
1234{
1235 struct file_lock *fl = *before;
1236 int error = assign_type(fl, arg);
1237
1238 if (error)
1239 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001240 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001242 if (arg == F_UNLCK) {
1243 struct file *filp = fl->fl_file;
1244
1245 f_delown(filp);
1246 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001247 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1248 if (fl->fl_fasync != NULL) {
1249 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1250 fl->fl_fasync = NULL;
1251 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 locks_delete_lock(before);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001253 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 return 0;
1255}
1256
1257EXPORT_SYMBOL(lease_modify);
1258
J. Bruce Fields778fc542011-07-26 18:25:49 -04001259static bool past_time(unsigned long then)
1260{
1261 if (!then)
1262 /* 0 is a special value meaning "this never expires": */
1263 return false;
1264 return time_after(jiffies, then);
1265}
1266
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267static void time_out_leases(struct inode *inode)
1268{
1269 struct file_lock **before;
1270 struct file_lock *fl;
1271
1272 before = &inode->i_flock;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04001273 while ((fl = *before) && IS_LEASE(fl) && lease_breaking(fl)) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001274 if (past_time(fl->fl_downgrade_time))
1275 lease_modify(before, F_RDLCK);
1276 if (past_time(fl->fl_break_time))
1277 lease_modify(before, F_UNLCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 if (fl == *before) /* lease_modify may have freed fl */
1279 before = &fl->fl_next;
1280 }
1281}
1282
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001283static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1284{
1285 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1286 return false;
1287 return locks_conflict(breaker, lease);
1288}
1289
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290/**
1291 * __break_lease - revoke all outstanding leases on file
1292 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001293 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1294 * break all leases
1295 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1296 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297 *
david m. richter87250dd2007-05-09 16:10:27 -04001298 * break_lease (inlined for speed) has checked there already is at least
1299 * some kind of lock (maybe a lease) on this file. Leases are broken on
1300 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301 * specified %O_NONBLOCK to your open().
1302 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001303int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001305 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 struct file_lock *new_fl, *flock;
1307 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 unsigned long break_time;
1309 int i_have_this_lease = 0;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001310 bool lease_conflict = false;
Al Viro8737c932009-12-24 06:47:55 -05001311 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312
Al Viro8737c932009-12-24 06:47:55 -05001313 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001314 if (IS_ERR(new_fl))
1315 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001316 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317
Jeff Layton1c8c6012013-06-21 08:58:15 -04001318 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319
1320 time_out_leases(inode);
1321
1322 flock = inode->i_flock;
1323 if ((flock == NULL) || !IS_LEASE(flock))
1324 goto out;
1325
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001326 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1327 if (leases_conflict(fl, new_fl)) {
1328 lease_conflict = true;
1329 if (fl->fl_owner == current->files)
1330 i_have_this_lease = 1;
1331 }
1332 }
1333 if (!lease_conflict)
J. Bruce Fields778fc542011-07-26 18:25:49 -04001334 goto out;
1335
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 break_time = 0;
1337 if (lease_break_time > 0) {
1338 break_time = jiffies + lease_break_time * HZ;
1339 if (break_time == 0)
1340 break_time++; /* so that 0 means no break time */
1341 }
1342
1343 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001344 if (!leases_conflict(fl, new_fl))
1345 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001346 if (want_write) {
1347 if (fl->fl_flags & FL_UNLOCK_PENDING)
1348 continue;
1349 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001351 } else {
1352 if (lease_breaking(flock))
1353 continue;
1354 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1355 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 }
J. Bruce Fields778fc542011-07-26 18:25:49 -04001357 fl->fl_lmops->lm_break(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 }
1359
1360 if (i_have_this_lease || (mode & O_NONBLOCK)) {
1361 error = -EWOULDBLOCK;
1362 goto out;
1363 }
1364
1365restart:
1366 break_time = flock->fl_break_time;
1367 if (break_time != 0) {
1368 break_time -= jiffies;
1369 if (break_time == 0)
1370 break_time++;
1371 }
Matthew Wilcox4321e012008-01-14 21:28:30 -07001372 locks_insert_block(flock, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001373 spin_unlock(&inode->i_lock);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001374 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1375 !new_fl->fl_next, break_time);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001376 spin_lock(&inode->i_lock);
1377 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 if (error >= 0) {
1379 if (error == 0)
1380 time_out_leases(inode);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001381 /*
1382 * Wait for the next conflicting lease that has not been
1383 * broken yet
1384 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1386 flock = flock->fl_next) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001387 if (leases_conflict(new_fl, flock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 goto restart;
1389 }
1390 error = 0;
1391 }
1392
1393out:
Jeff Layton1c8c6012013-06-21 08:58:15 -04001394 spin_unlock(&inode->i_lock);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001395 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 return error;
1397}
1398
1399EXPORT_SYMBOL(__break_lease);
1400
1401/**
Randy Dunlapa6b91912008-03-19 17:01:00 -07001402 * lease_get_mtime - get the last modified time of an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 * @inode: the inode
1404 * @time: pointer to a timespec which will contain the last modified time
1405 *
1406 * This is to force NFS clients to flush their caches for files with
1407 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001408 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 */
1410void lease_get_mtime(struct inode *inode, struct timespec *time)
1411{
1412 struct file_lock *flock = inode->i_flock;
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04001413 if (flock && IS_LEASE(flock) && (flock->fl_type == F_WRLCK))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 *time = current_fs_time(inode->i_sb);
1415 else
1416 *time = inode->i_mtime;
1417}
1418
1419EXPORT_SYMBOL(lease_get_mtime);
1420
1421/**
1422 * fcntl_getlease - Enquire what lease is currently active
1423 * @filp: the file
1424 *
1425 * The value returned by this function will be one of
1426 * (if no lease break is pending):
1427 *
1428 * %F_RDLCK to indicate a shared lease is held.
1429 *
1430 * %F_WRLCK to indicate an exclusive lease is held.
1431 *
1432 * %F_UNLCK to indicate no lease is held.
1433 *
1434 * (if a lease break is pending):
1435 *
1436 * %F_RDLCK to indicate an exclusive lease needs to be
1437 * changed to a shared lease (or removed).
1438 *
1439 * %F_UNLCK to indicate the lease needs to be removed.
1440 *
1441 * XXX: sfr & willy disagree over whether F_INPROGRESS
1442 * should be returned to userspace.
1443 */
1444int fcntl_getlease(struct file *filp)
1445{
1446 struct file_lock *fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001447 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 int type = F_UNLCK;
1449
Jeff Layton1c8c6012013-06-21 08:58:15 -04001450 spin_lock(&inode->i_lock);
Al Viro496ad9a2013-01-23 17:07:38 -05001451 time_out_leases(file_inode(filp));
1452 for (fl = file_inode(filp)->i_flock; fl && IS_LEASE(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 fl = fl->fl_next) {
1454 if (fl->fl_file == filp) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001455 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 break;
1457 }
1458 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04001459 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460 return type;
1461}
1462
Jeff Layton24cbe782014-02-03 12:13:06 -05001463/**
1464 * check_conflicting_open - see if the given dentry points to a file that has
1465 * an existing open that would conflict with the
1466 * desired lease.
1467 * @dentry: dentry to check
1468 * @arg: type of lease that we're trying to acquire
1469 *
1470 * Check to see if there's an existing open fd on this file that would
1471 * conflict with the lease we're trying to set.
1472 */
1473static int
1474check_conflicting_open(const struct dentry *dentry, const long arg)
1475{
1476 int ret = 0;
1477 struct inode *inode = dentry->d_inode;
1478
1479 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1480 return -EAGAIN;
1481
1482 if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1483 (atomic_read(&inode->i_count) > 1)))
1484 ret = -EAGAIN;
1485
1486 return ret;
1487}
1488
Jeff Laytond4f22d12013-06-21 08:58:11 -04001489static int generic_add_lease(struct file *filp, long arg, struct file_lock **flp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490{
KAMBAROV, ZAUR7eaae282005-07-07 17:57:06 -07001491 struct file_lock *fl, **before, **my_before = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001492 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 struct inode *inode = dentry->d_inode;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001494 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001495 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496
J. Bruce Fields096657b2010-10-30 17:31:14 -04001497 lease = *flp;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001498 /*
1499 * In the delegation case we need mutual exclusion with
1500 * a number of operations that take the i_mutex. We trylock
1501 * because delegations are an optional optimization, and if
1502 * there's some chance of a conflict--we'd rather not
1503 * bother, maybe that's a sign this just isn't a good file to
1504 * hand out a delegation on.
1505 */
1506 if (is_deleg && !mutex_trylock(&inode->i_mutex))
1507 return -EAGAIN;
1508
1509 if (is_deleg && arg == F_WRLCK) {
1510 /* Write delegations are not currently supported: */
Dan Carpenter4fdb7932013-11-13 10:56:27 +03001511 mutex_unlock(&inode->i_mutex);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001512 WARN_ON_ONCE(1);
1513 return -EINVAL;
1514 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001515
Jeff Layton24cbe782014-02-03 12:13:06 -05001516 error = check_conflicting_open(dentry, arg);
1517 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001518 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001519
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 /*
1521 * At this point, we know that if there is an exclusive
1522 * lease on this file, then we hold it on this filp
1523 * (otherwise our open of this file would have blocked).
1524 * And if we are trying to acquire an exclusive lease,
1525 * then the file is not open by anyone (including us)
1526 * except for this filp.
1527 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001528 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 for (before = &inode->i_flock;
1530 ((fl = *before) != NULL) && IS_LEASE(fl);
1531 before = &fl->fl_next) {
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001532 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 my_before = before;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001534 continue;
1535 }
1536 /*
1537 * No exclusive leases if someone else has a lease on
1538 * this file:
1539 */
1540 if (arg == F_WRLCK)
1541 goto out;
1542 /*
1543 * Modifying our existing lease is OK, but no getting a
1544 * new lease if someone else is opening for write:
1545 */
1546 if (fl->fl_flags & FL_UNLOCK_PENDING)
1547 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 }
1549
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 if (my_before != NULL) {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001551 error = lease->fl_lmops->lm_change(my_before, arg);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001552 if (!error)
1553 *flp = *my_before;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 goto out;
1555 }
1556
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 error = -EINVAL;
1558 if (!leases_enable)
1559 goto out;
1560
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001561 locks_insert_lock(before, lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001562 /*
1563 * The check in break_lease() is lockless. It's possible for another
1564 * open to race in after we did the earlier check for a conflicting
1565 * open but before the lease was inserted. Check again for a
1566 * conflicting open and cancel the lease if there is one.
1567 *
1568 * We also add a barrier here to ensure that the insertion of the lock
1569 * precedes these checks.
1570 */
1571 smp_mb();
1572 error = check_conflicting_open(dentry, arg);
1573 if (error)
1574 locks_unlink_lock(flp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575out:
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001576 if (is_deleg)
1577 mutex_unlock(&inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578 return error;
1579}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001580
Jeff Laytond4f22d12013-06-21 08:58:11 -04001581static int generic_delete_lease(struct file *filp, struct file_lock **flp)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001582{
1583 struct file_lock *fl, **before;
1584 struct dentry *dentry = filp->f_path.dentry;
1585 struct inode *inode = dentry->d_inode;
1586
1587 for (before = &inode->i_flock;
1588 ((fl = *before) != NULL) && IS_LEASE(fl);
1589 before = &fl->fl_next) {
1590 if (fl->fl_file != filp)
1591 continue;
1592 return (*flp)->fl_lmops->lm_change(before, F_UNLCK);
1593 }
1594 return -EAGAIN;
1595}
1596
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597/**
1598 * generic_setlease - sets a lease on an open file
1599 * @filp: file pointer
1600 * @arg: type of lease to obtain
1601 * @flp: input - file_lock to use, output - file_lock inserted
1602 *
1603 * The (input) flp->fl_lmops->lm_break function is required
1604 * by break_lease().
1605 *
Jeff Layton1c8c6012013-06-21 08:58:15 -04001606 * Called with inode->i_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 */
1608int generic_setlease(struct file *filp, long arg, struct file_lock **flp)
1609{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 struct dentry *dentry = filp->f_path.dentry;
1611 struct inode *inode = dentry->d_inode;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001612 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001614 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001615 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001617 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 error = security_file_lock(filp, arg);
1619 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001620 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621
1622 time_out_leases(inode);
1623
1624 BUG_ON(!(*flp)->fl_lmops->lm_break);
1625
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001626 switch (arg) {
1627 case F_UNLCK:
1628 return generic_delete_lease(filp, flp);
1629 case F_RDLCK:
1630 case F_WRLCK:
1631 return generic_add_lease(filp, arg, flp);
1632 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001633 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001636EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001638static int __vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
1639{
Al Viro72c2d532013-09-22 16:27:52 -04001640 if (filp->f_op->setlease)
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001641 return filp->f_op->setlease(filp, arg, lease);
1642 else
1643 return generic_setlease(filp, arg, lease);
1644}
1645
1646/**
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001647 * vfs_setlease - sets a lease on an open file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 * @filp: file pointer
1649 * @arg: type of lease to obtain
1650 * @lease: file_lock to use
1651 *
1652 * Call this to establish a lease on the file.
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001653 * The (*lease)->fl_lmops->lm_break operation must be set; if not,
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001654 * break_lease will oops!
1655 *
1656 * This will call the filesystem's setlease file method, if
1657 * defined. Note that there is no getlease method; instead, the
1658 * filesystem setlease method should call back to setlease() to
1659 * add a lease to the inode's lease list, where fcntl_getlease() can
1660 * find it. Since fcntl_getlease() only reports whether the current
1661 * task holds a lease, a cluster filesystem need only do this for
1662 * leases held by processes on this node.
1663 *
1664 * There is also no break_lease method; filesystems that
Adam Buchbinderc9404c92009-12-18 15:40:42 -05001665 * handle their own leases should break leases themselves from the
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001666 * filesystem's open, create, and (on truncate) setattr methods.
1667 *
1668 * Warning: the only current setlease methods exist only to disable
1669 * leases in certain cases. More vfs changes may be required to
1670 * allow a full filesystem lease implementation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 */
1672
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001673int vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674{
Jeff Layton1c8c6012013-06-21 08:58:15 -04001675 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 int error;
1677
Jeff Layton1c8c6012013-06-21 08:58:15 -04001678 spin_lock(&inode->i_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001679 error = __vfs_setlease(filp, arg, lease);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001680 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681
1682 return error;
1683}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001684EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001686static int do_fcntl_delete_lease(struct file *filp)
1687{
1688 struct file_lock fl, *flp = &fl;
1689
1690 lease_init(filp, F_UNLCK, flp);
1691
1692 return vfs_setlease(filp, F_UNLCK, &flp);
1693}
1694
1695static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696{
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001697 struct file_lock *fl, *ret;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001698 struct inode *inode = file_inode(filp);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001699 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700 int error;
1701
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001702 fl = lease_alloc(filp, arg);
1703 if (IS_ERR(fl))
1704 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001706 new = fasync_alloc();
1707 if (!new) {
1708 locks_free_lock(fl);
1709 return -ENOMEM;
1710 }
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001711 ret = fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001712 spin_lock(&inode->i_lock);
J. Bruce Fields8896b932010-11-03 18:09:18 -04001713 error = __vfs_setlease(filp, arg, &ret);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001714 if (error) {
Jeff Layton1c8c6012013-06-21 08:58:15 -04001715 spin_unlock(&inode->i_lock);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001716 locks_free_lock(fl);
1717 goto out_free_fasync;
1718 }
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001719 if (ret != fl)
1720 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001722 /*
1723 * fasync_insert_entry() returns the old entry if any.
1724 * If there was no old entry, then it used 'new' and
1725 * inserted it into the fasync list. Clear new so that
1726 * we don't release it here.
1727 */
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001728 if (!fasync_insert_entry(fd, filp, &ret->fl_fasync, new))
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001729 new = NULL;
1730
J. Bruce Fields8896b932010-11-03 18:09:18 -04001731 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001732 spin_unlock(&inode->i_lock);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001733
1734out_free_fasync:
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001735 if (new)
1736 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737 return error;
1738}
1739
1740/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001741 * fcntl_setlease - sets a lease on an open file
1742 * @fd: open file descriptor
1743 * @filp: file pointer
1744 * @arg: type of lease to obtain
1745 *
1746 * Call this fcntl to establish a lease on the file.
1747 * Note that you also need to call %F_SETSIG to
1748 * receive a signal when the lease is broken.
1749 */
1750int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1751{
1752 if (arg == F_UNLCK)
1753 return do_fcntl_delete_lease(filp);
1754 return do_fcntl_add_lease(fd, filp, arg);
1755}
1756
1757/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1759 * @filp: The file to apply the lock to
1760 * @fl: The lock to be applied
1761 *
1762 * Add a FLOCK style lock to a file.
1763 */
1764int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1765{
1766 int error;
1767 might_sleep();
1768 for (;;) {
1769 error = flock_lock_file(filp, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001770 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 break;
1772 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1773 if (!error)
1774 continue;
1775
1776 locks_delete_block(fl);
1777 break;
1778 }
1779 return error;
1780}
1781
1782EXPORT_SYMBOL(flock_lock_file_wait);
1783
1784/**
1785 * sys_flock: - flock() system call.
1786 * @fd: the file descriptor to lock.
1787 * @cmd: the type of lock to apply.
1788 *
1789 * Apply a %FL_FLOCK style lock to an open file descriptor.
1790 * The @cmd can be one of
1791 *
1792 * %LOCK_SH -- a shared lock.
1793 *
1794 * %LOCK_EX -- an exclusive lock.
1795 *
1796 * %LOCK_UN -- remove an existing lock.
1797 *
1798 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1799 *
1800 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1801 * processes read and write access respectively.
1802 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001803SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804{
Al Viro2903ff02012-08-28 12:52:22 -04001805 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 struct file_lock *lock;
1807 int can_sleep, unlock;
1808 int error;
1809
1810 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001811 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 goto out;
1813
1814 can_sleep = !(cmd & LOCK_NB);
1815 cmd &= ~LOCK_NB;
1816 unlock = (cmd == LOCK_UN);
1817
Al Viroaeb5d722008-09-02 15:28:45 -04001818 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04001819 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 goto out_putf;
1821
Al Viro2903ff02012-08-28 12:52:22 -04001822 error = flock_make_lock(f.file, &lock, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 if (error)
1824 goto out_putf;
1825 if (can_sleep)
1826 lock->fl_flags |= FL_SLEEP;
1827
Al Viro2903ff02012-08-28 12:52:22 -04001828 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 if (error)
1830 goto out_free;
1831
Al Viro72c2d532013-09-22 16:27:52 -04001832 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04001833 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 (can_sleep) ? F_SETLKW : F_SETLK,
1835 lock);
1836 else
Al Viro2903ff02012-08-28 12:52:22 -04001837 error = flock_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838
1839 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08001840 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841
1842 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04001843 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 out:
1845 return error;
1846}
1847
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001848/**
1849 * vfs_test_lock - test file byte range lock
1850 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04001851 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001852 *
1853 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1854 * setting conf->fl_type to something other than F_UNLCK.
1855 */
1856int vfs_test_lock(struct file *filp, struct file_lock *fl)
1857{
Al Viro72c2d532013-09-22 16:27:52 -04001858 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001859 return filp->f_op->lock(filp, F_GETLK, fl);
1860 posix_test_lock(filp, fl);
1861 return 0;
1862}
1863EXPORT_SYMBOL_GPL(vfs_test_lock);
1864
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001865static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1866{
Jeff Layton3fd80cd2014-02-03 12:13:09 -05001867 flock->l_pid = IS_FILE_PVT(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001868#if BITS_PER_LONG == 32
1869 /*
1870 * Make sure we can represent the posix lock via
1871 * legacy 32bit flock.
1872 */
1873 if (fl->fl_start > OFFT_OFFSET_MAX)
1874 return -EOVERFLOW;
1875 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1876 return -EOVERFLOW;
1877#endif
1878 flock->l_start = fl->fl_start;
1879 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1880 fl->fl_end - fl->fl_start + 1;
1881 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04001882 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001883 return 0;
1884}
1885
1886#if BITS_PER_LONG == 32
1887static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1888{
Jeff Layton3fd80cd2014-02-03 12:13:09 -05001889 flock->l_pid = IS_FILE_PVT(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001890 flock->l_start = fl->fl_start;
1891 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1892 fl->fl_end - fl->fl_start + 1;
1893 flock->l_whence = 0;
1894 flock->l_type = fl->fl_type;
1895}
1896#endif
1897
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898/* Report the first existing lock that would conflict with l.
1899 * This implements the F_GETLK command of fcntl().
1900 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001901int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001903 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 struct flock flock;
1905 int error;
1906
1907 error = -EFAULT;
1908 if (copy_from_user(&flock, l, sizeof(flock)))
1909 goto out;
1910 error = -EINVAL;
1911 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1912 goto out;
1913
1914 error = flock_to_posix_lock(filp, &file_lock, &flock);
1915 if (error)
1916 goto out;
1917
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001918 error = vfs_test_lock(filp, &file_lock);
1919 if (error)
1920 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001922 flock.l_type = file_lock.fl_type;
1923 if (file_lock.fl_type != F_UNLCK) {
1924 error = posix_lock_to_flock(&flock, &file_lock);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001925 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927 }
1928 error = -EFAULT;
1929 if (!copy_to_user(l, &flock, sizeof(flock)))
1930 error = 0;
1931out:
1932 return error;
1933}
1934
Marc Eshel7723ec92007-01-18 15:08:55 -05001935/**
1936 * vfs_lock_file - file byte range lock
1937 * @filp: The file to apply the lock to
1938 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1939 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001940 * @conf: Place to return a copy of the conflicting lock, if found.
1941 *
1942 * A caller that doesn't care about the conflicting lock may pass NULL
1943 * as the final argument.
1944 *
1945 * If the filesystem defines a private ->lock() method, then @conf will
1946 * be left unchanged; so a caller that cares should initialize it to
1947 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05001948 *
1949 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1950 * locks, the ->lock() interface may return asynchronously, before the lock has
1951 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001952 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05001953 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1954 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001955 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05001956 * request completes.
1957 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07001958 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
1959 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05001960 * nonzero return code and the file system should release the lock. The file
1961 * system is also responsible to keep a corresponding posix lock when it
1962 * grants a lock so the VFS can find out which locks are locally held and do
1963 * the correct lock cleanup when required.
1964 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001965 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05001966 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05001967 */
Marc Eshel150b3932007-01-18 16:15:35 -05001968int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05001969{
Al Viro72c2d532013-09-22 16:27:52 -04001970 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05001971 return filp->f_op->lock(filp, cmd, fl);
1972 else
Marc Eshel150b3932007-01-18 16:15:35 -05001973 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05001974}
1975EXPORT_SYMBOL_GPL(vfs_lock_file);
1976
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001977static int do_lock_file_wait(struct file *filp, unsigned int cmd,
1978 struct file_lock *fl)
1979{
1980 int error;
1981
1982 error = security_file_lock(filp, fl->fl_type);
1983 if (error)
1984 return error;
1985
Miklos Szeredi764c76b2008-07-25 01:48:58 -07001986 for (;;) {
1987 error = vfs_lock_file(filp, cmd, fl, NULL);
1988 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001989 break;
Miklos Szeredi764c76b2008-07-25 01:48:58 -07001990 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1991 if (!error)
1992 continue;
1993
1994 locks_delete_block(fl);
1995 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001996 }
1997
1998 return error;
1999}
2000
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001/* Apply the lock described by l to an open file descriptor.
2002 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2003 */
Peter Staubachc2936212005-07-27 11:45:09 -07002004int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
2005 struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006{
2007 struct file_lock *file_lock = locks_alloc_lock();
2008 struct flock flock;
2009 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002010 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011 int error;
2012
2013 if (file_lock == NULL)
2014 return -ENOLCK;
2015
2016 /*
2017 * This might block, so we do it before checking the inode.
2018 */
2019 error = -EFAULT;
2020 if (copy_from_user(&flock, l, sizeof(flock)))
2021 goto out;
2022
Al Viro496ad9a2013-01-23 17:07:38 -05002023 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024
2025 /* Don't allow mandatory locks on files that may be memory mapped
2026 * and shared.
2027 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002028 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 error = -EAGAIN;
2030 goto out;
2031 }
2032
Peter Staubachc2936212005-07-27 11:45:09 -07002033again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 error = flock_to_posix_lock(filp, file_lock, &flock);
2035 if (error)
2036 goto out;
2037 if (cmd == F_SETLKW) {
2038 file_lock->fl_flags |= FL_SLEEP;
2039 }
2040
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002041 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042
Peter Staubachc2936212005-07-27 11:45:09 -07002043 /*
2044 * Attempt to detect a close/fcntl race and recover by
2045 * releasing the lock that was just acquired.
2046 */
Al Viro0b2bac22008-05-06 13:58:34 -04002047 /*
2048 * we need that spin_lock here - it prevents reordering between
2049 * update of inode->i_flock and check for it done in close().
2050 * rcu_read_lock() wouldn't do.
2051 */
2052 spin_lock(&current->files->file_lock);
2053 f = fcheck(fd);
2054 spin_unlock(&current->files->file_lock);
2055 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002056 flock.l_type = F_UNLCK;
2057 goto again;
2058 }
2059
2060out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061 locks_free_lock(file_lock);
2062 return error;
2063}
2064
2065#if BITS_PER_LONG == 32
2066/* Report the first existing lock that would conflict with l.
2067 * This implements the F_GETLK command of fcntl().
2068 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05002069int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002071 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072 struct flock64 flock;
2073 int error;
2074
2075 error = -EFAULT;
2076 if (copy_from_user(&flock, l, sizeof(flock)))
2077 goto out;
2078 error = -EINVAL;
2079 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2080 goto out;
2081
2082 error = flock64_to_posix_lock(filp, &file_lock, &flock);
2083 if (error)
2084 goto out;
2085
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002086 error = vfs_test_lock(filp, &file_lock);
2087 if (error)
2088 goto out;
2089
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002090 flock.l_type = file_lock.fl_type;
2091 if (file_lock.fl_type != F_UNLCK)
2092 posix_lock_to_flock64(&flock, &file_lock);
2093
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 error = -EFAULT;
2095 if (!copy_to_user(l, &flock, sizeof(flock)))
2096 error = 0;
2097
2098out:
2099 return error;
2100}
2101
2102/* Apply the lock described by l to an open file descriptor.
2103 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2104 */
Peter Staubachc2936212005-07-27 11:45:09 -07002105int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2106 struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107{
2108 struct file_lock *file_lock = locks_alloc_lock();
2109 struct flock64 flock;
2110 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002111 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112 int error;
2113
2114 if (file_lock == NULL)
2115 return -ENOLCK;
2116
2117 /*
2118 * This might block, so we do it before checking the inode.
2119 */
2120 error = -EFAULT;
2121 if (copy_from_user(&flock, l, sizeof(flock)))
2122 goto out;
2123
Al Viro496ad9a2013-01-23 17:07:38 -05002124 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125
2126 /* Don't allow mandatory locks on files that may be memory mapped
2127 * and shared.
2128 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002129 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 error = -EAGAIN;
2131 goto out;
2132 }
2133
Peter Staubachc2936212005-07-27 11:45:09 -07002134again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 error = flock64_to_posix_lock(filp, file_lock, &flock);
2136 if (error)
2137 goto out;
2138 if (cmd == F_SETLKW64) {
2139 file_lock->fl_flags |= FL_SLEEP;
2140 }
2141
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002142 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143
Peter Staubachc2936212005-07-27 11:45:09 -07002144 /*
2145 * Attempt to detect a close/fcntl race and recover by
2146 * releasing the lock that was just acquired.
2147 */
Al Viro0b2bac22008-05-06 13:58:34 -04002148 spin_lock(&current->files->file_lock);
2149 f = fcheck(fd);
2150 spin_unlock(&current->files->file_lock);
2151 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002152 flock.l_type = F_UNLCK;
2153 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 }
2155
2156out:
2157 locks_free_lock(file_lock);
2158 return error;
2159}
2160#endif /* BITS_PER_LONG == 32 */
2161
2162/*
2163 * This function is called when the file is being removed
2164 * from the task's fd array. POSIX locks belonging to this task
2165 * are deleted at this time.
2166 */
2167void locks_remove_posix(struct file *filp, fl_owner_t owner)
2168{
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002169 struct file_lock lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170
2171 /*
2172 * If there are no locks held on this file, we don't need to call
2173 * posix_lock_file(). Another process could be setting a lock on this
2174 * file at the same time, but we wouldn't remove that lock anyway.
2175 */
Al Viro496ad9a2013-01-23 17:07:38 -05002176 if (!file_inode(filp)->i_flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 return;
2178
2179 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002180 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 lock.fl_start = 0;
2182 lock.fl_end = OFFSET_MAX;
2183 lock.fl_owner = owner;
2184 lock.fl_pid = current->tgid;
2185 lock.fl_file = filp;
2186 lock.fl_ops = NULL;
2187 lock.fl_lmops = NULL;
2188
Marc Eshel150b3932007-01-18 16:15:35 -05002189 vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2192 lock.fl_ops->fl_release_private(&lock);
2193}
2194
2195EXPORT_SYMBOL(locks_remove_posix);
2196
2197/*
2198 * This function is called on the last close of an open file.
2199 */
Jeff Layton78ed8a12014-02-03 12:13:08 -05002200void locks_remove_file(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201{
Al Viro496ad9a2013-01-23 17:07:38 -05002202 struct inode * inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 struct file_lock *fl;
2204 struct file_lock **before;
2205
2206 if (!inode->i_flock)
2207 return;
2208
Al Viro72c2d532013-09-22 16:27:52 -04002209 if (filp->f_op->flock) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 struct file_lock fl = {
2211 .fl_pid = current->tgid,
2212 .fl_file = filp,
2213 .fl_flags = FL_FLOCK,
2214 .fl_type = F_UNLCK,
2215 .fl_end = OFFSET_MAX,
2216 };
2217 filp->f_op->flock(filp, F_SETLKW, &fl);
Trond Myklebust80fec4c2005-06-22 17:16:31 +00002218 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2219 fl.fl_ops->fl_release_private(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 }
2221
Jeff Layton1c8c6012013-06-21 08:58:15 -04002222 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 before = &inode->i_flock;
2224
2225 while ((fl = *before) != NULL) {
2226 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227 if (IS_LEASE(fl)) {
2228 lease_modify(before, F_UNLCK);
2229 continue;
2230 }
Jeff Layton8c3cac52014-02-03 12:13:07 -05002231
2232 /*
2233 * There's a leftover lock on the list of a type that
2234 * we didn't expect to see. Most likely a classic
2235 * POSIX lock that ended up not getting released
2236 * properly, or that raced onto the list somehow. Log
2237 * some info about it and then just remove it from
2238 * the list.
2239 */
2240 WARN(!IS_FLOCK(fl),
2241 "leftover lock: dev=%u:%u ino=%lu type=%hhd flags=0x%x start=%lld end=%lld\n",
2242 MAJOR(inode->i_sb->s_dev),
2243 MINOR(inode->i_sb->s_dev), inode->i_ino,
2244 fl->fl_type, fl->fl_flags,
2245 fl->fl_start, fl->fl_end);
2246
2247 locks_delete_lock(before);
2248 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249 }
2250 before = &fl->fl_next;
2251 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002252 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253}
2254
2255/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 * posix_unblock_lock - stop waiting for a file lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257 * @waiter: the lock which was waiting
2258 *
2259 * lockd needs to block waiting for locks.
2260 */
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002261int
Jeff Laytonf891a292013-06-21 08:58:09 -04002262posix_unblock_lock(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263{
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002264 int status = 0;
2265
Jeff Layton7b2296a2013-06-21 08:58:20 -04002266 spin_lock(&blocked_lock_lock);
J. Bruce Fields5996a292006-01-03 09:55:44 +01002267 if (waiter->fl_next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268 __locks_delete_block(waiter);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002269 else
2270 status = -ENOENT;
Jeff Layton7b2296a2013-06-21 08:58:20 -04002271 spin_unlock(&blocked_lock_lock);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002272 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274EXPORT_SYMBOL(posix_unblock_lock);
2275
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002276/**
2277 * vfs_cancel_lock - file byte range unblock lock
2278 * @filp: The file to apply the unblock to
2279 * @fl: The lock to be unblocked
2280 *
2281 * Used by lock managers to cancel blocked requests
2282 */
2283int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2284{
Al Viro72c2d532013-09-22 16:27:52 -04002285 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002286 return filp->f_op->lock(filp, F_CANCELLK, fl);
2287 return 0;
2288}
2289
2290EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2291
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002292#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002293#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002294#include <linux/seq_file.h>
2295
Jeff Layton7012b022013-06-21 08:58:22 -04002296struct locks_iterator {
2297 int li_cpu;
2298 loff_t li_pos;
2299};
2300
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002301static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002302 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303{
2304 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002305 unsigned int fl_pid;
2306
2307 if (fl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -08002308 fl_pid = pid_vnr(fl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002309 else
2310 fl_pid = fl->fl_pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311
2312 if (fl->fl_file != NULL)
Al Viro496ad9a2013-01-23 17:07:38 -05002313 inode = file_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314
Jerome Marchand99dc8292010-10-26 14:22:33 -07002315 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316 if (IS_POSIX(fl)) {
Jeff Laytonc918d422014-02-03 12:13:09 -05002317 if (fl->fl_flags & FL_ACCESS)
2318 seq_printf(f, "ACCESS");
2319 else if (IS_FILE_PVT(fl))
2320 seq_printf(f, "FLPVT ");
2321 else
2322 seq_printf(f, "POSIX ");
2323
2324 seq_printf(f, " %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002326 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327 } else if (IS_FLOCK(fl)) {
2328 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002329 seq_printf(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002331 seq_printf(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 }
2333 } else if (IS_LEASE(fl)) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002334 seq_printf(f, "LEASE ");
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002335 if (lease_breaking(fl))
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002336 seq_printf(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 else if (fl->fl_file)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002338 seq_printf(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002340 seq_printf(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002342 seq_printf(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343 }
2344 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002345 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346 (fl->fl_type & LOCK_READ)
2347 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2348 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2349 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002350 seq_printf(f, "%s ",
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002351 (lease_breaking(fl))
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04002352 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2353 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354 }
2355 if (inode) {
2356#ifdef WE_CAN_BREAK_LSLK_NOW
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002357 seq_printf(f, "%d %s:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358 inode->i_sb->s_id, inode->i_ino);
2359#else
2360 /* userspace relies on this representation of dev_t ;-( */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002361 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 MAJOR(inode->i_sb->s_dev),
2363 MINOR(inode->i_sb->s_dev), inode->i_ino);
2364#endif
2365 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002366 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367 }
2368 if (IS_POSIX(fl)) {
2369 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002370 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002372 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002374 seq_printf(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375 }
2376}
2377
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002378static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379{
Jeff Layton7012b022013-06-21 08:58:22 -04002380 struct locks_iterator *iter = f->private;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002381 struct file_lock *fl, *bfl;
2382
Jeff Layton139ca042013-06-21 08:58:17 -04002383 fl = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002384
Jeff Layton7012b022013-06-21 08:58:22 -04002385 lock_get_status(f, fl, iter->li_pos, "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002386
2387 list_for_each_entry(bfl, &fl->fl_block, fl_block)
Jeff Layton7012b022013-06-21 08:58:22 -04002388 lock_get_status(f, bfl, iter->li_pos, " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002389
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002390 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391}
2392
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002393static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002394 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395{
Jeff Layton7012b022013-06-21 08:58:22 -04002396 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002397
Jeff Layton7012b022013-06-21 08:58:22 -04002398 iter->li_pos = *pos + 1;
2399 lg_global_lock(&file_lock_lglock);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002400 spin_lock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002401 return seq_hlist_start_percpu(&file_lock_list, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402}
2403
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002404static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2405{
Jeff Layton7012b022013-06-21 08:58:22 -04002406 struct locks_iterator *iter = f->private;
2407
2408 ++iter->li_pos;
2409 return seq_hlist_next_percpu(v, &file_lock_list, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002410}
2411
2412static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002413 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002414{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002415 spin_unlock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002416 lg_global_unlock(&file_lock_lglock);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002417}
2418
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002419static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002420 .start = locks_start,
2421 .next = locks_next,
2422 .stop = locks_stop,
2423 .show = locks_show,
2424};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002425
2426static int locks_open(struct inode *inode, struct file *filp)
2427{
Jeff Layton7012b022013-06-21 08:58:22 -04002428 return seq_open_private(filp, &locks_seq_operations,
2429 sizeof(struct locks_iterator));
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002430}
2431
2432static const struct file_operations proc_locks_operations = {
2433 .open = locks_open,
2434 .read = seq_read,
2435 .llseek = seq_lseek,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002436 .release = seq_release_private,
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002437};
2438
2439static int __init proc_locks_init(void)
2440{
2441 proc_create("locks", 0, NULL, &proc_locks_operations);
2442 return 0;
2443}
2444module_init(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002445#endif
2446
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447/**
2448 * lock_may_read - checks that the region is free of locks
2449 * @inode: the inode that is being read
2450 * @start: the first byte to read
2451 * @len: the number of bytes to read
2452 *
2453 * Emulates Windows locking requirements. Whole-file
2454 * mandatory locks (share modes) can prohibit a read and
2455 * byte-range POSIX locks can prohibit a read if they overlap.
2456 *
2457 * N.B. this function is only ever called
2458 * from knfsd and ownership of locks is never checked.
2459 */
2460int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2461{
2462 struct file_lock *fl;
2463 int result = 1;
Jeff Layton1c8c6012013-06-21 08:58:15 -04002464
2465 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002466 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2467 if (IS_POSIX(fl)) {
2468 if (fl->fl_type == F_RDLCK)
2469 continue;
2470 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2471 continue;
2472 } else if (IS_FLOCK(fl)) {
2473 if (!(fl->fl_type & LOCK_MAND))
2474 continue;
2475 if (fl->fl_type & LOCK_READ)
2476 continue;
2477 } else
2478 continue;
2479 result = 0;
2480 break;
2481 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002482 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483 return result;
2484}
2485
2486EXPORT_SYMBOL(lock_may_read);
2487
2488/**
2489 * lock_may_write - checks that the region is free of locks
2490 * @inode: the inode that is being written
2491 * @start: the first byte to write
2492 * @len: the number of bytes to write
2493 *
2494 * Emulates Windows locking requirements. Whole-file
2495 * mandatory locks (share modes) can prohibit a write and
2496 * byte-range POSIX locks can prohibit a write if they overlap.
2497 *
2498 * N.B. this function is only ever called
2499 * from knfsd and ownership of locks is never checked.
2500 */
2501int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2502{
2503 struct file_lock *fl;
2504 int result = 1;
Jeff Layton1c8c6012013-06-21 08:58:15 -04002505
2506 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2508 if (IS_POSIX(fl)) {
2509 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2510 continue;
2511 } else if (IS_FLOCK(fl)) {
2512 if (!(fl->fl_type & LOCK_MAND))
2513 continue;
2514 if (fl->fl_type & LOCK_WRITE)
2515 continue;
2516 } else
2517 continue;
2518 result = 0;
2519 break;
2520 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002521 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522 return result;
2523}
2524
2525EXPORT_SYMBOL(lock_may_write);
2526
Linus Torvalds1da177e2005-04-16 15:20:36 -07002527static int __init filelock_init(void)
2528{
Jeff Layton7012b022013-06-21 08:58:22 -04002529 int i;
2530
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002532 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2533
Jeff Layton7012b022013-06-21 08:58:22 -04002534 lg_lock_init(&file_lock_lglock, "file_lock_lglock");
2535
2536 for_each_possible_cpu(i)
2537 INIT_HLIST_HEAD(per_cpu_ptr(&file_lock_list, i));
2538
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539 return 0;
2540}
2541
2542core_initcall(filelock_init);