blob: d82c51c4fcd22d0a44b78f3274676c25a8bbbdff [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);
Jeff Layton57b65322014-02-03 12:13:09 -0500567 if (IS_POSIX(blocker) && !IS_FILE_PVT(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.
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400760 * To handle those cases, we just bail out after a few iterations.
Jeff Layton57b65322014-02-03 12:13:09 -0500761 *
762 * For FL_FILE_PVT locks, the owner is the filp, not the files_struct.
763 * Because the owner is not even nominally tied to a thread of
764 * execution, the deadlock detection below can't reasonably work well. Just
765 * skip it for those.
766 *
767 * In principle, we could do a more limited deadlock detection on FL_FILE_PVT
768 * locks that just checks for the case where two tasks are attempting to
769 * upgrade from read to write locks on the same inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400771
772#define MAX_DEADLK_ITERATIONS 10
773
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400774/* Find a lock that the owner of the given block_fl is blocking on. */
775static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
776{
777 struct file_lock *fl;
778
Jeff Layton3999e492013-06-21 08:58:19 -0400779 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400780 if (posix_same_owner(fl, block_fl))
781 return fl->fl_next;
782 }
783 return NULL;
784}
785
Jeff Layton7b2296a2013-06-21 08:58:20 -0400786/* Must be called with the blocked_lock_lock held! */
Adrian Bunkb0904e12006-06-23 02:05:13 -0700787static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 struct file_lock *block_fl)
789{
J. Bruce Fields97855b42007-10-30 11:20:02 -0400790 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
Jeff Layton57b65322014-02-03 12:13:09 -0500792 /*
793 * This deadlock detector can't reasonably detect deadlocks with
794 * FL_FILE_PVT locks, since they aren't owned by a process, per-se.
795 */
796 if (IS_FILE_PVT(caller_fl))
797 return 0;
798
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400799 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
800 if (i++ > MAX_DEADLK_ITERATIONS)
801 return 0;
802 if (posix_same_owner(caller_fl, block_fl))
803 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 }
805 return 0;
806}
807
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -0400809 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -0400810 *
811 * Note that if called with an FL_EXISTS argument, the caller may determine
812 * whether or not a lock was successfully freed by testing the return
813 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 */
Trond Myklebust993dfa82006-03-31 02:30:55 -0800815static int flock_lock_file(struct file *filp, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816{
Trond Myklebust993dfa82006-03-31 02:30:55 -0800817 struct file_lock *new_fl = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 struct file_lock **before;
Al Viro496ad9a2013-01-23 17:07:38 -0500819 struct inode * inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 int error = 0;
821 int found = 0;
822
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200823 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
824 new_fl = locks_alloc_lock();
825 if (!new_fl)
826 return -ENOMEM;
827 }
828
Jeff Layton1c8c6012013-06-21 08:58:15 -0400829 spin_lock(&inode->i_lock);
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400830 if (request->fl_flags & FL_ACCESS)
831 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +0400832
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 for_each_lock(inode, before) {
834 struct file_lock *fl = *before;
835 if (IS_POSIX(fl))
836 break;
837 if (IS_LEASE(fl))
838 continue;
839 if (filp != fl->fl_file)
840 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800841 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 goto out;
843 found = 1;
844 locks_delete_lock(before);
845 break;
846 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847
Trond Myklebustf475ae92006-06-29 16:38:32 -0400848 if (request->fl_type == F_UNLCK) {
849 if ((request->fl_flags & FL_EXISTS) && !found)
850 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800851 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400852 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853
854 /*
855 * If a higher-priority process was blocked on the old file lock,
856 * give it the opportunity to lock the file.
857 */
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200858 if (found) {
Jeff Layton1c8c6012013-06-21 08:58:15 -0400859 spin_unlock(&inode->i_lock);
Frederic Weisbeckerdef01bc2009-07-16 15:44:29 +0200860 cond_resched();
Jeff Layton1c8c6012013-06-21 08:58:15 -0400861 spin_lock(&inode->i_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200862 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400864find_conflict:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 for_each_lock(inode, before) {
866 struct file_lock *fl = *before;
867 if (IS_POSIX(fl))
868 break;
869 if (IS_LEASE(fl))
870 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800871 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 continue;
873 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700874 if (!(request->fl_flags & FL_SLEEP))
875 goto out;
876 error = FILE_LOCK_DEFERRED;
877 locks_insert_block(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 goto out;
879 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400880 if (request->fl_flags & FL_ACCESS)
881 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800882 locks_copy_lock(new_fl, request);
Pavel Emelyanov0e2f6db2007-09-11 15:24:01 -0700883 locks_insert_lock(before, new_fl);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800884 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +0400885 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886
887out:
Jeff Layton1c8c6012013-06-21 08:58:15 -0400888 spin_unlock(&inode->i_lock);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800889 if (new_fl)
890 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 return error;
892}
893
Marc Eshel150b3932007-01-18 16:15:35 -0500894static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895{
896 struct file_lock *fl;
Miklos Szeredi39005d02006-06-23 02:05:10 -0700897 struct file_lock *new_fl = NULL;
898 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 struct file_lock *left = NULL;
900 struct file_lock *right = NULL;
901 struct file_lock **before;
Jeff Laytonb9746ef2013-06-21 08:58:13 -0400902 int error;
903 bool added = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
905 /*
906 * We may need two file_lock structures for this operation,
907 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -0700908 *
909 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 */
Miklos Szeredi39005d02006-06-23 02:05:10 -0700911 if (!(request->fl_flags & FL_ACCESS) &&
912 (request->fl_type != F_UNLCK ||
913 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
914 new_fl = locks_alloc_lock();
915 new_fl2 = locks_alloc_lock();
916 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917
Jeff Layton1c8c6012013-06-21 08:58:15 -0400918 spin_lock(&inode->i_lock);
Jeff Layton1cb36012013-06-21 08:58:12 -0400919 /*
920 * New lock request. Walk all POSIX locks and look for conflicts. If
921 * there are any, either return error or put the request on the
Jeff Layton48f74182013-06-21 08:58:18 -0400922 * blocker's list of waiters and the global blocked_hash.
Jeff Layton1cb36012013-06-21 08:58:12 -0400923 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 if (request->fl_type != F_UNLCK) {
925 for_each_lock(inode, before) {
J. Bruce Fields526985b2006-11-14 16:54:36 -0500926 fl = *before;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 if (!IS_POSIX(fl))
928 continue;
929 if (!posix_locks_conflict(request, fl))
930 continue;
Andy Adamson5842add2006-03-26 01:37:26 -0800931 if (conflock)
J. Bruce Fields1a747ee2008-04-24 10:08:22 -0400932 __locks_copy_lock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 error = -EAGAIN;
934 if (!(request->fl_flags & FL_SLEEP))
935 goto out;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400936 /*
937 * Deadlock detection and insertion into the blocked
938 * locks list must be done while holding the same lock!
939 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 error = -EDEADLK;
Jeff Layton7b2296a2013-06-21 08:58:20 -0400941 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400942 if (likely(!posix_locks_deadlock(request, fl))) {
943 error = FILE_LOCK_DEFERRED;
944 __locks_insert_block(fl, request);
945 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400946 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 goto out;
948 }
949 }
950
951 /* If we're just looking for a conflict, we're done. */
952 error = 0;
953 if (request->fl_flags & FL_ACCESS)
954 goto out;
955
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 * Find the first old lock with the same owner as the new lock.
958 */
959
960 before = &inode->i_flock;
961
962 /* First skip locks owned by other processes. */
963 while ((fl = *before) && (!IS_POSIX(fl) ||
964 !posix_same_owner(request, fl))) {
965 before = &fl->fl_next;
966 }
967
Jeff Layton1cb36012013-06-21 08:58:12 -0400968 /* Process locks with this owner. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 while ((fl = *before) && posix_same_owner(request, fl)) {
970 /* Detect adjacent or overlapping regions (if same lock type)
971 */
972 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -0700973 /* In all comparisons of start vs end, use
974 * "start - 1" rather than "end + 1". If end
975 * is OFFSET_MAX, end + 1 will become negative.
976 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 if (fl->fl_end < request->fl_start - 1)
978 goto next_lock;
979 /* If the next lock in the list has entirely bigger
980 * addresses than the new one, insert the lock here.
981 */
Olaf Kirch449231d2005-08-25 16:25:35 -0700982 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 break;
984
985 /* If we come here, the new and old lock are of the
986 * same type and adjacent or overlapping. Make one
987 * lock yielding from the lower start address of both
988 * locks to the higher end address.
989 */
990 if (fl->fl_start > request->fl_start)
991 fl->fl_start = request->fl_start;
992 else
993 request->fl_start = fl->fl_start;
994 if (fl->fl_end < request->fl_end)
995 fl->fl_end = request->fl_end;
996 else
997 request->fl_end = fl->fl_end;
998 if (added) {
999 locks_delete_lock(before);
1000 continue;
1001 }
1002 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001003 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 }
1005 else {
1006 /* Processing for different lock types is a bit
1007 * more complex.
1008 */
1009 if (fl->fl_end < request->fl_start)
1010 goto next_lock;
1011 if (fl->fl_start > request->fl_end)
1012 break;
1013 if (request->fl_type == F_UNLCK)
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001014 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 if (fl->fl_start < request->fl_start)
1016 left = fl;
1017 /* If the next lock in the list has a higher end
1018 * address than the new one, insert the new one here.
1019 */
1020 if (fl->fl_end > request->fl_end) {
1021 right = fl;
1022 break;
1023 }
1024 if (fl->fl_start >= request->fl_start) {
1025 /* The new lock completely replaces an old
1026 * one (This may happen several times).
1027 */
1028 if (added) {
1029 locks_delete_lock(before);
1030 continue;
1031 }
1032 /* Replace the old lock with the new one.
1033 * Wake up anybody waiting for the old one,
1034 * as the change in lock type might satisfy
1035 * their needs.
1036 */
1037 locks_wake_up_blocks(fl);
1038 fl->fl_start = request->fl_start;
1039 fl->fl_end = request->fl_end;
1040 fl->fl_type = request->fl_type;
Trond Myklebust47831f32006-03-20 13:44:05 -05001041 locks_release_private(fl);
1042 locks_copy_private(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001044 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 }
1046 }
1047 /* Go on to next lock.
1048 */
1049 next_lock:
1050 before = &fl->fl_next;
1051 }
1052
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001053 /*
Jeff Layton1cb36012013-06-21 08:58:12 -04001054 * The above code only modifies existing locks in case of merging or
1055 * replacing. If new lock(s) need to be inserted all modifications are
1056 * done below this, so it's safe yet to bail out.
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001057 */
1058 error = -ENOLCK; /* "no luck" */
1059 if (right && left == right && !new_fl2)
1060 goto out;
1061
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 error = 0;
1063 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -04001064 if (request->fl_type == F_UNLCK) {
1065 if (request->fl_flags & FL_EXISTS)
1066 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001068 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001069
1070 if (!new_fl) {
1071 error = -ENOLCK;
1072 goto out;
1073 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 locks_copy_lock(new_fl, request);
1075 locks_insert_lock(before, new_fl);
1076 new_fl = NULL;
1077 }
1078 if (right) {
1079 if (left == right) {
1080 /* The new lock breaks the old one in two pieces,
1081 * so we have to use the second new lock.
1082 */
1083 left = new_fl2;
1084 new_fl2 = NULL;
1085 locks_copy_lock(left, right);
1086 locks_insert_lock(before, left);
1087 }
1088 right->fl_start = request->fl_end + 1;
1089 locks_wake_up_blocks(right);
1090 }
1091 if (left) {
1092 left->fl_end = request->fl_start - 1;
1093 locks_wake_up_blocks(left);
1094 }
1095 out:
Jeff Layton1c8c6012013-06-21 08:58:15 -04001096 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 /*
1098 * Free any unused locks.
1099 */
1100 if (new_fl)
1101 locks_free_lock(new_fl);
1102 if (new_fl2)
1103 locks_free_lock(new_fl2);
1104 return error;
1105}
1106
1107/**
1108 * posix_lock_file - Apply a POSIX-style lock to a file
1109 * @filp: The file to apply the lock to
1110 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001111 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 *
1113 * Add a POSIX style lock to a file.
1114 * We merge adjacent & overlapping locks whenever possible.
1115 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001116 *
1117 * Note that if called with an FL_EXISTS argument, the caller may determine
1118 * whether or not a lock was successfully freed by testing the return
1119 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 */
Marc Eshel150b3932007-01-18 16:15:35 -05001121int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001122 struct file_lock *conflock)
1123{
Al Viro496ad9a2013-01-23 17:07:38 -05001124 return __posix_lock_file(file_inode(filp), fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001125}
Marc Eshel150b3932007-01-18 16:15:35 -05001126EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127
1128/**
1129 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1130 * @filp: The file to apply the lock to
1131 * @fl: The lock to be applied
1132 *
1133 * Add a POSIX style lock to a file.
1134 * We merge adjacent & overlapping locks whenever possible.
1135 * POSIX locks are sorted by owner task, then by starting address
1136 */
1137int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1138{
1139 int error;
1140 might_sleep ();
1141 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001142 error = posix_lock_file(filp, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001143 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 break;
1145 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1146 if (!error)
1147 continue;
1148
1149 locks_delete_block(fl);
1150 break;
1151 }
1152 return error;
1153}
1154EXPORT_SYMBOL(posix_lock_file_wait);
1155
1156/**
1157 * locks_mandatory_locked - Check for an active lock
Jeff Laytond7a06982014-03-10 09:54:15 -04001158 * @file: the file to check
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 *
1160 * Searches the inode's list of locks to find any POSIX locks which conflict.
1161 * This function is called from locks_verify_locked() only.
1162 */
Jeff Laytond7a06982014-03-10 09:54:15 -04001163int locks_mandatory_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164{
Jeff Laytond7a06982014-03-10 09:54:15 -04001165 struct inode *inode = file_inode(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 fl_owner_t owner = current->files;
1167 struct file_lock *fl;
1168
1169 /*
1170 * Search the lock list for this inode for any POSIX locks.
1171 */
Jeff Layton1c8c6012013-06-21 08:58:15 -04001172 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1174 if (!IS_POSIX(fl))
1175 continue;
Jeff Laytond7a06982014-03-10 09:54:15 -04001176 if (fl->fl_owner != owner && fl->fl_owner != (fl_owner_t)file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177 break;
1178 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04001179 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 return fl ? -EAGAIN : 0;
1181}
1182
1183/**
1184 * locks_mandatory_area - Check for a conflicting lock
1185 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1186 * for shared
1187 * @inode: the file to check
1188 * @filp: how the file was opened (if it was)
1189 * @offset: start of area to check
1190 * @count: length of area to check
1191 *
1192 * Searches the inode's list of locks to find any POSIX locks which conflict.
1193 * This function is called from rw_verify_area() and
1194 * locks_verify_truncate().
1195 */
1196int locks_mandatory_area(int read_write, struct inode *inode,
1197 struct file *filp, loff_t offset,
1198 size_t count)
1199{
1200 struct file_lock fl;
1201 int error;
1202
1203 locks_init_lock(&fl);
1204 fl.fl_owner = current->files;
1205 fl.fl_pid = current->tgid;
1206 fl.fl_file = filp;
1207 fl.fl_flags = FL_POSIX | FL_ACCESS;
1208 if (filp && !(filp->f_flags & O_NONBLOCK))
1209 fl.fl_flags |= FL_SLEEP;
1210 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1211 fl.fl_start = offset;
1212 fl.fl_end = offset + count - 1;
1213
1214 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001215 error = __posix_lock_file(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001216 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217 break;
1218 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1219 if (!error) {
1220 /*
1221 * If we've been sleeping someone might have
1222 * changed the permissions behind our back.
1223 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001224 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 continue;
1226 }
1227
1228 locks_delete_block(&fl);
1229 break;
1230 }
1231
1232 return error;
1233}
1234
1235EXPORT_SYMBOL(locks_mandatory_area);
1236
J. Bruce Fields778fc542011-07-26 18:25:49 -04001237static void lease_clear_pending(struct file_lock *fl, int arg)
1238{
1239 switch (arg) {
1240 case F_UNLCK:
1241 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1242 /* fall through: */
1243 case F_RDLCK:
1244 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1245 }
1246}
1247
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248/* We already had a lease on this file; just change its type */
1249int lease_modify(struct file_lock **before, int arg)
1250{
1251 struct file_lock *fl = *before;
1252 int error = assign_type(fl, arg);
1253
1254 if (error)
1255 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001256 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001258 if (arg == F_UNLCK) {
1259 struct file *filp = fl->fl_file;
1260
1261 f_delown(filp);
1262 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001263 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1264 if (fl->fl_fasync != NULL) {
1265 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1266 fl->fl_fasync = NULL;
1267 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 locks_delete_lock(before);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001269 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 return 0;
1271}
1272
1273EXPORT_SYMBOL(lease_modify);
1274
J. Bruce Fields778fc542011-07-26 18:25:49 -04001275static bool past_time(unsigned long then)
1276{
1277 if (!then)
1278 /* 0 is a special value meaning "this never expires": */
1279 return false;
1280 return time_after(jiffies, then);
1281}
1282
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283static void time_out_leases(struct inode *inode)
1284{
1285 struct file_lock **before;
1286 struct file_lock *fl;
1287
1288 before = &inode->i_flock;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04001289 while ((fl = *before) && IS_LEASE(fl) && lease_breaking(fl)) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001290 if (past_time(fl->fl_downgrade_time))
1291 lease_modify(before, F_RDLCK);
1292 if (past_time(fl->fl_break_time))
1293 lease_modify(before, F_UNLCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 if (fl == *before) /* lease_modify may have freed fl */
1295 before = &fl->fl_next;
1296 }
1297}
1298
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001299static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1300{
1301 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1302 return false;
1303 return locks_conflict(breaker, lease);
1304}
1305
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306/**
1307 * __break_lease - revoke all outstanding leases on file
1308 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001309 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1310 * break all leases
1311 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1312 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 *
david m. richter87250dd2007-05-09 16:10:27 -04001314 * break_lease (inlined for speed) has checked there already is at least
1315 * some kind of lock (maybe a lease) on this file. Leases are broken on
1316 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 * specified %O_NONBLOCK to your open().
1318 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001319int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001321 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 struct file_lock *new_fl, *flock;
1323 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 unsigned long break_time;
1325 int i_have_this_lease = 0;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001326 bool lease_conflict = false;
Al Viro8737c932009-12-24 06:47:55 -05001327 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328
Al Viro8737c932009-12-24 06:47:55 -05001329 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001330 if (IS_ERR(new_fl))
1331 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001332 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333
Jeff Layton1c8c6012013-06-21 08:58:15 -04001334 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335
1336 time_out_leases(inode);
1337
1338 flock = inode->i_flock;
1339 if ((flock == NULL) || !IS_LEASE(flock))
1340 goto out;
1341
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001342 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1343 if (leases_conflict(fl, new_fl)) {
1344 lease_conflict = true;
1345 if (fl->fl_owner == current->files)
1346 i_have_this_lease = 1;
1347 }
1348 }
1349 if (!lease_conflict)
J. Bruce Fields778fc542011-07-26 18:25:49 -04001350 goto out;
1351
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 break_time = 0;
1353 if (lease_break_time > 0) {
1354 break_time = jiffies + lease_break_time * HZ;
1355 if (break_time == 0)
1356 break_time++; /* so that 0 means no break time */
1357 }
1358
1359 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001360 if (!leases_conflict(fl, new_fl))
1361 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001362 if (want_write) {
1363 if (fl->fl_flags & FL_UNLOCK_PENDING)
1364 continue;
1365 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001367 } else {
1368 if (lease_breaking(flock))
1369 continue;
1370 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1371 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372 }
J. Bruce Fields778fc542011-07-26 18:25:49 -04001373 fl->fl_lmops->lm_break(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 }
1375
1376 if (i_have_this_lease || (mode & O_NONBLOCK)) {
1377 error = -EWOULDBLOCK;
1378 goto out;
1379 }
1380
1381restart:
1382 break_time = flock->fl_break_time;
1383 if (break_time != 0) {
1384 break_time -= jiffies;
1385 if (break_time == 0)
1386 break_time++;
1387 }
Matthew Wilcox4321e012008-01-14 21:28:30 -07001388 locks_insert_block(flock, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001389 spin_unlock(&inode->i_lock);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001390 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1391 !new_fl->fl_next, break_time);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001392 spin_lock(&inode->i_lock);
1393 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 if (error >= 0) {
1395 if (error == 0)
1396 time_out_leases(inode);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001397 /*
1398 * Wait for the next conflicting lease that has not been
1399 * broken yet
1400 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1402 flock = flock->fl_next) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001403 if (leases_conflict(new_fl, flock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 goto restart;
1405 }
1406 error = 0;
1407 }
1408
1409out:
Jeff Layton1c8c6012013-06-21 08:58:15 -04001410 spin_unlock(&inode->i_lock);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001411 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 return error;
1413}
1414
1415EXPORT_SYMBOL(__break_lease);
1416
1417/**
Randy Dunlapa6b91912008-03-19 17:01:00 -07001418 * lease_get_mtime - get the last modified time of an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 * @inode: the inode
1420 * @time: pointer to a timespec which will contain the last modified time
1421 *
1422 * This is to force NFS clients to flush their caches for files with
1423 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001424 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 */
1426void lease_get_mtime(struct inode *inode, struct timespec *time)
1427{
1428 struct file_lock *flock = inode->i_flock;
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04001429 if (flock && IS_LEASE(flock) && (flock->fl_type == F_WRLCK))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 *time = current_fs_time(inode->i_sb);
1431 else
1432 *time = inode->i_mtime;
1433}
1434
1435EXPORT_SYMBOL(lease_get_mtime);
1436
1437/**
1438 * fcntl_getlease - Enquire what lease is currently active
1439 * @filp: the file
1440 *
1441 * The value returned by this function will be one of
1442 * (if no lease break is pending):
1443 *
1444 * %F_RDLCK to indicate a shared lease is held.
1445 *
1446 * %F_WRLCK to indicate an exclusive lease is held.
1447 *
1448 * %F_UNLCK to indicate no lease is held.
1449 *
1450 * (if a lease break is pending):
1451 *
1452 * %F_RDLCK to indicate an exclusive lease needs to be
1453 * changed to a shared lease (or removed).
1454 *
1455 * %F_UNLCK to indicate the lease needs to be removed.
1456 *
1457 * XXX: sfr & willy disagree over whether F_INPROGRESS
1458 * should be returned to userspace.
1459 */
1460int fcntl_getlease(struct file *filp)
1461{
1462 struct file_lock *fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001463 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 int type = F_UNLCK;
1465
Jeff Layton1c8c6012013-06-21 08:58:15 -04001466 spin_lock(&inode->i_lock);
Al Viro496ad9a2013-01-23 17:07:38 -05001467 time_out_leases(file_inode(filp));
1468 for (fl = file_inode(filp)->i_flock; fl && IS_LEASE(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 fl = fl->fl_next) {
1470 if (fl->fl_file == filp) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001471 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 break;
1473 }
1474 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04001475 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 return type;
1477}
1478
Jeff Layton24cbe782014-02-03 12:13:06 -05001479/**
1480 * check_conflicting_open - see if the given dentry points to a file that has
1481 * an existing open that would conflict with the
1482 * desired lease.
1483 * @dentry: dentry to check
1484 * @arg: type of lease that we're trying to acquire
1485 *
1486 * Check to see if there's an existing open fd on this file that would
1487 * conflict with the lease we're trying to set.
1488 */
1489static int
1490check_conflicting_open(const struct dentry *dentry, const long arg)
1491{
1492 int ret = 0;
1493 struct inode *inode = dentry->d_inode;
1494
1495 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1496 return -EAGAIN;
1497
1498 if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1499 (atomic_read(&inode->i_count) > 1)))
1500 ret = -EAGAIN;
1501
1502 return ret;
1503}
1504
Jeff Laytond4f22d12013-06-21 08:58:11 -04001505static int generic_add_lease(struct file *filp, long arg, struct file_lock **flp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506{
KAMBAROV, ZAUR7eaae282005-07-07 17:57:06 -07001507 struct file_lock *fl, **before, **my_before = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001508 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 struct inode *inode = dentry->d_inode;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001510 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001511 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512
J. Bruce Fields096657b2010-10-30 17:31:14 -04001513 lease = *flp;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001514 /*
1515 * In the delegation case we need mutual exclusion with
1516 * a number of operations that take the i_mutex. We trylock
1517 * because delegations are an optional optimization, and if
1518 * there's some chance of a conflict--we'd rather not
1519 * bother, maybe that's a sign this just isn't a good file to
1520 * hand out a delegation on.
1521 */
1522 if (is_deleg && !mutex_trylock(&inode->i_mutex))
1523 return -EAGAIN;
1524
1525 if (is_deleg && arg == F_WRLCK) {
1526 /* Write delegations are not currently supported: */
Dan Carpenter4fdb7932013-11-13 10:56:27 +03001527 mutex_unlock(&inode->i_mutex);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001528 WARN_ON_ONCE(1);
1529 return -EINVAL;
1530 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001531
Jeff Layton24cbe782014-02-03 12:13:06 -05001532 error = check_conflicting_open(dentry, arg);
1533 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001534 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001535
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536 /*
1537 * At this point, we know that if there is an exclusive
1538 * lease on this file, then we hold it on this filp
1539 * (otherwise our open of this file would have blocked).
1540 * And if we are trying to acquire an exclusive lease,
1541 * then the file is not open by anyone (including us)
1542 * except for this filp.
1543 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001544 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 for (before = &inode->i_flock;
1546 ((fl = *before) != NULL) && IS_LEASE(fl);
1547 before = &fl->fl_next) {
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001548 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 my_before = before;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001550 continue;
1551 }
1552 /*
1553 * No exclusive leases if someone else has a lease on
1554 * this file:
1555 */
1556 if (arg == F_WRLCK)
1557 goto out;
1558 /*
1559 * Modifying our existing lease is OK, but no getting a
1560 * new lease if someone else is opening for write:
1561 */
1562 if (fl->fl_flags & FL_UNLOCK_PENDING)
1563 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 }
1565
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 if (my_before != NULL) {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001567 error = lease->fl_lmops->lm_change(my_before, arg);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001568 if (!error)
1569 *flp = *my_before;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 goto out;
1571 }
1572
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 error = -EINVAL;
1574 if (!leases_enable)
1575 goto out;
1576
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001577 locks_insert_lock(before, lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001578 /*
1579 * The check in break_lease() is lockless. It's possible for another
1580 * open to race in after we did the earlier check for a conflicting
1581 * open but before the lease was inserted. Check again for a
1582 * conflicting open and cancel the lease if there is one.
1583 *
1584 * We also add a barrier here to ensure that the insertion of the lock
1585 * precedes these checks.
1586 */
1587 smp_mb();
1588 error = check_conflicting_open(dentry, arg);
1589 if (error)
1590 locks_unlink_lock(flp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591out:
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001592 if (is_deleg)
1593 mutex_unlock(&inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 return error;
1595}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001596
Jeff Laytond4f22d12013-06-21 08:58:11 -04001597static int generic_delete_lease(struct file *filp, struct file_lock **flp)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001598{
1599 struct file_lock *fl, **before;
1600 struct dentry *dentry = filp->f_path.dentry;
1601 struct inode *inode = dentry->d_inode;
1602
1603 for (before = &inode->i_flock;
1604 ((fl = *before) != NULL) && IS_LEASE(fl);
1605 before = &fl->fl_next) {
1606 if (fl->fl_file != filp)
1607 continue;
1608 return (*flp)->fl_lmops->lm_change(before, F_UNLCK);
1609 }
1610 return -EAGAIN;
1611}
1612
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613/**
1614 * generic_setlease - sets a lease on an open file
1615 * @filp: file pointer
1616 * @arg: type of lease to obtain
1617 * @flp: input - file_lock to use, output - file_lock inserted
1618 *
1619 * The (input) flp->fl_lmops->lm_break function is required
1620 * by break_lease().
1621 *
Jeff Layton1c8c6012013-06-21 08:58:15 -04001622 * Called with inode->i_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623 */
1624int generic_setlease(struct file *filp, long arg, struct file_lock **flp)
1625{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 struct dentry *dentry = filp->f_path.dentry;
1627 struct inode *inode = dentry->d_inode;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001628 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001630 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001631 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001633 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 error = security_file_lock(filp, arg);
1635 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001636 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637
1638 time_out_leases(inode);
1639
1640 BUG_ON(!(*flp)->fl_lmops->lm_break);
1641
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001642 switch (arg) {
1643 case F_UNLCK:
1644 return generic_delete_lease(filp, flp);
1645 case F_RDLCK:
1646 case F_WRLCK:
1647 return generic_add_lease(filp, arg, flp);
1648 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001649 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001652EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001654static int __vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
1655{
Al Viro72c2d532013-09-22 16:27:52 -04001656 if (filp->f_op->setlease)
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001657 return filp->f_op->setlease(filp, arg, lease);
1658 else
1659 return generic_setlease(filp, arg, lease);
1660}
1661
1662/**
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001663 * vfs_setlease - sets a lease on an open file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 * @filp: file pointer
1665 * @arg: type of lease to obtain
1666 * @lease: file_lock to use
1667 *
1668 * Call this to establish a lease on the file.
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001669 * The (*lease)->fl_lmops->lm_break operation must be set; if not,
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001670 * break_lease will oops!
1671 *
1672 * This will call the filesystem's setlease file method, if
1673 * defined. Note that there is no getlease method; instead, the
1674 * filesystem setlease method should call back to setlease() to
1675 * add a lease to the inode's lease list, where fcntl_getlease() can
1676 * find it. Since fcntl_getlease() only reports whether the current
1677 * task holds a lease, a cluster filesystem need only do this for
1678 * leases held by processes on this node.
1679 *
1680 * There is also no break_lease method; filesystems that
Adam Buchbinderc9404c92009-12-18 15:40:42 -05001681 * handle their own leases should break leases themselves from the
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001682 * filesystem's open, create, and (on truncate) setattr methods.
1683 *
1684 * Warning: the only current setlease methods exist only to disable
1685 * leases in certain cases. More vfs changes may be required to
1686 * allow a full filesystem lease implementation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687 */
1688
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001689int vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690{
Jeff Layton1c8c6012013-06-21 08:58:15 -04001691 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 int error;
1693
Jeff Layton1c8c6012013-06-21 08:58:15 -04001694 spin_lock(&inode->i_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001695 error = __vfs_setlease(filp, arg, lease);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001696 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697
1698 return error;
1699}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001700EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001702static int do_fcntl_delete_lease(struct file *filp)
1703{
1704 struct file_lock fl, *flp = &fl;
1705
1706 lease_init(filp, F_UNLCK, flp);
1707
1708 return vfs_setlease(filp, F_UNLCK, &flp);
1709}
1710
1711static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712{
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001713 struct file_lock *fl, *ret;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001714 struct inode *inode = file_inode(filp);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001715 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 int error;
1717
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001718 fl = lease_alloc(filp, arg);
1719 if (IS_ERR(fl))
1720 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001722 new = fasync_alloc();
1723 if (!new) {
1724 locks_free_lock(fl);
1725 return -ENOMEM;
1726 }
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001727 ret = fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001728 spin_lock(&inode->i_lock);
J. Bruce Fields8896b932010-11-03 18:09:18 -04001729 error = __vfs_setlease(filp, arg, &ret);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001730 if (error) {
Jeff Layton1c8c6012013-06-21 08:58:15 -04001731 spin_unlock(&inode->i_lock);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001732 locks_free_lock(fl);
1733 goto out_free_fasync;
1734 }
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001735 if (ret != fl)
1736 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001738 /*
1739 * fasync_insert_entry() returns the old entry if any.
1740 * If there was no old entry, then it used 'new' and
1741 * inserted it into the fasync list. Clear new so that
1742 * we don't release it here.
1743 */
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001744 if (!fasync_insert_entry(fd, filp, &ret->fl_fasync, new))
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001745 new = NULL;
1746
J. Bruce Fields8896b932010-11-03 18:09:18 -04001747 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001748 spin_unlock(&inode->i_lock);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001749
1750out_free_fasync:
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001751 if (new)
1752 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 return error;
1754}
1755
1756/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001757 * fcntl_setlease - sets a lease on an open file
1758 * @fd: open file descriptor
1759 * @filp: file pointer
1760 * @arg: type of lease to obtain
1761 *
1762 * Call this fcntl to establish a lease on the file.
1763 * Note that you also need to call %F_SETSIG to
1764 * receive a signal when the lease is broken.
1765 */
1766int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1767{
1768 if (arg == F_UNLCK)
1769 return do_fcntl_delete_lease(filp);
1770 return do_fcntl_add_lease(fd, filp, arg);
1771}
1772
1773/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1775 * @filp: The file to apply the lock to
1776 * @fl: The lock to be applied
1777 *
1778 * Add a FLOCK style lock to a file.
1779 */
1780int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1781{
1782 int error;
1783 might_sleep();
1784 for (;;) {
1785 error = flock_lock_file(filp, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001786 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787 break;
1788 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1789 if (!error)
1790 continue;
1791
1792 locks_delete_block(fl);
1793 break;
1794 }
1795 return error;
1796}
1797
1798EXPORT_SYMBOL(flock_lock_file_wait);
1799
1800/**
1801 * sys_flock: - flock() system call.
1802 * @fd: the file descriptor to lock.
1803 * @cmd: the type of lock to apply.
1804 *
1805 * Apply a %FL_FLOCK style lock to an open file descriptor.
1806 * The @cmd can be one of
1807 *
1808 * %LOCK_SH -- a shared lock.
1809 *
1810 * %LOCK_EX -- an exclusive lock.
1811 *
1812 * %LOCK_UN -- remove an existing lock.
1813 *
1814 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1815 *
1816 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1817 * processes read and write access respectively.
1818 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001819SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820{
Al Viro2903ff02012-08-28 12:52:22 -04001821 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 struct file_lock *lock;
1823 int can_sleep, unlock;
1824 int error;
1825
1826 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001827 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 goto out;
1829
1830 can_sleep = !(cmd & LOCK_NB);
1831 cmd &= ~LOCK_NB;
1832 unlock = (cmd == LOCK_UN);
1833
Al Viroaeb5d722008-09-02 15:28:45 -04001834 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04001835 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 goto out_putf;
1837
Al Viro2903ff02012-08-28 12:52:22 -04001838 error = flock_make_lock(f.file, &lock, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839 if (error)
1840 goto out_putf;
1841 if (can_sleep)
1842 lock->fl_flags |= FL_SLEEP;
1843
Al Viro2903ff02012-08-28 12:52:22 -04001844 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845 if (error)
1846 goto out_free;
1847
Al Viro72c2d532013-09-22 16:27:52 -04001848 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04001849 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850 (can_sleep) ? F_SETLKW : F_SETLK,
1851 lock);
1852 else
Al Viro2903ff02012-08-28 12:52:22 -04001853 error = flock_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854
1855 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08001856 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857
1858 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04001859 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860 out:
1861 return error;
1862}
1863
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001864/**
1865 * vfs_test_lock - test file byte range lock
1866 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04001867 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001868 *
1869 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1870 * setting conf->fl_type to something other than F_UNLCK.
1871 */
1872int vfs_test_lock(struct file *filp, struct file_lock *fl)
1873{
Al Viro72c2d532013-09-22 16:27:52 -04001874 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001875 return filp->f_op->lock(filp, F_GETLK, fl);
1876 posix_test_lock(filp, fl);
1877 return 0;
1878}
1879EXPORT_SYMBOL_GPL(vfs_test_lock);
1880
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001881static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1882{
Jeff Layton3fd80cd2014-02-03 12:13:09 -05001883 flock->l_pid = IS_FILE_PVT(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001884#if BITS_PER_LONG == 32
1885 /*
1886 * Make sure we can represent the posix lock via
1887 * legacy 32bit flock.
1888 */
1889 if (fl->fl_start > OFFT_OFFSET_MAX)
1890 return -EOVERFLOW;
1891 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1892 return -EOVERFLOW;
1893#endif
1894 flock->l_start = fl->fl_start;
1895 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1896 fl->fl_end - fl->fl_start + 1;
1897 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04001898 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001899 return 0;
1900}
1901
1902#if BITS_PER_LONG == 32
1903static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1904{
Jeff Layton3fd80cd2014-02-03 12:13:09 -05001905 flock->l_pid = IS_FILE_PVT(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001906 flock->l_start = fl->fl_start;
1907 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1908 fl->fl_end - fl->fl_start + 1;
1909 flock->l_whence = 0;
1910 flock->l_type = fl->fl_type;
1911}
1912#endif
1913
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914/* Report the first existing lock that would conflict with l.
1915 * This implements the F_GETLK command of fcntl().
1916 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001917int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001919 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 struct flock flock;
1921 int error;
1922
1923 error = -EFAULT;
1924 if (copy_from_user(&flock, l, sizeof(flock)))
1925 goto out;
1926 error = -EINVAL;
1927 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1928 goto out;
1929
1930 error = flock_to_posix_lock(filp, &file_lock, &flock);
1931 if (error)
1932 goto out;
1933
Jeff Layton5d50ffd2014-02-03 12:13:10 -05001934 if (cmd == F_GETLKP) {
Jeff Layton90478932014-03-04 10:30:23 -05001935 error = -EINVAL;
1936 if (flock.l_pid != 0)
1937 goto out;
1938
Jeff Layton5d50ffd2014-02-03 12:13:10 -05001939 cmd = F_GETLK;
1940 file_lock.fl_flags |= FL_FILE_PVT;
1941 file_lock.fl_owner = (fl_owner_t)filp;
1942 }
1943
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001944 error = vfs_test_lock(filp, &file_lock);
1945 if (error)
1946 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001948 flock.l_type = file_lock.fl_type;
1949 if (file_lock.fl_type != F_UNLCK) {
1950 error = posix_lock_to_flock(&flock, &file_lock);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001951 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 }
1954 error = -EFAULT;
1955 if (!copy_to_user(l, &flock, sizeof(flock)))
1956 error = 0;
1957out:
1958 return error;
1959}
1960
Marc Eshel7723ec92007-01-18 15:08:55 -05001961/**
1962 * vfs_lock_file - file byte range lock
1963 * @filp: The file to apply the lock to
1964 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1965 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001966 * @conf: Place to return a copy of the conflicting lock, if found.
1967 *
1968 * A caller that doesn't care about the conflicting lock may pass NULL
1969 * as the final argument.
1970 *
1971 * If the filesystem defines a private ->lock() method, then @conf will
1972 * be left unchanged; so a caller that cares should initialize it to
1973 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05001974 *
1975 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1976 * locks, the ->lock() interface may return asynchronously, before the lock has
1977 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001978 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05001979 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1980 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001981 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05001982 * request completes.
1983 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07001984 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
1985 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05001986 * nonzero return code and the file system should release the lock. The file
1987 * system is also responsible to keep a corresponding posix lock when it
1988 * grants a lock so the VFS can find out which locks are locally held and do
1989 * the correct lock cleanup when required.
1990 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001991 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05001992 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05001993 */
Marc Eshel150b3932007-01-18 16:15:35 -05001994int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05001995{
Al Viro72c2d532013-09-22 16:27:52 -04001996 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05001997 return filp->f_op->lock(filp, cmd, fl);
1998 else
Marc Eshel150b3932007-01-18 16:15:35 -05001999 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05002000}
2001EXPORT_SYMBOL_GPL(vfs_lock_file);
2002
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002003static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2004 struct file_lock *fl)
2005{
2006 int error;
2007
2008 error = security_file_lock(filp, fl->fl_type);
2009 if (error)
2010 return error;
2011
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002012 for (;;) {
2013 error = vfs_lock_file(filp, cmd, fl, NULL);
2014 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002015 break;
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002016 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
2017 if (!error)
2018 continue;
2019
2020 locks_delete_block(fl);
2021 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002022 }
2023
2024 return error;
2025}
2026
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027/* Apply the lock described by l to an open file descriptor.
2028 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2029 */
Peter Staubachc2936212005-07-27 11:45:09 -07002030int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
2031 struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032{
2033 struct file_lock *file_lock = locks_alloc_lock();
2034 struct flock flock;
2035 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002036 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 int error;
2038
2039 if (file_lock == NULL)
2040 return -ENOLCK;
2041
2042 /*
2043 * This might block, so we do it before checking the inode.
2044 */
2045 error = -EFAULT;
2046 if (copy_from_user(&flock, l, sizeof(flock)))
2047 goto out;
2048
Al Viro496ad9a2013-01-23 17:07:38 -05002049 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050
2051 /* Don't allow mandatory locks on files that may be memory mapped
2052 * and shared.
2053 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002054 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055 error = -EAGAIN;
2056 goto out;
2057 }
2058
Peter Staubachc2936212005-07-27 11:45:09 -07002059again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 error = flock_to_posix_lock(filp, file_lock, &flock);
2061 if (error)
2062 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002063
2064 /*
2065 * If the cmd is requesting file-private locks, then set the
2066 * FL_FILE_PVT flag and override the owner.
2067 */
2068 switch (cmd) {
2069 case F_SETLKP:
Jeff Layton90478932014-03-04 10:30:23 -05002070 error = -EINVAL;
2071 if (flock.l_pid != 0)
2072 goto out;
2073
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002074 cmd = F_SETLK;
2075 file_lock->fl_flags |= FL_FILE_PVT;
2076 file_lock->fl_owner = (fl_owner_t)filp;
2077 break;
2078 case F_SETLKPW:
Jeff Layton90478932014-03-04 10:30:23 -05002079 error = -EINVAL;
2080 if (flock.l_pid != 0)
2081 goto out;
2082
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002083 cmd = F_SETLKW;
2084 file_lock->fl_flags |= FL_FILE_PVT;
2085 file_lock->fl_owner = (fl_owner_t)filp;
2086 /* Fallthrough */
2087 case F_SETLKW:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088 file_lock->fl_flags |= FL_SLEEP;
2089 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002090
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002091 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092
Peter Staubachc2936212005-07-27 11:45:09 -07002093 /*
2094 * Attempt to detect a close/fcntl race and recover by
2095 * releasing the lock that was just acquired.
2096 */
Al Viro0b2bac22008-05-06 13:58:34 -04002097 /*
2098 * we need that spin_lock here - it prevents reordering between
2099 * update of inode->i_flock and check for it done in close().
2100 * rcu_read_lock() wouldn't do.
2101 */
2102 spin_lock(&current->files->file_lock);
2103 f = fcheck(fd);
2104 spin_unlock(&current->files->file_lock);
2105 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002106 flock.l_type = F_UNLCK;
2107 goto again;
2108 }
2109
2110out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 locks_free_lock(file_lock);
2112 return error;
2113}
2114
2115#if BITS_PER_LONG == 32
2116/* Report the first existing lock that would conflict with l.
2117 * This implements the F_GETLK command of fcntl().
2118 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05002119int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002121 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 struct flock64 flock;
2123 int error;
2124
2125 error = -EFAULT;
2126 if (copy_from_user(&flock, l, sizeof(flock)))
2127 goto out;
2128 error = -EINVAL;
2129 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2130 goto out;
2131
2132 error = flock64_to_posix_lock(filp, &file_lock, &flock);
2133 if (error)
2134 goto out;
2135
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002136 if (cmd == F_GETLKP) {
Jeff Layton90478932014-03-04 10:30:23 -05002137 error = -EINVAL;
2138 if (flock.l_pid != 0)
2139 goto out;
2140
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002141 cmd = F_GETLK64;
2142 file_lock.fl_flags |= FL_FILE_PVT;
2143 file_lock.fl_owner = (fl_owner_t)filp;
2144 }
2145
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002146 error = vfs_test_lock(filp, &file_lock);
2147 if (error)
2148 goto out;
2149
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002150 flock.l_type = file_lock.fl_type;
2151 if (file_lock.fl_type != F_UNLCK)
2152 posix_lock_to_flock64(&flock, &file_lock);
2153
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 error = -EFAULT;
2155 if (!copy_to_user(l, &flock, sizeof(flock)))
2156 error = 0;
2157
2158out:
2159 return error;
2160}
2161
2162/* Apply the lock described by l to an open file descriptor.
2163 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2164 */
Peter Staubachc2936212005-07-27 11:45:09 -07002165int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2166 struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167{
2168 struct file_lock *file_lock = locks_alloc_lock();
2169 struct flock64 flock;
2170 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002171 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 int error;
2173
2174 if (file_lock == NULL)
2175 return -ENOLCK;
2176
2177 /*
2178 * This might block, so we do it before checking the inode.
2179 */
2180 error = -EFAULT;
2181 if (copy_from_user(&flock, l, sizeof(flock)))
2182 goto out;
2183
Al Viro496ad9a2013-01-23 17:07:38 -05002184 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185
2186 /* Don't allow mandatory locks on files that may be memory mapped
2187 * and shared.
2188 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002189 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190 error = -EAGAIN;
2191 goto out;
2192 }
2193
Peter Staubachc2936212005-07-27 11:45:09 -07002194again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 error = flock64_to_posix_lock(filp, file_lock, &flock);
2196 if (error)
2197 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002198
2199 /*
2200 * If the cmd is requesting file-private locks, then set the
2201 * FL_FILE_PVT flag and override the owner.
2202 */
2203 switch (cmd) {
2204 case F_SETLKP:
Jeff Layton90478932014-03-04 10:30:23 -05002205 error = -EINVAL;
2206 if (flock.l_pid != 0)
2207 goto out;
2208
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002209 cmd = F_SETLK64;
2210 file_lock->fl_flags |= FL_FILE_PVT;
2211 file_lock->fl_owner = (fl_owner_t)filp;
2212 break;
2213 case F_SETLKPW:
Jeff Layton90478932014-03-04 10:30:23 -05002214 error = -EINVAL;
2215 if (flock.l_pid != 0)
2216 goto out;
2217
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002218 cmd = F_SETLKW64;
2219 file_lock->fl_flags |= FL_FILE_PVT;
2220 file_lock->fl_owner = (fl_owner_t)filp;
2221 /* Fallthrough */
2222 case F_SETLKW64:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 file_lock->fl_flags |= FL_SLEEP;
2224 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002225
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002226 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227
Peter Staubachc2936212005-07-27 11:45:09 -07002228 /*
2229 * Attempt to detect a close/fcntl race and recover by
2230 * releasing the lock that was just acquired.
2231 */
Al Viro0b2bac22008-05-06 13:58:34 -04002232 spin_lock(&current->files->file_lock);
2233 f = fcheck(fd);
2234 spin_unlock(&current->files->file_lock);
2235 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002236 flock.l_type = F_UNLCK;
2237 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238 }
2239
2240out:
2241 locks_free_lock(file_lock);
2242 return error;
2243}
2244#endif /* BITS_PER_LONG == 32 */
2245
2246/*
2247 * This function is called when the file is being removed
2248 * from the task's fd array. POSIX locks belonging to this task
2249 * are deleted at this time.
2250 */
2251void locks_remove_posix(struct file *filp, fl_owner_t owner)
2252{
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002253 struct file_lock lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254
2255 /*
2256 * If there are no locks held on this file, we don't need to call
2257 * posix_lock_file(). Another process could be setting a lock on this
2258 * file at the same time, but we wouldn't remove that lock anyway.
2259 */
Al Viro496ad9a2013-01-23 17:07:38 -05002260 if (!file_inode(filp)->i_flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 return;
2262
2263 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002264 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 lock.fl_start = 0;
2266 lock.fl_end = OFFSET_MAX;
2267 lock.fl_owner = owner;
2268 lock.fl_pid = current->tgid;
2269 lock.fl_file = filp;
2270 lock.fl_ops = NULL;
2271 lock.fl_lmops = NULL;
2272
Marc Eshel150b3932007-01-18 16:15:35 -05002273 vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2276 lock.fl_ops->fl_release_private(&lock);
2277}
2278
2279EXPORT_SYMBOL(locks_remove_posix);
2280
2281/*
2282 * This function is called on the last close of an open file.
2283 */
Jeff Layton78ed8a12014-02-03 12:13:08 -05002284void locks_remove_file(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285{
Al Viro496ad9a2013-01-23 17:07:38 -05002286 struct inode * inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 struct file_lock *fl;
2288 struct file_lock **before;
2289
2290 if (!inode->i_flock)
2291 return;
2292
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002293 locks_remove_posix(filp, (fl_owner_t)filp);
2294
Al Viro72c2d532013-09-22 16:27:52 -04002295 if (filp->f_op->flock) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296 struct file_lock fl = {
2297 .fl_pid = current->tgid,
2298 .fl_file = filp,
2299 .fl_flags = FL_FLOCK,
2300 .fl_type = F_UNLCK,
2301 .fl_end = OFFSET_MAX,
2302 };
2303 filp->f_op->flock(filp, F_SETLKW, &fl);
Trond Myklebust80fec4c2005-06-22 17:16:31 +00002304 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2305 fl.fl_ops->fl_release_private(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 }
2307
Jeff Layton1c8c6012013-06-21 08:58:15 -04002308 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309 before = &inode->i_flock;
2310
2311 while ((fl = *before) != NULL) {
2312 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002313 if (IS_LEASE(fl)) {
2314 lease_modify(before, F_UNLCK);
2315 continue;
2316 }
Jeff Layton8c3cac52014-02-03 12:13:07 -05002317
2318 /*
2319 * There's a leftover lock on the list of a type that
2320 * we didn't expect to see. Most likely a classic
2321 * POSIX lock that ended up not getting released
2322 * properly, or that raced onto the list somehow. Log
2323 * some info about it and then just remove it from
2324 * the list.
2325 */
2326 WARN(!IS_FLOCK(fl),
2327 "leftover lock: dev=%u:%u ino=%lu type=%hhd flags=0x%x start=%lld end=%lld\n",
2328 MAJOR(inode->i_sb->s_dev),
2329 MINOR(inode->i_sb->s_dev), inode->i_ino,
2330 fl->fl_type, fl->fl_flags,
2331 fl->fl_start, fl->fl_end);
2332
2333 locks_delete_lock(before);
2334 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 }
2336 before = &fl->fl_next;
2337 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002338 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339}
2340
2341/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342 * posix_unblock_lock - stop waiting for a file lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343 * @waiter: the lock which was waiting
2344 *
2345 * lockd needs to block waiting for locks.
2346 */
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002347int
Jeff Laytonf891a292013-06-21 08:58:09 -04002348posix_unblock_lock(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349{
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002350 int status = 0;
2351
Jeff Layton7b2296a2013-06-21 08:58:20 -04002352 spin_lock(&blocked_lock_lock);
J. Bruce Fields5996a292006-01-03 09:55:44 +01002353 if (waiter->fl_next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354 __locks_delete_block(waiter);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002355 else
2356 status = -ENOENT;
Jeff Layton7b2296a2013-06-21 08:58:20 -04002357 spin_unlock(&blocked_lock_lock);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002358 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360EXPORT_SYMBOL(posix_unblock_lock);
2361
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002362/**
2363 * vfs_cancel_lock - file byte range unblock lock
2364 * @filp: The file to apply the unblock to
2365 * @fl: The lock to be unblocked
2366 *
2367 * Used by lock managers to cancel blocked requests
2368 */
2369int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2370{
Al Viro72c2d532013-09-22 16:27:52 -04002371 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002372 return filp->f_op->lock(filp, F_CANCELLK, fl);
2373 return 0;
2374}
2375
2376EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2377
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002378#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002379#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002380#include <linux/seq_file.h>
2381
Jeff Layton7012b022013-06-21 08:58:22 -04002382struct locks_iterator {
2383 int li_cpu;
2384 loff_t li_pos;
2385};
2386
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002387static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002388 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389{
2390 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002391 unsigned int fl_pid;
2392
2393 if (fl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -08002394 fl_pid = pid_vnr(fl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002395 else
2396 fl_pid = fl->fl_pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397
2398 if (fl->fl_file != NULL)
Al Viro496ad9a2013-01-23 17:07:38 -05002399 inode = file_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400
Jerome Marchand99dc8292010-10-26 14:22:33 -07002401 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402 if (IS_POSIX(fl)) {
Jeff Laytonc918d422014-02-03 12:13:09 -05002403 if (fl->fl_flags & FL_ACCESS)
2404 seq_printf(f, "ACCESS");
2405 else if (IS_FILE_PVT(fl))
2406 seq_printf(f, "FLPVT ");
2407 else
2408 seq_printf(f, "POSIX ");
2409
2410 seq_printf(f, " %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002412 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413 } else if (IS_FLOCK(fl)) {
2414 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002415 seq_printf(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002416 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002417 seq_printf(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418 }
2419 } else if (IS_LEASE(fl)) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002420 seq_printf(f, "LEASE ");
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002421 if (lease_breaking(fl))
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002422 seq_printf(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423 else if (fl->fl_file)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002424 seq_printf(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002426 seq_printf(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002428 seq_printf(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429 }
2430 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002431 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002432 (fl->fl_type & LOCK_READ)
2433 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2434 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2435 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002436 seq_printf(f, "%s ",
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002437 (lease_breaking(fl))
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04002438 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2439 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 }
2441 if (inode) {
2442#ifdef WE_CAN_BREAK_LSLK_NOW
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002443 seq_printf(f, "%d %s:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 inode->i_sb->s_id, inode->i_ino);
2445#else
2446 /* userspace relies on this representation of dev_t ;-( */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002447 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448 MAJOR(inode->i_sb->s_dev),
2449 MINOR(inode->i_sb->s_dev), inode->i_ino);
2450#endif
2451 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002452 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453 }
2454 if (IS_POSIX(fl)) {
2455 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002456 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002458 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002460 seq_printf(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461 }
2462}
2463
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002464static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465{
Jeff Layton7012b022013-06-21 08:58:22 -04002466 struct locks_iterator *iter = f->private;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002467 struct file_lock *fl, *bfl;
2468
Jeff Layton139ca042013-06-21 08:58:17 -04002469 fl = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002470
Jeff Layton7012b022013-06-21 08:58:22 -04002471 lock_get_status(f, fl, iter->li_pos, "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002472
2473 list_for_each_entry(bfl, &fl->fl_block, fl_block)
Jeff Layton7012b022013-06-21 08:58:22 -04002474 lock_get_status(f, bfl, iter->li_pos, " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002475
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002476 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477}
2478
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002479static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002480 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481{
Jeff Layton7012b022013-06-21 08:58:22 -04002482 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002483
Jeff Layton7012b022013-06-21 08:58:22 -04002484 iter->li_pos = *pos + 1;
2485 lg_global_lock(&file_lock_lglock);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002486 spin_lock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002487 return seq_hlist_start_percpu(&file_lock_list, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488}
2489
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002490static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2491{
Jeff Layton7012b022013-06-21 08:58:22 -04002492 struct locks_iterator *iter = f->private;
2493
2494 ++iter->li_pos;
2495 return seq_hlist_next_percpu(v, &file_lock_list, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002496}
2497
2498static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002499 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002500{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002501 spin_unlock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002502 lg_global_unlock(&file_lock_lglock);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002503}
2504
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002505static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002506 .start = locks_start,
2507 .next = locks_next,
2508 .stop = locks_stop,
2509 .show = locks_show,
2510};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002511
2512static int locks_open(struct inode *inode, struct file *filp)
2513{
Jeff Layton7012b022013-06-21 08:58:22 -04002514 return seq_open_private(filp, &locks_seq_operations,
2515 sizeof(struct locks_iterator));
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002516}
2517
2518static const struct file_operations proc_locks_operations = {
2519 .open = locks_open,
2520 .read = seq_read,
2521 .llseek = seq_lseek,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002522 .release = seq_release_private,
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002523};
2524
2525static int __init proc_locks_init(void)
2526{
2527 proc_create("locks", 0, NULL, &proc_locks_operations);
2528 return 0;
2529}
2530module_init(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002531#endif
2532
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533/**
2534 * lock_may_read - checks that the region is free of locks
2535 * @inode: the inode that is being read
2536 * @start: the first byte to read
2537 * @len: the number of bytes to read
2538 *
2539 * Emulates Windows locking requirements. Whole-file
2540 * mandatory locks (share modes) can prohibit a read and
2541 * byte-range POSIX locks can prohibit a read if they overlap.
2542 *
2543 * N.B. this function is only ever called
2544 * from knfsd and ownership of locks is never checked.
2545 */
2546int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2547{
2548 struct file_lock *fl;
2549 int result = 1;
Jeff Layton1c8c6012013-06-21 08:58:15 -04002550
2551 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002552 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2553 if (IS_POSIX(fl)) {
2554 if (fl->fl_type == F_RDLCK)
2555 continue;
2556 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2557 continue;
2558 } else if (IS_FLOCK(fl)) {
2559 if (!(fl->fl_type & LOCK_MAND))
2560 continue;
2561 if (fl->fl_type & LOCK_READ)
2562 continue;
2563 } else
2564 continue;
2565 result = 0;
2566 break;
2567 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002568 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569 return result;
2570}
2571
2572EXPORT_SYMBOL(lock_may_read);
2573
2574/**
2575 * lock_may_write - checks that the region is free of locks
2576 * @inode: the inode that is being written
2577 * @start: the first byte to write
2578 * @len: the number of bytes to write
2579 *
2580 * Emulates Windows locking requirements. Whole-file
2581 * mandatory locks (share modes) can prohibit a write and
2582 * byte-range POSIX locks can prohibit a write if they overlap.
2583 *
2584 * N.B. this function is only ever called
2585 * from knfsd and ownership of locks is never checked.
2586 */
2587int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2588{
2589 struct file_lock *fl;
2590 int result = 1;
Jeff Layton1c8c6012013-06-21 08:58:15 -04002591
2592 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002593 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2594 if (IS_POSIX(fl)) {
2595 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2596 continue;
2597 } else if (IS_FLOCK(fl)) {
2598 if (!(fl->fl_type & LOCK_MAND))
2599 continue;
2600 if (fl->fl_type & LOCK_WRITE)
2601 continue;
2602 } else
2603 continue;
2604 result = 0;
2605 break;
2606 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002607 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002608 return result;
2609}
2610
2611EXPORT_SYMBOL(lock_may_write);
2612
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613static int __init filelock_init(void)
2614{
Jeff Layton7012b022013-06-21 08:58:22 -04002615 int i;
2616
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002618 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2619
Jeff Layton7012b022013-06-21 08:58:22 -04002620 lg_lock_init(&file_lock_lglock, "file_lock_lglock");
2621
2622 for_each_possible_cpu(i)
2623 INIT_HLIST_HEAD(per_cpu_ptr(&file_lock_list, i));
2624
Linus Torvalds1da177e2005-04-16 15:20:36 -07002625 return 0;
2626}
2627
2628core_initcall(filelock_init);