blob: 3b54b98236eeeccf2588eadb5a6df82b45d591f4 [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
1158 * @inode: the file to check
1159 *
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 */
1163int locks_mandatory_locked(struct inode *inode)
1164{
1165 fl_owner_t owner = current->files;
1166 struct file_lock *fl;
1167
1168 /*
1169 * Search the lock list for this inode for any POSIX locks.
1170 */
Jeff Layton1c8c6012013-06-21 08:58:15 -04001171 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1173 if (!IS_POSIX(fl))
1174 continue;
1175 if (fl->fl_owner != owner)
1176 break;
1177 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04001178 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 return fl ? -EAGAIN : 0;
1180}
1181
1182/**
1183 * locks_mandatory_area - Check for a conflicting lock
1184 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1185 * for shared
1186 * @inode: the file to check
1187 * @filp: how the file was opened (if it was)
1188 * @offset: start of area to check
1189 * @count: length of area to check
1190 *
1191 * Searches the inode's list of locks to find any POSIX locks which conflict.
1192 * This function is called from rw_verify_area() and
1193 * locks_verify_truncate().
1194 */
1195int locks_mandatory_area(int read_write, struct inode *inode,
1196 struct file *filp, loff_t offset,
1197 size_t count)
1198{
1199 struct file_lock fl;
1200 int error;
1201
1202 locks_init_lock(&fl);
1203 fl.fl_owner = current->files;
1204 fl.fl_pid = current->tgid;
1205 fl.fl_file = filp;
1206 fl.fl_flags = FL_POSIX | FL_ACCESS;
1207 if (filp && !(filp->f_flags & O_NONBLOCK))
1208 fl.fl_flags |= FL_SLEEP;
1209 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1210 fl.fl_start = offset;
1211 fl.fl_end = offset + count - 1;
1212
1213 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001214 error = __posix_lock_file(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001215 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 break;
1217 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1218 if (!error) {
1219 /*
1220 * If we've been sleeping someone might have
1221 * changed the permissions behind our back.
1222 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001223 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 continue;
1225 }
1226
1227 locks_delete_block(&fl);
1228 break;
1229 }
1230
1231 return error;
1232}
1233
1234EXPORT_SYMBOL(locks_mandatory_area);
1235
J. Bruce Fields778fc542011-07-26 18:25:49 -04001236static void lease_clear_pending(struct file_lock *fl, int arg)
1237{
1238 switch (arg) {
1239 case F_UNLCK:
1240 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1241 /* fall through: */
1242 case F_RDLCK:
1243 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1244 }
1245}
1246
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247/* We already had a lease on this file; just change its type */
1248int lease_modify(struct file_lock **before, int arg)
1249{
1250 struct file_lock *fl = *before;
1251 int error = assign_type(fl, arg);
1252
1253 if (error)
1254 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001255 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001257 if (arg == F_UNLCK) {
1258 struct file *filp = fl->fl_file;
1259
1260 f_delown(filp);
1261 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001262 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1263 if (fl->fl_fasync != NULL) {
1264 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1265 fl->fl_fasync = NULL;
1266 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 locks_delete_lock(before);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001268 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 return 0;
1270}
1271
1272EXPORT_SYMBOL(lease_modify);
1273
J. Bruce Fields778fc542011-07-26 18:25:49 -04001274static bool past_time(unsigned long then)
1275{
1276 if (!then)
1277 /* 0 is a special value meaning "this never expires": */
1278 return false;
1279 return time_after(jiffies, then);
1280}
1281
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282static void time_out_leases(struct inode *inode)
1283{
1284 struct file_lock **before;
1285 struct file_lock *fl;
1286
1287 before = &inode->i_flock;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04001288 while ((fl = *before) && IS_LEASE(fl) && lease_breaking(fl)) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001289 if (past_time(fl->fl_downgrade_time))
1290 lease_modify(before, F_RDLCK);
1291 if (past_time(fl->fl_break_time))
1292 lease_modify(before, F_UNLCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 if (fl == *before) /* lease_modify may have freed fl */
1294 before = &fl->fl_next;
1295 }
1296}
1297
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001298static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1299{
1300 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1301 return false;
1302 return locks_conflict(breaker, lease);
1303}
1304
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305/**
1306 * __break_lease - revoke all outstanding leases on file
1307 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001308 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1309 * break all leases
1310 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1311 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 *
david m. richter87250dd2007-05-09 16:10:27 -04001313 * break_lease (inlined for speed) has checked there already is at least
1314 * some kind of lock (maybe a lease) on this file. Leases are broken on
1315 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 * specified %O_NONBLOCK to your open().
1317 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001318int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001320 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 struct file_lock *new_fl, *flock;
1322 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 unsigned long break_time;
1324 int i_have_this_lease = 0;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001325 bool lease_conflict = false;
Al Viro8737c932009-12-24 06:47:55 -05001326 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327
Al Viro8737c932009-12-24 06:47:55 -05001328 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001329 if (IS_ERR(new_fl))
1330 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001331 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332
Jeff Layton1c8c6012013-06-21 08:58:15 -04001333 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334
1335 time_out_leases(inode);
1336
1337 flock = inode->i_flock;
1338 if ((flock == NULL) || !IS_LEASE(flock))
1339 goto out;
1340
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001341 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1342 if (leases_conflict(fl, new_fl)) {
1343 lease_conflict = true;
1344 if (fl->fl_owner == current->files)
1345 i_have_this_lease = 1;
1346 }
1347 }
1348 if (!lease_conflict)
J. Bruce Fields778fc542011-07-26 18:25:49 -04001349 goto out;
1350
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 break_time = 0;
1352 if (lease_break_time > 0) {
1353 break_time = jiffies + lease_break_time * HZ;
1354 if (break_time == 0)
1355 break_time++; /* so that 0 means no break time */
1356 }
1357
1358 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001359 if (!leases_conflict(fl, new_fl))
1360 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001361 if (want_write) {
1362 if (fl->fl_flags & FL_UNLOCK_PENDING)
1363 continue;
1364 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001366 } else {
1367 if (lease_breaking(flock))
1368 continue;
1369 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1370 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 }
J. Bruce Fields778fc542011-07-26 18:25:49 -04001372 fl->fl_lmops->lm_break(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 }
1374
1375 if (i_have_this_lease || (mode & O_NONBLOCK)) {
1376 error = -EWOULDBLOCK;
1377 goto out;
1378 }
1379
1380restart:
1381 break_time = flock->fl_break_time;
1382 if (break_time != 0) {
1383 break_time -= jiffies;
1384 if (break_time == 0)
1385 break_time++;
1386 }
Matthew Wilcox4321e012008-01-14 21:28:30 -07001387 locks_insert_block(flock, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001388 spin_unlock(&inode->i_lock);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001389 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1390 !new_fl->fl_next, break_time);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001391 spin_lock(&inode->i_lock);
1392 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 if (error >= 0) {
1394 if (error == 0)
1395 time_out_leases(inode);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001396 /*
1397 * Wait for the next conflicting lease that has not been
1398 * broken yet
1399 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1401 flock = flock->fl_next) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001402 if (leases_conflict(new_fl, flock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 goto restart;
1404 }
1405 error = 0;
1406 }
1407
1408out:
Jeff Layton1c8c6012013-06-21 08:58:15 -04001409 spin_unlock(&inode->i_lock);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001410 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411 return error;
1412}
1413
1414EXPORT_SYMBOL(__break_lease);
1415
1416/**
Randy Dunlapa6b91912008-03-19 17:01:00 -07001417 * lease_get_mtime - get the last modified time of an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 * @inode: the inode
1419 * @time: pointer to a timespec which will contain the last modified time
1420 *
1421 * This is to force NFS clients to flush their caches for files with
1422 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001423 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 */
1425void lease_get_mtime(struct inode *inode, struct timespec *time)
1426{
1427 struct file_lock *flock = inode->i_flock;
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04001428 if (flock && IS_LEASE(flock) && (flock->fl_type == F_WRLCK))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 *time = current_fs_time(inode->i_sb);
1430 else
1431 *time = inode->i_mtime;
1432}
1433
1434EXPORT_SYMBOL(lease_get_mtime);
1435
1436/**
1437 * fcntl_getlease - Enquire what lease is currently active
1438 * @filp: the file
1439 *
1440 * The value returned by this function will be one of
1441 * (if no lease break is pending):
1442 *
1443 * %F_RDLCK to indicate a shared lease is held.
1444 *
1445 * %F_WRLCK to indicate an exclusive lease is held.
1446 *
1447 * %F_UNLCK to indicate no lease is held.
1448 *
1449 * (if a lease break is pending):
1450 *
1451 * %F_RDLCK to indicate an exclusive lease needs to be
1452 * changed to a shared lease (or removed).
1453 *
1454 * %F_UNLCK to indicate the lease needs to be removed.
1455 *
1456 * XXX: sfr & willy disagree over whether F_INPROGRESS
1457 * should be returned to userspace.
1458 */
1459int fcntl_getlease(struct file *filp)
1460{
1461 struct file_lock *fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001462 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 int type = F_UNLCK;
1464
Jeff Layton1c8c6012013-06-21 08:58:15 -04001465 spin_lock(&inode->i_lock);
Al Viro496ad9a2013-01-23 17:07:38 -05001466 time_out_leases(file_inode(filp));
1467 for (fl = file_inode(filp)->i_flock; fl && IS_LEASE(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 fl = fl->fl_next) {
1469 if (fl->fl_file == filp) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001470 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 break;
1472 }
1473 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04001474 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475 return type;
1476}
1477
Jeff Layton24cbe782014-02-03 12:13:06 -05001478/**
1479 * check_conflicting_open - see if the given dentry points to a file that has
1480 * an existing open that would conflict with the
1481 * desired lease.
1482 * @dentry: dentry to check
1483 * @arg: type of lease that we're trying to acquire
1484 *
1485 * Check to see if there's an existing open fd on this file that would
1486 * conflict with the lease we're trying to set.
1487 */
1488static int
1489check_conflicting_open(const struct dentry *dentry, const long arg)
1490{
1491 int ret = 0;
1492 struct inode *inode = dentry->d_inode;
1493
1494 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1495 return -EAGAIN;
1496
1497 if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1498 (atomic_read(&inode->i_count) > 1)))
1499 ret = -EAGAIN;
1500
1501 return ret;
1502}
1503
Jeff Laytond4f22d12013-06-21 08:58:11 -04001504static int generic_add_lease(struct file *filp, long arg, struct file_lock **flp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505{
KAMBAROV, ZAUR7eaae282005-07-07 17:57:06 -07001506 struct file_lock *fl, **before, **my_before = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001507 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 struct inode *inode = dentry->d_inode;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001509 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001510 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511
J. Bruce Fields096657b2010-10-30 17:31:14 -04001512 lease = *flp;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001513 /*
1514 * In the delegation case we need mutual exclusion with
1515 * a number of operations that take the i_mutex. We trylock
1516 * because delegations are an optional optimization, and if
1517 * there's some chance of a conflict--we'd rather not
1518 * bother, maybe that's a sign this just isn't a good file to
1519 * hand out a delegation on.
1520 */
1521 if (is_deleg && !mutex_trylock(&inode->i_mutex))
1522 return -EAGAIN;
1523
1524 if (is_deleg && arg == F_WRLCK) {
1525 /* Write delegations are not currently supported: */
Dan Carpenter4fdb7932013-11-13 10:56:27 +03001526 mutex_unlock(&inode->i_mutex);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001527 WARN_ON_ONCE(1);
1528 return -EINVAL;
1529 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001530
Jeff Layton24cbe782014-02-03 12:13:06 -05001531 error = check_conflicting_open(dentry, arg);
1532 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001533 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001534
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 /*
1536 * At this point, we know that if there is an exclusive
1537 * lease on this file, then we hold it on this filp
1538 * (otherwise our open of this file would have blocked).
1539 * And if we are trying to acquire an exclusive lease,
1540 * then the file is not open by anyone (including us)
1541 * except for this filp.
1542 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001543 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 for (before = &inode->i_flock;
1545 ((fl = *before) != NULL) && IS_LEASE(fl);
1546 before = &fl->fl_next) {
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001547 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 my_before = before;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001549 continue;
1550 }
1551 /*
1552 * No exclusive leases if someone else has a lease on
1553 * this file:
1554 */
1555 if (arg == F_WRLCK)
1556 goto out;
1557 /*
1558 * Modifying our existing lease is OK, but no getting a
1559 * new lease if someone else is opening for write:
1560 */
1561 if (fl->fl_flags & FL_UNLOCK_PENDING)
1562 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 }
1564
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 if (my_before != NULL) {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001566 error = lease->fl_lmops->lm_change(my_before, arg);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001567 if (!error)
1568 *flp = *my_before;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 goto out;
1570 }
1571
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 error = -EINVAL;
1573 if (!leases_enable)
1574 goto out;
1575
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001576 locks_insert_lock(before, lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001577 /*
1578 * The check in break_lease() is lockless. It's possible for another
1579 * open to race in after we did the earlier check for a conflicting
1580 * open but before the lease was inserted. Check again for a
1581 * conflicting open and cancel the lease if there is one.
1582 *
1583 * We also add a barrier here to ensure that the insertion of the lock
1584 * precedes these checks.
1585 */
1586 smp_mb();
1587 error = check_conflicting_open(dentry, arg);
1588 if (error)
1589 locks_unlink_lock(flp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590out:
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001591 if (is_deleg)
1592 mutex_unlock(&inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 return error;
1594}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001595
Jeff Laytond4f22d12013-06-21 08:58:11 -04001596static int generic_delete_lease(struct file *filp, struct file_lock **flp)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001597{
1598 struct file_lock *fl, **before;
1599 struct dentry *dentry = filp->f_path.dentry;
1600 struct inode *inode = dentry->d_inode;
1601
1602 for (before = &inode->i_flock;
1603 ((fl = *before) != NULL) && IS_LEASE(fl);
1604 before = &fl->fl_next) {
1605 if (fl->fl_file != filp)
1606 continue;
1607 return (*flp)->fl_lmops->lm_change(before, F_UNLCK);
1608 }
1609 return -EAGAIN;
1610}
1611
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612/**
1613 * generic_setlease - sets a lease on an open file
1614 * @filp: file pointer
1615 * @arg: type of lease to obtain
1616 * @flp: input - file_lock to use, output - file_lock inserted
1617 *
1618 * The (input) flp->fl_lmops->lm_break function is required
1619 * by break_lease().
1620 *
Jeff Layton1c8c6012013-06-21 08:58:15 -04001621 * Called with inode->i_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 */
1623int generic_setlease(struct file *filp, long arg, struct file_lock **flp)
1624{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 struct dentry *dentry = filp->f_path.dentry;
1626 struct inode *inode = dentry->d_inode;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001627 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001629 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001630 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001632 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 error = security_file_lock(filp, arg);
1634 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001635 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636
1637 time_out_leases(inode);
1638
1639 BUG_ON(!(*flp)->fl_lmops->lm_break);
1640
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001641 switch (arg) {
1642 case F_UNLCK:
1643 return generic_delete_lease(filp, flp);
1644 case F_RDLCK:
1645 case F_WRLCK:
1646 return generic_add_lease(filp, arg, flp);
1647 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001648 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001651EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001653static int __vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
1654{
Al Viro72c2d532013-09-22 16:27:52 -04001655 if (filp->f_op->setlease)
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001656 return filp->f_op->setlease(filp, arg, lease);
1657 else
1658 return generic_setlease(filp, arg, lease);
1659}
1660
1661/**
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001662 * vfs_setlease - sets a lease on an open file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 * @filp: file pointer
1664 * @arg: type of lease to obtain
1665 * @lease: file_lock to use
1666 *
1667 * Call this to establish a lease on the file.
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001668 * The (*lease)->fl_lmops->lm_break operation must be set; if not,
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001669 * break_lease will oops!
1670 *
1671 * This will call the filesystem's setlease file method, if
1672 * defined. Note that there is no getlease method; instead, the
1673 * filesystem setlease method should call back to setlease() to
1674 * add a lease to the inode's lease list, where fcntl_getlease() can
1675 * find it. Since fcntl_getlease() only reports whether the current
1676 * task holds a lease, a cluster filesystem need only do this for
1677 * leases held by processes on this node.
1678 *
1679 * There is also no break_lease method; filesystems that
Adam Buchbinderc9404c92009-12-18 15:40:42 -05001680 * handle their own leases should break leases themselves from the
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001681 * filesystem's open, create, and (on truncate) setattr methods.
1682 *
1683 * Warning: the only current setlease methods exist only to disable
1684 * leases in certain cases. More vfs changes may be required to
1685 * allow a full filesystem lease implementation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 */
1687
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001688int vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689{
Jeff Layton1c8c6012013-06-21 08:58:15 -04001690 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 int error;
1692
Jeff Layton1c8c6012013-06-21 08:58:15 -04001693 spin_lock(&inode->i_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001694 error = __vfs_setlease(filp, arg, lease);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001695 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696
1697 return error;
1698}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001699EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001701static int do_fcntl_delete_lease(struct file *filp)
1702{
1703 struct file_lock fl, *flp = &fl;
1704
1705 lease_init(filp, F_UNLCK, flp);
1706
1707 return vfs_setlease(filp, F_UNLCK, &flp);
1708}
1709
1710static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711{
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001712 struct file_lock *fl, *ret;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001713 struct inode *inode = file_inode(filp);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001714 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715 int error;
1716
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001717 fl = lease_alloc(filp, arg);
1718 if (IS_ERR(fl))
1719 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001721 new = fasync_alloc();
1722 if (!new) {
1723 locks_free_lock(fl);
1724 return -ENOMEM;
1725 }
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001726 ret = fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001727 spin_lock(&inode->i_lock);
J. Bruce Fields8896b932010-11-03 18:09:18 -04001728 error = __vfs_setlease(filp, arg, &ret);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001729 if (error) {
Jeff Layton1c8c6012013-06-21 08:58:15 -04001730 spin_unlock(&inode->i_lock);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001731 locks_free_lock(fl);
1732 goto out_free_fasync;
1733 }
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001734 if (ret != fl)
1735 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001737 /*
1738 * fasync_insert_entry() returns the old entry if any.
1739 * If there was no old entry, then it used 'new' and
1740 * inserted it into the fasync list. Clear new so that
1741 * we don't release it here.
1742 */
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001743 if (!fasync_insert_entry(fd, filp, &ret->fl_fasync, new))
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001744 new = NULL;
1745
J. Bruce Fields8896b932010-11-03 18:09:18 -04001746 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001747 spin_unlock(&inode->i_lock);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001748
1749out_free_fasync:
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001750 if (new)
1751 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752 return error;
1753}
1754
1755/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001756 * fcntl_setlease - sets a lease on an open file
1757 * @fd: open file descriptor
1758 * @filp: file pointer
1759 * @arg: type of lease to obtain
1760 *
1761 * Call this fcntl to establish a lease on the file.
1762 * Note that you also need to call %F_SETSIG to
1763 * receive a signal when the lease is broken.
1764 */
1765int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1766{
1767 if (arg == F_UNLCK)
1768 return do_fcntl_delete_lease(filp);
1769 return do_fcntl_add_lease(fd, filp, arg);
1770}
1771
1772/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1774 * @filp: The file to apply the lock to
1775 * @fl: The lock to be applied
1776 *
1777 * Add a FLOCK style lock to a file.
1778 */
1779int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1780{
1781 int error;
1782 might_sleep();
1783 for (;;) {
1784 error = flock_lock_file(filp, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001785 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 break;
1787 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1788 if (!error)
1789 continue;
1790
1791 locks_delete_block(fl);
1792 break;
1793 }
1794 return error;
1795}
1796
1797EXPORT_SYMBOL(flock_lock_file_wait);
1798
1799/**
1800 * sys_flock: - flock() system call.
1801 * @fd: the file descriptor to lock.
1802 * @cmd: the type of lock to apply.
1803 *
1804 * Apply a %FL_FLOCK style lock to an open file descriptor.
1805 * The @cmd can be one of
1806 *
1807 * %LOCK_SH -- a shared lock.
1808 *
1809 * %LOCK_EX -- an exclusive lock.
1810 *
1811 * %LOCK_UN -- remove an existing lock.
1812 *
1813 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1814 *
1815 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1816 * processes read and write access respectively.
1817 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001818SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819{
Al Viro2903ff02012-08-28 12:52:22 -04001820 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 struct file_lock *lock;
1822 int can_sleep, unlock;
1823 int error;
1824
1825 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001826 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827 goto out;
1828
1829 can_sleep = !(cmd & LOCK_NB);
1830 cmd &= ~LOCK_NB;
1831 unlock = (cmd == LOCK_UN);
1832
Al Viroaeb5d722008-09-02 15:28:45 -04001833 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04001834 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835 goto out_putf;
1836
Al Viro2903ff02012-08-28 12:52:22 -04001837 error = flock_make_lock(f.file, &lock, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 if (error)
1839 goto out_putf;
1840 if (can_sleep)
1841 lock->fl_flags |= FL_SLEEP;
1842
Al Viro2903ff02012-08-28 12:52:22 -04001843 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 if (error)
1845 goto out_free;
1846
Al Viro72c2d532013-09-22 16:27:52 -04001847 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04001848 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 (can_sleep) ? F_SETLKW : F_SETLK,
1850 lock);
1851 else
Al Viro2903ff02012-08-28 12:52:22 -04001852 error = flock_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853
1854 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08001855 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856
1857 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04001858 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 out:
1860 return error;
1861}
1862
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001863/**
1864 * vfs_test_lock - test file byte range lock
1865 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04001866 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001867 *
1868 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1869 * setting conf->fl_type to something other than F_UNLCK.
1870 */
1871int vfs_test_lock(struct file *filp, struct file_lock *fl)
1872{
Al Viro72c2d532013-09-22 16:27:52 -04001873 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001874 return filp->f_op->lock(filp, F_GETLK, fl);
1875 posix_test_lock(filp, fl);
1876 return 0;
1877}
1878EXPORT_SYMBOL_GPL(vfs_test_lock);
1879
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001880static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1881{
Jeff Layton3fd80cd2014-02-03 12:13:09 -05001882 flock->l_pid = IS_FILE_PVT(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001883#if BITS_PER_LONG == 32
1884 /*
1885 * Make sure we can represent the posix lock via
1886 * legacy 32bit flock.
1887 */
1888 if (fl->fl_start > OFFT_OFFSET_MAX)
1889 return -EOVERFLOW;
1890 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1891 return -EOVERFLOW;
1892#endif
1893 flock->l_start = fl->fl_start;
1894 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1895 fl->fl_end - fl->fl_start + 1;
1896 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04001897 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001898 return 0;
1899}
1900
1901#if BITS_PER_LONG == 32
1902static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1903{
Jeff Layton3fd80cd2014-02-03 12:13:09 -05001904 flock->l_pid = IS_FILE_PVT(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001905 flock->l_start = fl->fl_start;
1906 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1907 fl->fl_end - fl->fl_start + 1;
1908 flock->l_whence = 0;
1909 flock->l_type = fl->fl_type;
1910}
1911#endif
1912
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913/* Report the first existing lock that would conflict with l.
1914 * This implements the F_GETLK command of fcntl().
1915 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001916int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001918 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 struct flock flock;
1920 int error;
1921
1922 error = -EFAULT;
1923 if (copy_from_user(&flock, l, sizeof(flock)))
1924 goto out;
1925 error = -EINVAL;
1926 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1927 goto out;
1928
1929 error = flock_to_posix_lock(filp, &file_lock, &flock);
1930 if (error)
1931 goto out;
1932
Jeff Layton5d50ffd2014-02-03 12:13:10 -05001933 if (cmd == F_GETLKP) {
1934 cmd = F_GETLK;
1935 file_lock.fl_flags |= FL_FILE_PVT;
1936 file_lock.fl_owner = (fl_owner_t)filp;
1937 }
1938
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001939 error = vfs_test_lock(filp, &file_lock);
1940 if (error)
1941 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001943 flock.l_type = file_lock.fl_type;
1944 if (file_lock.fl_type != F_UNLCK) {
1945 error = posix_lock_to_flock(&flock, &file_lock);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001946 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 }
1949 error = -EFAULT;
1950 if (!copy_to_user(l, &flock, sizeof(flock)))
1951 error = 0;
1952out:
1953 return error;
1954}
1955
Marc Eshel7723ec92007-01-18 15:08:55 -05001956/**
1957 * vfs_lock_file - file byte range lock
1958 * @filp: The file to apply the lock to
1959 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1960 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001961 * @conf: Place to return a copy of the conflicting lock, if found.
1962 *
1963 * A caller that doesn't care about the conflicting lock may pass NULL
1964 * as the final argument.
1965 *
1966 * If the filesystem defines a private ->lock() method, then @conf will
1967 * be left unchanged; so a caller that cares should initialize it to
1968 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05001969 *
1970 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1971 * locks, the ->lock() interface may return asynchronously, before the lock has
1972 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001973 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05001974 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1975 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001976 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05001977 * request completes.
1978 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07001979 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
1980 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05001981 * nonzero return code and the file system should release the lock. The file
1982 * system is also responsible to keep a corresponding posix lock when it
1983 * grants a lock so the VFS can find out which locks are locally held and do
1984 * the correct lock cleanup when required.
1985 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001986 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05001987 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05001988 */
Marc Eshel150b3932007-01-18 16:15:35 -05001989int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05001990{
Al Viro72c2d532013-09-22 16:27:52 -04001991 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05001992 return filp->f_op->lock(filp, cmd, fl);
1993 else
Marc Eshel150b3932007-01-18 16:15:35 -05001994 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05001995}
1996EXPORT_SYMBOL_GPL(vfs_lock_file);
1997
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001998static int do_lock_file_wait(struct file *filp, unsigned int cmd,
1999 struct file_lock *fl)
2000{
2001 int error;
2002
2003 error = security_file_lock(filp, fl->fl_type);
2004 if (error)
2005 return error;
2006
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002007 for (;;) {
2008 error = vfs_lock_file(filp, cmd, fl, NULL);
2009 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002010 break;
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002011 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
2012 if (!error)
2013 continue;
2014
2015 locks_delete_block(fl);
2016 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002017 }
2018
2019 return error;
2020}
2021
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022/* Apply the lock described by l to an open file descriptor.
2023 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2024 */
Peter Staubachc2936212005-07-27 11:45:09 -07002025int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
2026 struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027{
2028 struct file_lock *file_lock = locks_alloc_lock();
2029 struct flock flock;
2030 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002031 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032 int error;
2033
2034 if (file_lock == NULL)
2035 return -ENOLCK;
2036
2037 /*
2038 * This might block, so we do it before checking the inode.
2039 */
2040 error = -EFAULT;
2041 if (copy_from_user(&flock, l, sizeof(flock)))
2042 goto out;
2043
Al Viro496ad9a2013-01-23 17:07:38 -05002044 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045
2046 /* Don't allow mandatory locks on files that may be memory mapped
2047 * and shared.
2048 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002049 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050 error = -EAGAIN;
2051 goto out;
2052 }
2053
Peter Staubachc2936212005-07-27 11:45:09 -07002054again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055 error = flock_to_posix_lock(filp, file_lock, &flock);
2056 if (error)
2057 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002058
2059 /*
2060 * If the cmd is requesting file-private locks, then set the
2061 * FL_FILE_PVT flag and override the owner.
2062 */
2063 switch (cmd) {
2064 case F_SETLKP:
2065 cmd = F_SETLK;
2066 file_lock->fl_flags |= FL_FILE_PVT;
2067 file_lock->fl_owner = (fl_owner_t)filp;
2068 break;
2069 case F_SETLKPW:
2070 cmd = F_SETLKW;
2071 file_lock->fl_flags |= FL_FILE_PVT;
2072 file_lock->fl_owner = (fl_owner_t)filp;
2073 /* Fallthrough */
2074 case F_SETLKW:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 file_lock->fl_flags |= FL_SLEEP;
2076 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002077
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002078 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079
Peter Staubachc2936212005-07-27 11:45:09 -07002080 /*
2081 * Attempt to detect a close/fcntl race and recover by
2082 * releasing the lock that was just acquired.
2083 */
Al Viro0b2bac22008-05-06 13:58:34 -04002084 /*
2085 * we need that spin_lock here - it prevents reordering between
2086 * update of inode->i_flock and check for it done in close().
2087 * rcu_read_lock() wouldn't do.
2088 */
2089 spin_lock(&current->files->file_lock);
2090 f = fcheck(fd);
2091 spin_unlock(&current->files->file_lock);
2092 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002093 flock.l_type = F_UNLCK;
2094 goto again;
2095 }
2096
2097out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 locks_free_lock(file_lock);
2099 return error;
2100}
2101
2102#if BITS_PER_LONG == 32
2103/* Report the first existing lock that would conflict with l.
2104 * This implements the F_GETLK command of fcntl().
2105 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05002106int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002108 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 struct flock64 flock;
2110 int error;
2111
2112 error = -EFAULT;
2113 if (copy_from_user(&flock, l, sizeof(flock)))
2114 goto out;
2115 error = -EINVAL;
2116 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2117 goto out;
2118
2119 error = flock64_to_posix_lock(filp, &file_lock, &flock);
2120 if (error)
2121 goto out;
2122
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002123 if (cmd == F_GETLKP) {
2124 cmd = F_GETLK64;
2125 file_lock.fl_flags |= FL_FILE_PVT;
2126 file_lock.fl_owner = (fl_owner_t)filp;
2127 }
2128
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002129 error = vfs_test_lock(filp, &file_lock);
2130 if (error)
2131 goto out;
2132
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002133 flock.l_type = file_lock.fl_type;
2134 if (file_lock.fl_type != F_UNLCK)
2135 posix_lock_to_flock64(&flock, &file_lock);
2136
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 error = -EFAULT;
2138 if (!copy_to_user(l, &flock, sizeof(flock)))
2139 error = 0;
2140
2141out:
2142 return error;
2143}
2144
2145/* Apply the lock described by l to an open file descriptor.
2146 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2147 */
Peter Staubachc2936212005-07-27 11:45:09 -07002148int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2149 struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150{
2151 struct file_lock *file_lock = locks_alloc_lock();
2152 struct flock64 flock;
2153 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002154 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155 int error;
2156
2157 if (file_lock == NULL)
2158 return -ENOLCK;
2159
2160 /*
2161 * This might block, so we do it before checking the inode.
2162 */
2163 error = -EFAULT;
2164 if (copy_from_user(&flock, l, sizeof(flock)))
2165 goto out;
2166
Al Viro496ad9a2013-01-23 17:07:38 -05002167 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168
2169 /* Don't allow mandatory locks on files that may be memory mapped
2170 * and shared.
2171 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002172 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 error = -EAGAIN;
2174 goto out;
2175 }
2176
Peter Staubachc2936212005-07-27 11:45:09 -07002177again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178 error = flock64_to_posix_lock(filp, file_lock, &flock);
2179 if (error)
2180 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002181
2182 /*
2183 * If the cmd is requesting file-private locks, then set the
2184 * FL_FILE_PVT flag and override the owner.
2185 */
2186 switch (cmd) {
2187 case F_SETLKP:
2188 cmd = F_SETLK64;
2189 file_lock->fl_flags |= FL_FILE_PVT;
2190 file_lock->fl_owner = (fl_owner_t)filp;
2191 break;
2192 case F_SETLKPW:
2193 cmd = F_SETLKW64;
2194 file_lock->fl_flags |= FL_FILE_PVT;
2195 file_lock->fl_owner = (fl_owner_t)filp;
2196 /* Fallthrough */
2197 case F_SETLKW64:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 file_lock->fl_flags |= FL_SLEEP;
2199 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002200
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002201 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202
Peter Staubachc2936212005-07-27 11:45:09 -07002203 /*
2204 * Attempt to detect a close/fcntl race and recover by
2205 * releasing the lock that was just acquired.
2206 */
Al Viro0b2bac22008-05-06 13:58:34 -04002207 spin_lock(&current->files->file_lock);
2208 f = fcheck(fd);
2209 spin_unlock(&current->files->file_lock);
2210 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002211 flock.l_type = F_UNLCK;
2212 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213 }
2214
2215out:
2216 locks_free_lock(file_lock);
2217 return error;
2218}
2219#endif /* BITS_PER_LONG == 32 */
2220
2221/*
2222 * This function is called when the file is being removed
2223 * from the task's fd array. POSIX locks belonging to this task
2224 * are deleted at this time.
2225 */
2226void locks_remove_posix(struct file *filp, fl_owner_t owner)
2227{
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002228 struct file_lock lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229
2230 /*
2231 * If there are no locks held on this file, we don't need to call
2232 * posix_lock_file(). Another process could be setting a lock on this
2233 * file at the same time, but we wouldn't remove that lock anyway.
2234 */
Al Viro496ad9a2013-01-23 17:07:38 -05002235 if (!file_inode(filp)->i_flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 return;
2237
2238 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002239 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240 lock.fl_start = 0;
2241 lock.fl_end = OFFSET_MAX;
2242 lock.fl_owner = owner;
2243 lock.fl_pid = current->tgid;
2244 lock.fl_file = filp;
2245 lock.fl_ops = NULL;
2246 lock.fl_lmops = NULL;
2247
Marc Eshel150b3932007-01-18 16:15:35 -05002248 vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2251 lock.fl_ops->fl_release_private(&lock);
2252}
2253
2254EXPORT_SYMBOL(locks_remove_posix);
2255
2256/*
2257 * This function is called on the last close of an open file.
2258 */
Jeff Layton78ed8a12014-02-03 12:13:08 -05002259void locks_remove_file(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260{
Al Viro496ad9a2013-01-23 17:07:38 -05002261 struct inode * inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 struct file_lock *fl;
2263 struct file_lock **before;
2264
2265 if (!inode->i_flock)
2266 return;
2267
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002268 locks_remove_posix(filp, (fl_owner_t)filp);
2269
Al Viro72c2d532013-09-22 16:27:52 -04002270 if (filp->f_op->flock) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271 struct file_lock fl = {
2272 .fl_pid = current->tgid,
2273 .fl_file = filp,
2274 .fl_flags = FL_FLOCK,
2275 .fl_type = F_UNLCK,
2276 .fl_end = OFFSET_MAX,
2277 };
2278 filp->f_op->flock(filp, F_SETLKW, &fl);
Trond Myklebust80fec4c2005-06-22 17:16:31 +00002279 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2280 fl.fl_ops->fl_release_private(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281 }
2282
Jeff Layton1c8c6012013-06-21 08:58:15 -04002283 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284 before = &inode->i_flock;
2285
2286 while ((fl = *before) != NULL) {
2287 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288 if (IS_LEASE(fl)) {
2289 lease_modify(before, F_UNLCK);
2290 continue;
2291 }
Jeff Layton8c3cac52014-02-03 12:13:07 -05002292
2293 /*
2294 * There's a leftover lock on the list of a type that
2295 * we didn't expect to see. Most likely a classic
2296 * POSIX lock that ended up not getting released
2297 * properly, or that raced onto the list somehow. Log
2298 * some info about it and then just remove it from
2299 * the list.
2300 */
2301 WARN(!IS_FLOCK(fl),
2302 "leftover lock: dev=%u:%u ino=%lu type=%hhd flags=0x%x start=%lld end=%lld\n",
2303 MAJOR(inode->i_sb->s_dev),
2304 MINOR(inode->i_sb->s_dev), inode->i_ino,
2305 fl->fl_type, fl->fl_flags,
2306 fl->fl_start, fl->fl_end);
2307
2308 locks_delete_lock(before);
2309 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 }
2311 before = &fl->fl_next;
2312 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002313 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314}
2315
2316/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317 * posix_unblock_lock - stop waiting for a file lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318 * @waiter: the lock which was waiting
2319 *
2320 * lockd needs to block waiting for locks.
2321 */
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002322int
Jeff Laytonf891a292013-06-21 08:58:09 -04002323posix_unblock_lock(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324{
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002325 int status = 0;
2326
Jeff Layton7b2296a2013-06-21 08:58:20 -04002327 spin_lock(&blocked_lock_lock);
J. Bruce Fields5996a292006-01-03 09:55:44 +01002328 if (waiter->fl_next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 __locks_delete_block(waiter);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002330 else
2331 status = -ENOENT;
Jeff Layton7b2296a2013-06-21 08:58:20 -04002332 spin_unlock(&blocked_lock_lock);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002333 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335EXPORT_SYMBOL(posix_unblock_lock);
2336
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002337/**
2338 * vfs_cancel_lock - file byte range unblock lock
2339 * @filp: The file to apply the unblock to
2340 * @fl: The lock to be unblocked
2341 *
2342 * Used by lock managers to cancel blocked requests
2343 */
2344int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2345{
Al Viro72c2d532013-09-22 16:27:52 -04002346 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002347 return filp->f_op->lock(filp, F_CANCELLK, fl);
2348 return 0;
2349}
2350
2351EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2352
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002353#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002354#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002355#include <linux/seq_file.h>
2356
Jeff Layton7012b022013-06-21 08:58:22 -04002357struct locks_iterator {
2358 int li_cpu;
2359 loff_t li_pos;
2360};
2361
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002362static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002363 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364{
2365 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002366 unsigned int fl_pid;
2367
2368 if (fl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -08002369 fl_pid = pid_vnr(fl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002370 else
2371 fl_pid = fl->fl_pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372
2373 if (fl->fl_file != NULL)
Al Viro496ad9a2013-01-23 17:07:38 -05002374 inode = file_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375
Jerome Marchand99dc8292010-10-26 14:22:33 -07002376 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377 if (IS_POSIX(fl)) {
Jeff Laytonc918d422014-02-03 12:13:09 -05002378 if (fl->fl_flags & FL_ACCESS)
2379 seq_printf(f, "ACCESS");
2380 else if (IS_FILE_PVT(fl))
2381 seq_printf(f, "FLPVT ");
2382 else
2383 seq_printf(f, "POSIX ");
2384
2385 seq_printf(f, " %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002387 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388 } else if (IS_FLOCK(fl)) {
2389 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002390 seq_printf(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002392 seq_printf(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393 }
2394 } else if (IS_LEASE(fl)) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002395 seq_printf(f, "LEASE ");
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002396 if (lease_breaking(fl))
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002397 seq_printf(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398 else if (fl->fl_file)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002399 seq_printf(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002401 seq_printf(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002403 seq_printf(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002404 }
2405 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002406 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407 (fl->fl_type & LOCK_READ)
2408 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2409 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2410 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002411 seq_printf(f, "%s ",
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002412 (lease_breaking(fl))
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04002413 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2414 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415 }
2416 if (inode) {
2417#ifdef WE_CAN_BREAK_LSLK_NOW
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002418 seq_printf(f, "%d %s:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419 inode->i_sb->s_id, inode->i_ino);
2420#else
2421 /* userspace relies on this representation of dev_t ;-( */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002422 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423 MAJOR(inode->i_sb->s_dev),
2424 MINOR(inode->i_sb->s_dev), inode->i_ino);
2425#endif
2426 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002427 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428 }
2429 if (IS_POSIX(fl)) {
2430 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002431 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002432 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002433 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002435 seq_printf(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436 }
2437}
2438
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002439static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440{
Jeff Layton7012b022013-06-21 08:58:22 -04002441 struct locks_iterator *iter = f->private;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002442 struct file_lock *fl, *bfl;
2443
Jeff Layton139ca042013-06-21 08:58:17 -04002444 fl = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002445
Jeff Layton7012b022013-06-21 08:58:22 -04002446 lock_get_status(f, fl, iter->li_pos, "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002447
2448 list_for_each_entry(bfl, &fl->fl_block, fl_block)
Jeff Layton7012b022013-06-21 08:58:22 -04002449 lock_get_status(f, bfl, iter->li_pos, " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002450
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002451 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002452}
2453
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002454static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002455 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456{
Jeff Layton7012b022013-06-21 08:58:22 -04002457 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002458
Jeff Layton7012b022013-06-21 08:58:22 -04002459 iter->li_pos = *pos + 1;
2460 lg_global_lock(&file_lock_lglock);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002461 spin_lock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002462 return seq_hlist_start_percpu(&file_lock_list, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463}
2464
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002465static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2466{
Jeff Layton7012b022013-06-21 08:58:22 -04002467 struct locks_iterator *iter = f->private;
2468
2469 ++iter->li_pos;
2470 return seq_hlist_next_percpu(v, &file_lock_list, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002471}
2472
2473static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002474 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002475{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002476 spin_unlock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002477 lg_global_unlock(&file_lock_lglock);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002478}
2479
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002480static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002481 .start = locks_start,
2482 .next = locks_next,
2483 .stop = locks_stop,
2484 .show = locks_show,
2485};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002486
2487static int locks_open(struct inode *inode, struct file *filp)
2488{
Jeff Layton7012b022013-06-21 08:58:22 -04002489 return seq_open_private(filp, &locks_seq_operations,
2490 sizeof(struct locks_iterator));
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002491}
2492
2493static const struct file_operations proc_locks_operations = {
2494 .open = locks_open,
2495 .read = seq_read,
2496 .llseek = seq_lseek,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002497 .release = seq_release_private,
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002498};
2499
2500static int __init proc_locks_init(void)
2501{
2502 proc_create("locks", 0, NULL, &proc_locks_operations);
2503 return 0;
2504}
2505module_init(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002506#endif
2507
Linus Torvalds1da177e2005-04-16 15:20:36 -07002508/**
2509 * lock_may_read - checks that the region is free of locks
2510 * @inode: the inode that is being read
2511 * @start: the first byte to read
2512 * @len: the number of bytes to read
2513 *
2514 * Emulates Windows locking requirements. Whole-file
2515 * mandatory locks (share modes) can prohibit a read and
2516 * byte-range POSIX locks can prohibit a read if they overlap.
2517 *
2518 * N.B. this function is only ever called
2519 * from knfsd and ownership of locks is never checked.
2520 */
2521int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2522{
2523 struct file_lock *fl;
2524 int result = 1;
Jeff Layton1c8c6012013-06-21 08:58:15 -04002525
2526 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002527 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2528 if (IS_POSIX(fl)) {
2529 if (fl->fl_type == F_RDLCK)
2530 continue;
2531 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2532 continue;
2533 } else if (IS_FLOCK(fl)) {
2534 if (!(fl->fl_type & LOCK_MAND))
2535 continue;
2536 if (fl->fl_type & LOCK_READ)
2537 continue;
2538 } else
2539 continue;
2540 result = 0;
2541 break;
2542 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002543 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544 return result;
2545}
2546
2547EXPORT_SYMBOL(lock_may_read);
2548
2549/**
2550 * lock_may_write - checks that the region is free of locks
2551 * @inode: the inode that is being written
2552 * @start: the first byte to write
2553 * @len: the number of bytes to write
2554 *
2555 * Emulates Windows locking requirements. Whole-file
2556 * mandatory locks (share modes) can prohibit a write and
2557 * byte-range POSIX locks can prohibit a write if they overlap.
2558 *
2559 * N.B. this function is only ever called
2560 * from knfsd and ownership of locks is never checked.
2561 */
2562int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2563{
2564 struct file_lock *fl;
2565 int result = 1;
Jeff Layton1c8c6012013-06-21 08:58:15 -04002566
2567 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2569 if (IS_POSIX(fl)) {
2570 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2571 continue;
2572 } else if (IS_FLOCK(fl)) {
2573 if (!(fl->fl_type & LOCK_MAND))
2574 continue;
2575 if (fl->fl_type & LOCK_WRITE)
2576 continue;
2577 } else
2578 continue;
2579 result = 0;
2580 break;
2581 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002582 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583 return result;
2584}
2585
2586EXPORT_SYMBOL(lock_may_write);
2587
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588static int __init filelock_init(void)
2589{
Jeff Layton7012b022013-06-21 08:58:22 -04002590 int i;
2591
Linus Torvalds1da177e2005-04-16 15:20:36 -07002592 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002593 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2594
Jeff Layton7012b022013-06-21 08:58:22 -04002595 lg_lock_init(&file_lock_lglock, "file_lock_lglock");
2596
2597 for_each_possible_cpu(i)
2598 INIT_HLIST_HEAD(per_cpu_ptr(&file_lock_list, i));
2599
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600 return 0;
2601}
2602
2603core_initcall(filelock_init);