blob: b49e853a9c7b7c2d40105d83a392d114473de4e0 [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))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400139static bool lease_breaking(struct file_lock *fl)
140{
J. Bruce Fields778fc542011-07-26 18:25:49 -0400141 return fl->fl_flags & (FL_UNLOCK_PENDING | FL_DOWNGRADE_PENDING);
142}
143
144static int target_leasetype(struct file_lock *fl)
145{
146 if (fl->fl_flags & FL_UNLOCK_PENDING)
147 return F_UNLCK;
148 if (fl->fl_flags & FL_DOWNGRADE_PENDING)
149 return F_RDLCK;
150 return fl->fl_type;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400151}
152
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153int leases_enable = 1;
154int lease_break_time = 45;
155
156#define for_each_lock(inode, lockp) \
157 for (lockp = &inode->i_flock; *lockp != NULL; lockp = &(*lockp)->fl_next)
158
Jeff Layton1c8c6012013-06-21 08:58:15 -0400159/*
Jeff Layton7012b022013-06-21 08:58:22 -0400160 * The global file_lock_list is only used for displaying /proc/locks, so we
161 * keep a list on each CPU, with each list protected by its own spinlock via
162 * the file_lock_lglock. Note that alterations to the list also require that
163 * the relevant i_lock is held.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400164 */
Jeff Layton7012b022013-06-21 08:58:22 -0400165DEFINE_STATIC_LGLOCK(file_lock_lglock);
166static DEFINE_PER_CPU(struct hlist_head, file_lock_list);
Jeff Layton88974692013-06-21 08:58:14 -0400167
Jeff Layton1c8c6012013-06-21 08:58:15 -0400168/*
Jeff Layton48f74182013-06-21 08:58:18 -0400169 * The blocked_hash is used to find POSIX lock loops for deadlock detection.
Jeff Layton7b2296a2013-06-21 08:58:20 -0400170 * It is protected by blocked_lock_lock.
Jeff Layton48f74182013-06-21 08:58:18 -0400171 *
172 * We hash locks by lockowner in order to optimize searching for the lock a
173 * particular lockowner is waiting on.
174 *
175 * FIXME: make this value scale via some heuristic? We generally will want more
176 * buckets when we have more lockowners holding locks, but that's a little
177 * difficult to determine without knowing what the workload will look like.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400178 */
Jeff Layton48f74182013-06-21 08:58:18 -0400179#define BLOCKED_HASH_BITS 7
180static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
Jeff Layton88974692013-06-21 08:58:14 -0400181
Jeff Layton1c8c6012013-06-21 08:58:15 -0400182/*
Jeff Layton7b2296a2013-06-21 08:58:20 -0400183 * This lock protects the blocked_hash. Generally, if you're accessing it, you
184 * want to be holding this lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400185 *
186 * In addition, it also protects the fl->fl_block list, and the fl->fl_next
187 * pointer for file_lock structures that are acting as lock requests (in
188 * contrast to those that are acting as records of acquired locks).
189 *
190 * Note that when we acquire this lock in order to change the above fields,
191 * we often hold the i_lock as well. In certain cases, when reading the fields
192 * protected by this lock, we can skip acquiring it iff we already hold the
193 * i_lock.
194 *
195 * In particular, adding an entry to the fl_block list requires that you hold
196 * both the i_lock and the blocked_lock_lock (acquired in that order). Deleting
197 * an entry from the list however only requires the file_lock_lock.
198 */
Jeff Layton7b2296a2013-06-21 08:58:20 -0400199static DEFINE_SPINLOCK(blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Christoph Lametere18b8902006-12-06 20:33:20 -0800201static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
Miklos Szerediee19cc42011-07-07 13:06:09 +0200203static void locks_init_lock_heads(struct file_lock *fl)
Miklos Szeredia51cb912011-07-06 12:33:55 +0200204{
Jeff Layton139ca042013-06-21 08:58:17 -0400205 INIT_HLIST_NODE(&fl->fl_link);
Miklos Szerediee19cc42011-07-07 13:06:09 +0200206 INIT_LIST_HEAD(&fl->fl_block);
207 init_waitqueue_head(&fl->fl_wait);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200208}
209
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200211struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200213 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200214
215 if (fl)
Miklos Szerediee19cc42011-07-07 13:06:09 +0200216 locks_init_lock_heads(fl);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200217
218 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200220EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500222void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500223{
224 if (fl->fl_ops) {
225 if (fl->fl_ops->fl_release_private)
226 fl->fl_ops->fl_release_private(fl);
227 fl->fl_ops = NULL;
228 }
J. Bruce Fields068535f2012-08-01 07:56:16 -0400229 fl->fl_lmops = NULL;
Trond Myklebust47831f32006-03-20 13:44:05 -0500230
231}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500232EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500233
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234/* Free a lock which is not in use. */
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400235void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236{
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800237 BUG_ON(waitqueue_active(&fl->fl_wait));
238 BUG_ON(!list_empty(&fl->fl_block));
Jeff Layton139ca042013-06-21 08:58:17 -0400239 BUG_ON(!hlist_unhashed(&fl->fl_link));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Trond Myklebust47831f32006-03-20 13:44:05 -0500241 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 kmem_cache_free(filelock_cache, fl);
243}
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400244EXPORT_SYMBOL(locks_free_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
246void locks_init_lock(struct file_lock *fl)
247{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200248 memset(fl, 0, sizeof(struct file_lock));
249 locks_init_lock_heads(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250}
251
252EXPORT_SYMBOL(locks_init_lock);
253
Trond Myklebust47831f32006-03-20 13:44:05 -0500254static void locks_copy_private(struct file_lock *new, struct file_lock *fl)
255{
256 if (fl->fl_ops) {
257 if (fl->fl_ops->fl_copy_lock)
258 fl->fl_ops->fl_copy_lock(new, fl);
259 new->fl_ops = fl->fl_ops;
260 }
Christoph Hellwigbb8430a2010-10-31 08:35:31 -0400261 if (fl->fl_lmops)
Trond Myklebust47831f32006-03-20 13:44:05 -0500262 new->fl_lmops = fl->fl_lmops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500263}
264
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265/*
266 * Initialize a new lock from an existing file_lock structure.
267 */
J. Bruce Fields1a747ee2008-04-24 10:08:22 -0400268void __locks_copy_lock(struct file_lock *new, const struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269{
270 new->fl_owner = fl->fl_owner;
271 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500272 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 new->fl_flags = fl->fl_flags;
274 new->fl_type = fl->fl_type;
275 new->fl_start = fl->fl_start;
276 new->fl_end = fl->fl_end;
Trond Myklebust09969052006-03-20 13:44:38 -0500277 new->fl_ops = NULL;
278 new->fl_lmops = NULL;
279}
Roland Dreier3dd7b712008-04-25 15:32:51 -0700280EXPORT_SYMBOL(__locks_copy_lock);
Trond Myklebust09969052006-03-20 13:44:38 -0500281
282void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
283{
284 locks_release_private(new);
285
286 __locks_copy_lock(new, fl);
287 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 new->fl_ops = fl->fl_ops;
289 new->fl_lmops = fl->fl_lmops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500290
291 locks_copy_private(new, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292}
293
294EXPORT_SYMBOL(locks_copy_lock);
295
296static inline int flock_translate_cmd(int cmd) {
297 if (cmd & LOCK_MAND)
298 return cmd & (LOCK_MAND | LOCK_RW);
299 switch (cmd) {
300 case LOCK_SH:
301 return F_RDLCK;
302 case LOCK_EX:
303 return F_WRLCK;
304 case LOCK_UN:
305 return F_UNLCK;
306 }
307 return -EINVAL;
308}
309
310/* Fill in a file_lock structure with an appropriate FLOCK lock. */
311static int flock_make_lock(struct file *filp, struct file_lock **lock,
312 unsigned int cmd)
313{
314 struct file_lock *fl;
315 int type = flock_translate_cmd(cmd);
316 if (type < 0)
317 return type;
318
319 fl = locks_alloc_lock();
320 if (fl == NULL)
321 return -ENOMEM;
322
323 fl->fl_file = filp;
324 fl->fl_pid = current->tgid;
325 fl->fl_flags = FL_FLOCK;
326 fl->fl_type = type;
327 fl->fl_end = OFFSET_MAX;
328
329 *lock = fl;
330 return 0;
331}
332
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400333static int assign_type(struct file_lock *fl, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334{
335 switch (type) {
336 case F_RDLCK:
337 case F_WRLCK:
338 case F_UNLCK:
339 fl->fl_type = type;
340 break;
341 default:
342 return -EINVAL;
343 }
344 return 0;
345}
346
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500347static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
348 struct flock64 *l)
349{
350 switch (l->l_whence) {
351 case SEEK_SET:
352 fl->fl_start = 0;
353 break;
354 case SEEK_CUR:
355 fl->fl_start = filp->f_pos;
356 break;
357 case SEEK_END:
358 fl->fl_start = i_size_read(file_inode(filp));
359 break;
360 default:
361 return -EINVAL;
362 }
363 if (l->l_start > OFFSET_MAX - fl->fl_start)
364 return -EOVERFLOW;
365 fl->fl_start += l->l_start;
366 if (fl->fl_start < 0)
367 return -EINVAL;
368
369 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
370 POSIX-2001 defines it. */
371 if (l->l_len > 0) {
372 if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
373 return -EOVERFLOW;
374 fl->fl_end = fl->fl_start + l->l_len - 1;
375
376 } else if (l->l_len < 0) {
377 if (fl->fl_start + l->l_len < 0)
378 return -EINVAL;
379 fl->fl_end = fl->fl_start - 1;
380 fl->fl_start += l->l_len;
381 } else
382 fl->fl_end = OFFSET_MAX;
383
384 fl->fl_owner = current->files;
385 fl->fl_pid = current->tgid;
386 fl->fl_file = filp;
387 fl->fl_flags = FL_POSIX;
388 fl->fl_ops = NULL;
389 fl->fl_lmops = NULL;
390
391 return assign_type(fl, l->l_type);
392}
393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
395 * style lock.
396 */
397static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
398 struct flock *l)
399{
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500400 struct flock64 ll = {
401 .l_type = l->l_type,
402 .l_whence = l->l_whence,
403 .l_start = l->l_start,
404 .l_len = l->l_len,
405 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500407 return flock64_to_posix_lock(filp, fl, &ll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408}
409
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410/* default lease lock manager operations */
411static void lease_break_callback(struct file_lock *fl)
412{
413 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
414}
415
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700416static const struct lock_manager_operations lease_manager_ops = {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400417 .lm_break = lease_break_callback,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400418 .lm_change = lease_modify,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419};
420
421/*
422 * Initialize a lease, use the default lock manager operations
423 */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400424static int lease_init(struct file *filp, long type, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 {
Trond Myklebust75dff552006-05-07 23:02:42 -0400426 if (assign_type(fl, type) != 0)
427 return -EINVAL;
428
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 fl->fl_owner = current->files;
430 fl->fl_pid = current->tgid;
431
432 fl->fl_file = filp;
433 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 fl->fl_start = 0;
435 fl->fl_end = OFFSET_MAX;
436 fl->fl_ops = NULL;
437 fl->fl_lmops = &lease_manager_ops;
438 return 0;
439}
440
441/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400442static struct file_lock *lease_alloc(struct file *filp, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443{
444 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400445 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
447 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500448 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
450 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400451 if (error) {
452 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500453 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400454 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500455 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456}
457
458/* Check if two locks overlap each other.
459 */
460static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
461{
462 return ((fl1->fl_end >= fl2->fl_start) &&
463 (fl2->fl_end >= fl1->fl_start));
464}
465
466/*
467 * Check whether two locks have the same owner.
468 */
Matt Mackall33443c42006-01-08 01:05:22 -0800469static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470{
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400471 if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 return fl2->fl_lmops == fl1->fl_lmops &&
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400473 fl1->fl_lmops->lm_compare_owner(fl1, fl2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 return fl1->fl_owner == fl2->fl_owner;
475}
476
Jeff Layton7012b022013-06-21 08:58:22 -0400477/* Must be called with the i_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500478static void locks_insert_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400479{
Jeff Layton7012b022013-06-21 08:58:22 -0400480 lg_local_lock(&file_lock_lglock);
481 fl->fl_link_cpu = smp_processor_id();
482 hlist_add_head(&fl->fl_link, this_cpu_ptr(&file_lock_list));
483 lg_local_unlock(&file_lock_lglock);
Jeff Layton88974692013-06-21 08:58:14 -0400484}
485
Jeff Layton7012b022013-06-21 08:58:22 -0400486/* Must be called with the i_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500487static void locks_delete_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400488{
Jeff Layton7012b022013-06-21 08:58:22 -0400489 /*
490 * Avoid taking lock if already unhashed. This is safe since this check
491 * is done while holding the i_lock, and new insertions into the list
492 * also require that it be held.
493 */
494 if (hlist_unhashed(&fl->fl_link))
495 return;
496 lg_local_lock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton139ca042013-06-21 08:58:17 -0400497 hlist_del_init(&fl->fl_link);
Jeff Layton7012b022013-06-21 08:58:22 -0400498 lg_local_unlock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton88974692013-06-21 08:58:14 -0400499}
500
Jeff Layton3999e492013-06-21 08:58:19 -0400501static unsigned long
502posix_owner_key(struct file_lock *fl)
503{
504 if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
505 return fl->fl_lmops->lm_owner_key(fl);
506 return (unsigned long)fl->fl_owner;
507}
508
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500509static void locks_insert_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400510{
Jeff Layton3999e492013-06-21 08:58:19 -0400511 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
Jeff Layton88974692013-06-21 08:58:14 -0400512}
513
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500514static void locks_delete_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400515{
Jeff Layton48f74182013-06-21 08:58:18 -0400516 hash_del(&waiter->fl_link);
Jeff Layton88974692013-06-21 08:58:14 -0400517}
518
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519/* Remove waiter from blocker's block list.
520 * When blocker ends up pointing to itself then the list is empty.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400521 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400522 * Must be called with blocked_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 */
Matt Mackall33443c42006-01-08 01:05:22 -0800524static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525{
Jeff Layton88974692013-06-21 08:58:14 -0400526 locks_delete_global_blocked(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 list_del_init(&waiter->fl_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 waiter->fl_next = NULL;
529}
530
Jeff Layton1a9e64a2013-06-21 08:58:10 -0400531static void locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400533 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 __locks_delete_block(waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400535 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536}
537
538/* Insert waiter into blocker's block list.
539 * We use a circular list so that processes can be easily woken up in
540 * the order they blocked. The documentation doesn't require this but
541 * it seems like the reasonable thing to do.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400542 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400543 * Must be called with both the i_lock and blocked_lock_lock held. The fl_block
Jeff Layton46dad762014-02-03 12:13:06 -0500544 * list itself is protected by the blocked_lock_lock, but by ensuring that the
Jeff Layton7b2296a2013-06-21 08:58:20 -0400545 * i_lock is also held on insertions we can avoid taking the blocked_lock_lock
Jeff Layton4e8c7652013-06-21 08:58:16 -0400546 * in some cases when we see that the fl_block list is empty.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400548static void __locks_insert_block(struct file_lock *blocker,
549 struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550{
J. Bruce Fields6dc0fe82006-03-26 01:37:24 -0800551 BUG_ON(!list_empty(&waiter->fl_block));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 waiter->fl_next = blocker;
Jeff Layton88974692013-06-21 08:58:14 -0400553 list_add_tail(&waiter->fl_block, &blocker->fl_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 if (IS_POSIX(blocker))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400555 locks_insert_global_blocked(waiter);
556}
557
558/* Must be called with i_lock held. */
559static void locks_insert_block(struct file_lock *blocker,
560 struct file_lock *waiter)
561{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400562 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400563 __locks_insert_block(blocker, waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400564 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565}
566
Jeff Layton1cb36012013-06-21 08:58:12 -0400567/*
568 * Wake up processes blocked waiting for blocker.
569 *
Jeff Layton1c8c6012013-06-21 08:58:15 -0400570 * Must be called with the inode->i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 */
572static void locks_wake_up_blocks(struct file_lock *blocker)
573{
Jeff Layton4e8c7652013-06-21 08:58:16 -0400574 /*
575 * Avoid taking global lock if list is empty. This is safe since new
576 * blocked requests are only added to the list under the i_lock, and
577 * the i_lock is always held here. Note that removal from the fl_block
578 * list does not require the i_lock, so we must recheck list_empty()
Jeff Layton7b2296a2013-06-21 08:58:20 -0400579 * after acquiring the blocked_lock_lock.
Jeff Layton4e8c7652013-06-21 08:58:16 -0400580 */
581 if (list_empty(&blocker->fl_block))
582 return;
583
Jeff Layton7b2296a2013-06-21 08:58:20 -0400584 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 while (!list_empty(&blocker->fl_block)) {
Pavel Emelyanovf0c1cd02007-09-19 16:44:07 +0400586 struct file_lock *waiter;
587
588 waiter = list_first_entry(&blocker->fl_block,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 struct file_lock, fl_block);
590 __locks_delete_block(waiter);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400591 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
592 waiter->fl_lmops->lm_notify(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 else
594 wake_up(&waiter->fl_wait);
595 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400596 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597}
598
599/* Insert file lock fl into an inode's lock list at the position indicated
600 * by pos. At the same time add the lock to the global file lock list.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400601 *
602 * Must be called with the i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 */
604static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
605{
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000606 fl->fl_nspid = get_pid(task_tgid(current));
607
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 /* insert into file's list */
609 fl->fl_next = *pos;
610 *pos = fl;
Jeff Layton88974692013-06-21 08:58:14 -0400611
612 locks_insert_global_locks(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613}
614
Jeff Layton24cbe782014-02-03 12:13:06 -0500615/**
616 * locks_delete_lock - Delete a lock and then free it.
617 * @thisfl_p: pointer that points to the fl_next field of the previous
618 * inode->i_flock list entry
619 *
620 * Unlink a lock from all lists and free the namespace reference, but don't
621 * free it yet. Wake up processes that are blocked waiting for this lock and
622 * notify the FS that the lock has been cleared.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400623 *
624 * Must be called with the i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 */
Jeff Layton24cbe782014-02-03 12:13:06 -0500626static void locks_unlink_lock(struct file_lock **thisfl_p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627{
628 struct file_lock *fl = *thisfl_p;
629
Jeff Layton88974692013-06-21 08:58:14 -0400630 locks_delete_global_locks(fl);
631
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 *thisfl_p = fl->fl_next;
633 fl->fl_next = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000635 if (fl->fl_nspid) {
636 put_pid(fl->fl_nspid);
637 fl->fl_nspid = NULL;
638 }
639
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 locks_wake_up_blocks(fl);
Jeff Layton24cbe782014-02-03 12:13:06 -0500641}
642
643/*
644 * Unlink a lock from all lists and free it.
645 *
646 * Must be called with i_lock held!
647 */
648static void locks_delete_lock(struct file_lock **thisfl_p)
649{
650 struct file_lock *fl = *thisfl_p;
651
652 locks_unlink_lock(thisfl_p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 locks_free_lock(fl);
654}
655
656/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
657 * checks for shared/exclusive status of overlapping locks.
658 */
659static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
660{
661 if (sys_fl->fl_type == F_WRLCK)
662 return 1;
663 if (caller_fl->fl_type == F_WRLCK)
664 return 1;
665 return 0;
666}
667
668/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
669 * checking before calling the locks_conflict().
670 */
671static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
672{
673 /* POSIX locks owned by the same process do not conflict with
674 * each other.
675 */
676 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
677 return (0);
678
679 /* Check whether they overlap */
680 if (!locks_overlap(caller_fl, sys_fl))
681 return 0;
682
683 return (locks_conflict(caller_fl, sys_fl));
684}
685
686/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
687 * checking before calling the locks_conflict().
688 */
689static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
690{
691 /* FLOCK locks referring to the same filp do not conflict with
692 * each other.
693 */
694 if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
695 return (0);
696 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
697 return 0;
698
699 return (locks_conflict(caller_fl, sys_fl));
700}
701
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400702void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500703posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704{
705 struct file_lock *cfl;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400706 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
Jeff Layton1c8c6012013-06-21 08:58:15 -0400708 spin_lock(&inode->i_lock);
Al Viro496ad9a2013-01-23 17:07:38 -0500709 for (cfl = file_inode(filp)->i_flock; cfl; cfl = cfl->fl_next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 if (!IS_POSIX(cfl))
711 continue;
J. Bruce Fieldsb842e242007-05-10 19:02:07 -0400712 if (posix_locks_conflict(fl, cfl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 break;
714 }
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000715 if (cfl) {
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500716 __locks_copy_lock(fl, cfl);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000717 if (cfl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -0800718 fl->fl_pid = pid_vnr(cfl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000719 } else
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400720 fl->fl_type = F_UNLCK;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400721 spin_unlock(&inode->i_lock);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400722 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724EXPORT_SYMBOL(posix_test_lock);
725
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400726/*
727 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400729 * We attempt to detect deadlocks that are due purely to posix file
730 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400732 * We assume that a task can be waiting for at most one lock at a time.
733 * So for any acquired lock, the process holding that lock may be
734 * waiting on at most one other lock. That lock in turns may be held by
735 * someone waiting for at most one other lock. Given a requested lock
736 * caller_fl which is about to wait for a conflicting lock block_fl, we
737 * follow this chain of waiters to ensure we are not about to create a
738 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400739 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400740 * Since we do this before we ever put a process to sleep on a lock, we
741 * are ensured that there is never a cycle; that is what guarantees that
742 * the while() loop in posix_locks_deadlock() eventually completes.
743 *
744 * Note: the above assumption may not be true when handling lock
745 * requests from a broken NFS client. It may also fail in the presence
746 * of tasks (such as posix threads) sharing the same open file table.
747 *
748 * To handle those cases, we just bail out after a few iterations.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400750
751#define MAX_DEADLK_ITERATIONS 10
752
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400753/* Find a lock that the owner of the given block_fl is blocking on. */
754static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
755{
756 struct file_lock *fl;
757
Jeff Layton3999e492013-06-21 08:58:19 -0400758 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400759 if (posix_same_owner(fl, block_fl))
760 return fl->fl_next;
761 }
762 return NULL;
763}
764
Jeff Layton7b2296a2013-06-21 08:58:20 -0400765/* Must be called with the blocked_lock_lock held! */
Adrian Bunkb0904e12006-06-23 02:05:13 -0700766static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 struct file_lock *block_fl)
768{
J. Bruce Fields97855b42007-10-30 11:20:02 -0400769 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400771 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
772 if (i++ > MAX_DEADLK_ITERATIONS)
773 return 0;
774 if (posix_same_owner(caller_fl, block_fl))
775 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 }
777 return 0;
778}
779
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -0400781 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -0400782 *
783 * Note that if called with an FL_EXISTS argument, the caller may determine
784 * whether or not a lock was successfully freed by testing the return
785 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 */
Trond Myklebust993dfa82006-03-31 02:30:55 -0800787static int flock_lock_file(struct file *filp, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788{
Trond Myklebust993dfa82006-03-31 02:30:55 -0800789 struct file_lock *new_fl = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 struct file_lock **before;
Al Viro496ad9a2013-01-23 17:07:38 -0500791 struct inode * inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 int error = 0;
793 int found = 0;
794
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200795 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
796 new_fl = locks_alloc_lock();
797 if (!new_fl)
798 return -ENOMEM;
799 }
800
Jeff Layton1c8c6012013-06-21 08:58:15 -0400801 spin_lock(&inode->i_lock);
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400802 if (request->fl_flags & FL_ACCESS)
803 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +0400804
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 for_each_lock(inode, before) {
806 struct file_lock *fl = *before;
807 if (IS_POSIX(fl))
808 break;
809 if (IS_LEASE(fl))
810 continue;
811 if (filp != fl->fl_file)
812 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800813 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 goto out;
815 found = 1;
816 locks_delete_lock(before);
817 break;
818 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819
Trond Myklebustf475ae92006-06-29 16:38:32 -0400820 if (request->fl_type == F_UNLCK) {
821 if ((request->fl_flags & FL_EXISTS) && !found)
822 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800823 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400824 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825
826 /*
827 * If a higher-priority process was blocked on the old file lock,
828 * give it the opportunity to lock the file.
829 */
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200830 if (found) {
Jeff Layton1c8c6012013-06-21 08:58:15 -0400831 spin_unlock(&inode->i_lock);
Frederic Weisbeckerdef01bc2009-07-16 15:44:29 +0200832 cond_resched();
Jeff Layton1c8c6012013-06-21 08:58:15 -0400833 spin_lock(&inode->i_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200834 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400836find_conflict:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 for_each_lock(inode, before) {
838 struct file_lock *fl = *before;
839 if (IS_POSIX(fl))
840 break;
841 if (IS_LEASE(fl))
842 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800843 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 continue;
845 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700846 if (!(request->fl_flags & FL_SLEEP))
847 goto out;
848 error = FILE_LOCK_DEFERRED;
849 locks_insert_block(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 goto out;
851 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400852 if (request->fl_flags & FL_ACCESS)
853 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800854 locks_copy_lock(new_fl, request);
Pavel Emelyanov0e2f6db2007-09-11 15:24:01 -0700855 locks_insert_lock(before, new_fl);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800856 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +0400857 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858
859out:
Jeff Layton1c8c6012013-06-21 08:58:15 -0400860 spin_unlock(&inode->i_lock);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800861 if (new_fl)
862 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 return error;
864}
865
Marc Eshel150b3932007-01-18 16:15:35 -0500866static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867{
868 struct file_lock *fl;
Miklos Szeredi39005d02006-06-23 02:05:10 -0700869 struct file_lock *new_fl = NULL;
870 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 struct file_lock *left = NULL;
872 struct file_lock *right = NULL;
873 struct file_lock **before;
Jeff Laytonb9746ef2013-06-21 08:58:13 -0400874 int error;
875 bool added = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876
877 /*
878 * We may need two file_lock structures for this operation,
879 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -0700880 *
881 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 */
Miklos Szeredi39005d02006-06-23 02:05:10 -0700883 if (!(request->fl_flags & FL_ACCESS) &&
884 (request->fl_type != F_UNLCK ||
885 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
886 new_fl = locks_alloc_lock();
887 new_fl2 = locks_alloc_lock();
888 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889
Jeff Layton1c8c6012013-06-21 08:58:15 -0400890 spin_lock(&inode->i_lock);
Jeff Layton1cb36012013-06-21 08:58:12 -0400891 /*
892 * New lock request. Walk all POSIX locks and look for conflicts. If
893 * there are any, either return error or put the request on the
Jeff Layton48f74182013-06-21 08:58:18 -0400894 * blocker's list of waiters and the global blocked_hash.
Jeff Layton1cb36012013-06-21 08:58:12 -0400895 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 if (request->fl_type != F_UNLCK) {
897 for_each_lock(inode, before) {
J. Bruce Fields526985b2006-11-14 16:54:36 -0500898 fl = *before;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 if (!IS_POSIX(fl))
900 continue;
901 if (!posix_locks_conflict(request, fl))
902 continue;
Andy Adamson5842add2006-03-26 01:37:26 -0800903 if (conflock)
J. Bruce Fields1a747ee2008-04-24 10:08:22 -0400904 __locks_copy_lock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 error = -EAGAIN;
906 if (!(request->fl_flags & FL_SLEEP))
907 goto out;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400908 /*
909 * Deadlock detection and insertion into the blocked
910 * locks list must be done while holding the same lock!
911 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 error = -EDEADLK;
Jeff Layton7b2296a2013-06-21 08:58:20 -0400913 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400914 if (likely(!posix_locks_deadlock(request, fl))) {
915 error = FILE_LOCK_DEFERRED;
916 __locks_insert_block(fl, request);
917 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400918 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 goto out;
920 }
921 }
922
923 /* If we're just looking for a conflict, we're done. */
924 error = 0;
925 if (request->fl_flags & FL_ACCESS)
926 goto out;
927
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 * Find the first old lock with the same owner as the new lock.
930 */
931
932 before = &inode->i_flock;
933
934 /* First skip locks owned by other processes. */
935 while ((fl = *before) && (!IS_POSIX(fl) ||
936 !posix_same_owner(request, fl))) {
937 before = &fl->fl_next;
938 }
939
Jeff Layton1cb36012013-06-21 08:58:12 -0400940 /* Process locks with this owner. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 while ((fl = *before) && posix_same_owner(request, fl)) {
942 /* Detect adjacent or overlapping regions (if same lock type)
943 */
944 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -0700945 /* In all comparisons of start vs end, use
946 * "start - 1" rather than "end + 1". If end
947 * is OFFSET_MAX, end + 1 will become negative.
948 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 if (fl->fl_end < request->fl_start - 1)
950 goto next_lock;
951 /* If the next lock in the list has entirely bigger
952 * addresses than the new one, insert the lock here.
953 */
Olaf Kirch449231d2005-08-25 16:25:35 -0700954 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 break;
956
957 /* If we come here, the new and old lock are of the
958 * same type and adjacent or overlapping. Make one
959 * lock yielding from the lower start address of both
960 * locks to the higher end address.
961 */
962 if (fl->fl_start > request->fl_start)
963 fl->fl_start = request->fl_start;
964 else
965 request->fl_start = fl->fl_start;
966 if (fl->fl_end < request->fl_end)
967 fl->fl_end = request->fl_end;
968 else
969 request->fl_end = fl->fl_end;
970 if (added) {
971 locks_delete_lock(before);
972 continue;
973 }
974 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -0400975 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 }
977 else {
978 /* Processing for different lock types is a bit
979 * more complex.
980 */
981 if (fl->fl_end < request->fl_start)
982 goto next_lock;
983 if (fl->fl_start > request->fl_end)
984 break;
985 if (request->fl_type == F_UNLCK)
Jeff Laytonb9746ef2013-06-21 08:58:13 -0400986 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 if (fl->fl_start < request->fl_start)
988 left = fl;
989 /* If the next lock in the list has a higher end
990 * address than the new one, insert the new one here.
991 */
992 if (fl->fl_end > request->fl_end) {
993 right = fl;
994 break;
995 }
996 if (fl->fl_start >= request->fl_start) {
997 /* The new lock completely replaces an old
998 * one (This may happen several times).
999 */
1000 if (added) {
1001 locks_delete_lock(before);
1002 continue;
1003 }
1004 /* Replace the old lock with the new one.
1005 * Wake up anybody waiting for the old one,
1006 * as the change in lock type might satisfy
1007 * their needs.
1008 */
1009 locks_wake_up_blocks(fl);
1010 fl->fl_start = request->fl_start;
1011 fl->fl_end = request->fl_end;
1012 fl->fl_type = request->fl_type;
Trond Myklebust47831f32006-03-20 13:44:05 -05001013 locks_release_private(fl);
1014 locks_copy_private(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001016 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 }
1018 }
1019 /* Go on to next lock.
1020 */
1021 next_lock:
1022 before = &fl->fl_next;
1023 }
1024
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001025 /*
Jeff Layton1cb36012013-06-21 08:58:12 -04001026 * The above code only modifies existing locks in case of merging or
1027 * replacing. If new lock(s) need to be inserted all modifications are
1028 * done below this, so it's safe yet to bail out.
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001029 */
1030 error = -ENOLCK; /* "no luck" */
1031 if (right && left == right && !new_fl2)
1032 goto out;
1033
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 error = 0;
1035 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -04001036 if (request->fl_type == F_UNLCK) {
1037 if (request->fl_flags & FL_EXISTS)
1038 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001040 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001041
1042 if (!new_fl) {
1043 error = -ENOLCK;
1044 goto out;
1045 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 locks_copy_lock(new_fl, request);
1047 locks_insert_lock(before, new_fl);
1048 new_fl = NULL;
1049 }
1050 if (right) {
1051 if (left == right) {
1052 /* The new lock breaks the old one in two pieces,
1053 * so we have to use the second new lock.
1054 */
1055 left = new_fl2;
1056 new_fl2 = NULL;
1057 locks_copy_lock(left, right);
1058 locks_insert_lock(before, left);
1059 }
1060 right->fl_start = request->fl_end + 1;
1061 locks_wake_up_blocks(right);
1062 }
1063 if (left) {
1064 left->fl_end = request->fl_start - 1;
1065 locks_wake_up_blocks(left);
1066 }
1067 out:
Jeff Layton1c8c6012013-06-21 08:58:15 -04001068 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 /*
1070 * Free any unused locks.
1071 */
1072 if (new_fl)
1073 locks_free_lock(new_fl);
1074 if (new_fl2)
1075 locks_free_lock(new_fl2);
1076 return error;
1077}
1078
1079/**
1080 * posix_lock_file - Apply a POSIX-style lock to a file
1081 * @filp: The file to apply the lock to
1082 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001083 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084 *
1085 * Add a POSIX style lock to a file.
1086 * We merge adjacent & overlapping locks whenever possible.
1087 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001088 *
1089 * Note that if called with an FL_EXISTS argument, the caller may determine
1090 * whether or not a lock was successfully freed by testing the return
1091 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 */
Marc Eshel150b3932007-01-18 16:15:35 -05001093int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001094 struct file_lock *conflock)
1095{
Al Viro496ad9a2013-01-23 17:07:38 -05001096 return __posix_lock_file(file_inode(filp), fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001097}
Marc Eshel150b3932007-01-18 16:15:35 -05001098EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099
1100/**
1101 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1102 * @filp: The file to apply the lock to
1103 * @fl: The lock to be applied
1104 *
1105 * Add a POSIX style lock to a file.
1106 * We merge adjacent & overlapping locks whenever possible.
1107 * POSIX locks are sorted by owner task, then by starting address
1108 */
1109int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1110{
1111 int error;
1112 might_sleep ();
1113 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001114 error = posix_lock_file(filp, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001115 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116 break;
1117 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1118 if (!error)
1119 continue;
1120
1121 locks_delete_block(fl);
1122 break;
1123 }
1124 return error;
1125}
1126EXPORT_SYMBOL(posix_lock_file_wait);
1127
1128/**
1129 * locks_mandatory_locked - Check for an active lock
1130 * @inode: the file to check
1131 *
1132 * Searches the inode's list of locks to find any POSIX locks which conflict.
1133 * This function is called from locks_verify_locked() only.
1134 */
1135int locks_mandatory_locked(struct inode *inode)
1136{
1137 fl_owner_t owner = current->files;
1138 struct file_lock *fl;
1139
1140 /*
1141 * Search the lock list for this inode for any POSIX locks.
1142 */
Jeff Layton1c8c6012013-06-21 08:58:15 -04001143 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1145 if (!IS_POSIX(fl))
1146 continue;
1147 if (fl->fl_owner != owner)
1148 break;
1149 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04001150 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 return fl ? -EAGAIN : 0;
1152}
1153
1154/**
1155 * locks_mandatory_area - Check for a conflicting lock
1156 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1157 * for shared
1158 * @inode: the file to check
1159 * @filp: how the file was opened (if it was)
1160 * @offset: start of area to check
1161 * @count: length of area to check
1162 *
1163 * Searches the inode's list of locks to find any POSIX locks which conflict.
1164 * This function is called from rw_verify_area() and
1165 * locks_verify_truncate().
1166 */
1167int locks_mandatory_area(int read_write, struct inode *inode,
1168 struct file *filp, loff_t offset,
1169 size_t count)
1170{
1171 struct file_lock fl;
1172 int error;
1173
1174 locks_init_lock(&fl);
1175 fl.fl_owner = current->files;
1176 fl.fl_pid = current->tgid;
1177 fl.fl_file = filp;
1178 fl.fl_flags = FL_POSIX | FL_ACCESS;
1179 if (filp && !(filp->f_flags & O_NONBLOCK))
1180 fl.fl_flags |= FL_SLEEP;
1181 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1182 fl.fl_start = offset;
1183 fl.fl_end = offset + count - 1;
1184
1185 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001186 error = __posix_lock_file(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001187 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 break;
1189 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1190 if (!error) {
1191 /*
1192 * If we've been sleeping someone might have
1193 * changed the permissions behind our back.
1194 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001195 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 continue;
1197 }
1198
1199 locks_delete_block(&fl);
1200 break;
1201 }
1202
1203 return error;
1204}
1205
1206EXPORT_SYMBOL(locks_mandatory_area);
1207
J. Bruce Fields778fc542011-07-26 18:25:49 -04001208static void lease_clear_pending(struct file_lock *fl, int arg)
1209{
1210 switch (arg) {
1211 case F_UNLCK:
1212 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1213 /* fall through: */
1214 case F_RDLCK:
1215 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1216 }
1217}
1218
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219/* We already had a lease on this file; just change its type */
1220int lease_modify(struct file_lock **before, int arg)
1221{
1222 struct file_lock *fl = *before;
1223 int error = assign_type(fl, arg);
1224
1225 if (error)
1226 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001227 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001229 if (arg == F_UNLCK) {
1230 struct file *filp = fl->fl_file;
1231
1232 f_delown(filp);
1233 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001234 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1235 if (fl->fl_fasync != NULL) {
1236 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1237 fl->fl_fasync = NULL;
1238 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239 locks_delete_lock(before);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001240 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 return 0;
1242}
1243
1244EXPORT_SYMBOL(lease_modify);
1245
J. Bruce Fields778fc542011-07-26 18:25:49 -04001246static bool past_time(unsigned long then)
1247{
1248 if (!then)
1249 /* 0 is a special value meaning "this never expires": */
1250 return false;
1251 return time_after(jiffies, then);
1252}
1253
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254static void time_out_leases(struct inode *inode)
1255{
1256 struct file_lock **before;
1257 struct file_lock *fl;
1258
1259 before = &inode->i_flock;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04001260 while ((fl = *before) && IS_LEASE(fl) && lease_breaking(fl)) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001261 if (past_time(fl->fl_downgrade_time))
1262 lease_modify(before, F_RDLCK);
1263 if (past_time(fl->fl_break_time))
1264 lease_modify(before, F_UNLCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 if (fl == *before) /* lease_modify may have freed fl */
1266 before = &fl->fl_next;
1267 }
1268}
1269
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001270static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1271{
1272 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1273 return false;
1274 return locks_conflict(breaker, lease);
1275}
1276
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277/**
1278 * __break_lease - revoke all outstanding leases on file
1279 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001280 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1281 * break all leases
1282 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1283 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 *
david m. richter87250dd2007-05-09 16:10:27 -04001285 * break_lease (inlined for speed) has checked there already is at least
1286 * some kind of lock (maybe a lease) on this file. Leases are broken on
1287 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 * specified %O_NONBLOCK to your open().
1289 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001290int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001292 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 struct file_lock *new_fl, *flock;
1294 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 unsigned long break_time;
1296 int i_have_this_lease = 0;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001297 bool lease_conflict = false;
Al Viro8737c932009-12-24 06:47:55 -05001298 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299
Al Viro8737c932009-12-24 06:47:55 -05001300 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001301 if (IS_ERR(new_fl))
1302 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001303 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304
Jeff Layton1c8c6012013-06-21 08:58:15 -04001305 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306
1307 time_out_leases(inode);
1308
1309 flock = inode->i_flock;
1310 if ((flock == NULL) || !IS_LEASE(flock))
1311 goto out;
1312
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001313 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1314 if (leases_conflict(fl, new_fl)) {
1315 lease_conflict = true;
1316 if (fl->fl_owner == current->files)
1317 i_have_this_lease = 1;
1318 }
1319 }
1320 if (!lease_conflict)
J. Bruce Fields778fc542011-07-26 18:25:49 -04001321 goto out;
1322
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 break_time = 0;
1324 if (lease_break_time > 0) {
1325 break_time = jiffies + lease_break_time * HZ;
1326 if (break_time == 0)
1327 break_time++; /* so that 0 means no break time */
1328 }
1329
1330 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001331 if (!leases_conflict(fl, new_fl))
1332 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001333 if (want_write) {
1334 if (fl->fl_flags & FL_UNLOCK_PENDING)
1335 continue;
1336 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001338 } else {
1339 if (lease_breaking(flock))
1340 continue;
1341 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1342 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 }
J. Bruce Fields778fc542011-07-26 18:25:49 -04001344 fl->fl_lmops->lm_break(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 }
1346
1347 if (i_have_this_lease || (mode & O_NONBLOCK)) {
1348 error = -EWOULDBLOCK;
1349 goto out;
1350 }
1351
1352restart:
1353 break_time = flock->fl_break_time;
1354 if (break_time != 0) {
1355 break_time -= jiffies;
1356 if (break_time == 0)
1357 break_time++;
1358 }
Matthew Wilcox4321e012008-01-14 21:28:30 -07001359 locks_insert_block(flock, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001360 spin_unlock(&inode->i_lock);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001361 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1362 !new_fl->fl_next, break_time);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001363 spin_lock(&inode->i_lock);
1364 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 if (error >= 0) {
1366 if (error == 0)
1367 time_out_leases(inode);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001368 /*
1369 * Wait for the next conflicting lease that has not been
1370 * broken yet
1371 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1373 flock = flock->fl_next) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001374 if (leases_conflict(new_fl, flock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375 goto restart;
1376 }
1377 error = 0;
1378 }
1379
1380out:
Jeff Layton1c8c6012013-06-21 08:58:15 -04001381 spin_unlock(&inode->i_lock);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001382 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 return error;
1384}
1385
1386EXPORT_SYMBOL(__break_lease);
1387
1388/**
Randy Dunlapa6b91912008-03-19 17:01:00 -07001389 * lease_get_mtime - get the last modified time of an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 * @inode: the inode
1391 * @time: pointer to a timespec which will contain the last modified time
1392 *
1393 * This is to force NFS clients to flush their caches for files with
1394 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001395 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 */
1397void lease_get_mtime(struct inode *inode, struct timespec *time)
1398{
1399 struct file_lock *flock = inode->i_flock;
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04001400 if (flock && IS_LEASE(flock) && (flock->fl_type == F_WRLCK))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 *time = current_fs_time(inode->i_sb);
1402 else
1403 *time = inode->i_mtime;
1404}
1405
1406EXPORT_SYMBOL(lease_get_mtime);
1407
1408/**
1409 * fcntl_getlease - Enquire what lease is currently active
1410 * @filp: the file
1411 *
1412 * The value returned by this function will be one of
1413 * (if no lease break is pending):
1414 *
1415 * %F_RDLCK to indicate a shared lease is held.
1416 *
1417 * %F_WRLCK to indicate an exclusive lease is held.
1418 *
1419 * %F_UNLCK to indicate no lease is held.
1420 *
1421 * (if a lease break is pending):
1422 *
1423 * %F_RDLCK to indicate an exclusive lease needs to be
1424 * changed to a shared lease (or removed).
1425 *
1426 * %F_UNLCK to indicate the lease needs to be removed.
1427 *
1428 * XXX: sfr & willy disagree over whether F_INPROGRESS
1429 * should be returned to userspace.
1430 */
1431int fcntl_getlease(struct file *filp)
1432{
1433 struct file_lock *fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001434 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 int type = F_UNLCK;
1436
Jeff Layton1c8c6012013-06-21 08:58:15 -04001437 spin_lock(&inode->i_lock);
Al Viro496ad9a2013-01-23 17:07:38 -05001438 time_out_leases(file_inode(filp));
1439 for (fl = file_inode(filp)->i_flock; fl && IS_LEASE(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 fl = fl->fl_next) {
1441 if (fl->fl_file == filp) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001442 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443 break;
1444 }
1445 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04001446 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447 return type;
1448}
1449
Jeff Layton24cbe782014-02-03 12:13:06 -05001450/**
1451 * check_conflicting_open - see if the given dentry points to a file that has
1452 * an existing open that would conflict with the
1453 * desired lease.
1454 * @dentry: dentry to check
1455 * @arg: type of lease that we're trying to acquire
1456 *
1457 * Check to see if there's an existing open fd on this file that would
1458 * conflict with the lease we're trying to set.
1459 */
1460static int
1461check_conflicting_open(const struct dentry *dentry, const long arg)
1462{
1463 int ret = 0;
1464 struct inode *inode = dentry->d_inode;
1465
1466 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1467 return -EAGAIN;
1468
1469 if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1470 (atomic_read(&inode->i_count) > 1)))
1471 ret = -EAGAIN;
1472
1473 return ret;
1474}
1475
Jeff Laytond4f22d12013-06-21 08:58:11 -04001476static int generic_add_lease(struct file *filp, long arg, struct file_lock **flp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477{
KAMBAROV, ZAUR7eaae282005-07-07 17:57:06 -07001478 struct file_lock *fl, **before, **my_before = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001479 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 struct inode *inode = dentry->d_inode;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001481 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001482 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483
J. Bruce Fields096657b2010-10-30 17:31:14 -04001484 lease = *flp;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001485 /*
1486 * In the delegation case we need mutual exclusion with
1487 * a number of operations that take the i_mutex. We trylock
1488 * because delegations are an optional optimization, and if
1489 * there's some chance of a conflict--we'd rather not
1490 * bother, maybe that's a sign this just isn't a good file to
1491 * hand out a delegation on.
1492 */
1493 if (is_deleg && !mutex_trylock(&inode->i_mutex))
1494 return -EAGAIN;
1495
1496 if (is_deleg && arg == F_WRLCK) {
1497 /* Write delegations are not currently supported: */
Dan Carpenter4fdb7932013-11-13 10:56:27 +03001498 mutex_unlock(&inode->i_mutex);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001499 WARN_ON_ONCE(1);
1500 return -EINVAL;
1501 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001502
Jeff Layton24cbe782014-02-03 12:13:06 -05001503 error = check_conflicting_open(dentry, arg);
1504 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001505 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001506
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 /*
1508 * At this point, we know that if there is an exclusive
1509 * lease on this file, then we hold it on this filp
1510 * (otherwise our open of this file would have blocked).
1511 * And if we are trying to acquire an exclusive lease,
1512 * then the file is not open by anyone (including us)
1513 * except for this filp.
1514 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001515 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 for (before = &inode->i_flock;
1517 ((fl = *before) != NULL) && IS_LEASE(fl);
1518 before = &fl->fl_next) {
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001519 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 my_before = before;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001521 continue;
1522 }
1523 /*
1524 * No exclusive leases if someone else has a lease on
1525 * this file:
1526 */
1527 if (arg == F_WRLCK)
1528 goto out;
1529 /*
1530 * Modifying our existing lease is OK, but no getting a
1531 * new lease if someone else is opening for write:
1532 */
1533 if (fl->fl_flags & FL_UNLOCK_PENDING)
1534 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 }
1536
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537 if (my_before != NULL) {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001538 error = lease->fl_lmops->lm_change(my_before, arg);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001539 if (!error)
1540 *flp = *my_before;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 goto out;
1542 }
1543
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 error = -EINVAL;
1545 if (!leases_enable)
1546 goto out;
1547
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001548 locks_insert_lock(before, lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001549 /*
1550 * The check in break_lease() is lockless. It's possible for another
1551 * open to race in after we did the earlier check for a conflicting
1552 * open but before the lease was inserted. Check again for a
1553 * conflicting open and cancel the lease if there is one.
1554 *
1555 * We also add a barrier here to ensure that the insertion of the lock
1556 * precedes these checks.
1557 */
1558 smp_mb();
1559 error = check_conflicting_open(dentry, arg);
1560 if (error)
1561 locks_unlink_lock(flp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562out:
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001563 if (is_deleg)
1564 mutex_unlock(&inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 return error;
1566}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001567
Jeff Laytond4f22d12013-06-21 08:58:11 -04001568static int generic_delete_lease(struct file *filp, struct file_lock **flp)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001569{
1570 struct file_lock *fl, **before;
1571 struct dentry *dentry = filp->f_path.dentry;
1572 struct inode *inode = dentry->d_inode;
1573
1574 for (before = &inode->i_flock;
1575 ((fl = *before) != NULL) && IS_LEASE(fl);
1576 before = &fl->fl_next) {
1577 if (fl->fl_file != filp)
1578 continue;
1579 return (*flp)->fl_lmops->lm_change(before, F_UNLCK);
1580 }
1581 return -EAGAIN;
1582}
1583
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584/**
1585 * generic_setlease - sets a lease on an open file
1586 * @filp: file pointer
1587 * @arg: type of lease to obtain
1588 * @flp: input - file_lock to use, output - file_lock inserted
1589 *
1590 * The (input) flp->fl_lmops->lm_break function is required
1591 * by break_lease().
1592 *
Jeff Layton1c8c6012013-06-21 08:58:15 -04001593 * Called with inode->i_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 */
1595int generic_setlease(struct file *filp, long arg, struct file_lock **flp)
1596{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 struct dentry *dentry = filp->f_path.dentry;
1598 struct inode *inode = dentry->d_inode;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001599 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001601 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001602 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001604 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 error = security_file_lock(filp, arg);
1606 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001607 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608
1609 time_out_leases(inode);
1610
1611 BUG_ON(!(*flp)->fl_lmops->lm_break);
1612
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001613 switch (arg) {
1614 case F_UNLCK:
1615 return generic_delete_lease(filp, flp);
1616 case F_RDLCK:
1617 case F_WRLCK:
1618 return generic_add_lease(filp, arg, flp);
1619 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001620 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001623EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001625static int __vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
1626{
Al Viro72c2d532013-09-22 16:27:52 -04001627 if (filp->f_op->setlease)
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001628 return filp->f_op->setlease(filp, arg, lease);
1629 else
1630 return generic_setlease(filp, arg, lease);
1631}
1632
1633/**
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001634 * vfs_setlease - sets a lease on an open file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 * @filp: file pointer
1636 * @arg: type of lease to obtain
1637 * @lease: file_lock to use
1638 *
1639 * Call this to establish a lease on the file.
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001640 * The (*lease)->fl_lmops->lm_break operation must be set; if not,
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001641 * break_lease will oops!
1642 *
1643 * This will call the filesystem's setlease file method, if
1644 * defined. Note that there is no getlease method; instead, the
1645 * filesystem setlease method should call back to setlease() to
1646 * add a lease to the inode's lease list, where fcntl_getlease() can
1647 * find it. Since fcntl_getlease() only reports whether the current
1648 * task holds a lease, a cluster filesystem need only do this for
1649 * leases held by processes on this node.
1650 *
1651 * There is also no break_lease method; filesystems that
Adam Buchbinderc9404c92009-12-18 15:40:42 -05001652 * handle their own leases should break leases themselves from the
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001653 * filesystem's open, create, and (on truncate) setattr methods.
1654 *
1655 * Warning: the only current setlease methods exist only to disable
1656 * leases in certain cases. More vfs changes may be required to
1657 * allow a full filesystem lease implementation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 */
1659
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001660int vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661{
Jeff Layton1c8c6012013-06-21 08:58:15 -04001662 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 int error;
1664
Jeff Layton1c8c6012013-06-21 08:58:15 -04001665 spin_lock(&inode->i_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001666 error = __vfs_setlease(filp, arg, lease);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001667 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668
1669 return error;
1670}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001671EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001673static int do_fcntl_delete_lease(struct file *filp)
1674{
1675 struct file_lock fl, *flp = &fl;
1676
1677 lease_init(filp, F_UNLCK, flp);
1678
1679 return vfs_setlease(filp, F_UNLCK, &flp);
1680}
1681
1682static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683{
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001684 struct file_lock *fl, *ret;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001685 struct inode *inode = file_inode(filp);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001686 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687 int error;
1688
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001689 fl = lease_alloc(filp, arg);
1690 if (IS_ERR(fl))
1691 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001693 new = fasync_alloc();
1694 if (!new) {
1695 locks_free_lock(fl);
1696 return -ENOMEM;
1697 }
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001698 ret = fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001699 spin_lock(&inode->i_lock);
J. Bruce Fields8896b932010-11-03 18:09:18 -04001700 error = __vfs_setlease(filp, arg, &ret);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001701 if (error) {
Jeff Layton1c8c6012013-06-21 08:58:15 -04001702 spin_unlock(&inode->i_lock);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001703 locks_free_lock(fl);
1704 goto out_free_fasync;
1705 }
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001706 if (ret != fl)
1707 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001709 /*
1710 * fasync_insert_entry() returns the old entry if any.
1711 * If there was no old entry, then it used 'new' and
1712 * inserted it into the fasync list. Clear new so that
1713 * we don't release it here.
1714 */
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001715 if (!fasync_insert_entry(fd, filp, &ret->fl_fasync, new))
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001716 new = NULL;
1717
J. Bruce Fields8896b932010-11-03 18:09:18 -04001718 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001719 spin_unlock(&inode->i_lock);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001720
1721out_free_fasync:
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001722 if (new)
1723 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724 return error;
1725}
1726
1727/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001728 * fcntl_setlease - sets a lease on an open file
1729 * @fd: open file descriptor
1730 * @filp: file pointer
1731 * @arg: type of lease to obtain
1732 *
1733 * Call this fcntl to establish a lease on the file.
1734 * Note that you also need to call %F_SETSIG to
1735 * receive a signal when the lease is broken.
1736 */
1737int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1738{
1739 if (arg == F_UNLCK)
1740 return do_fcntl_delete_lease(filp);
1741 return do_fcntl_add_lease(fd, filp, arg);
1742}
1743
1744/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1746 * @filp: The file to apply the lock to
1747 * @fl: The lock to be applied
1748 *
1749 * Add a FLOCK style lock to a file.
1750 */
1751int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1752{
1753 int error;
1754 might_sleep();
1755 for (;;) {
1756 error = flock_lock_file(filp, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001757 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 break;
1759 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1760 if (!error)
1761 continue;
1762
1763 locks_delete_block(fl);
1764 break;
1765 }
1766 return error;
1767}
1768
1769EXPORT_SYMBOL(flock_lock_file_wait);
1770
1771/**
1772 * sys_flock: - flock() system call.
1773 * @fd: the file descriptor to lock.
1774 * @cmd: the type of lock to apply.
1775 *
1776 * Apply a %FL_FLOCK style lock to an open file descriptor.
1777 * The @cmd can be one of
1778 *
1779 * %LOCK_SH -- a shared lock.
1780 *
1781 * %LOCK_EX -- an exclusive lock.
1782 *
1783 * %LOCK_UN -- remove an existing lock.
1784 *
1785 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1786 *
1787 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1788 * processes read and write access respectively.
1789 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001790SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791{
Al Viro2903ff02012-08-28 12:52:22 -04001792 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 struct file_lock *lock;
1794 int can_sleep, unlock;
1795 int error;
1796
1797 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001798 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 goto out;
1800
1801 can_sleep = !(cmd & LOCK_NB);
1802 cmd &= ~LOCK_NB;
1803 unlock = (cmd == LOCK_UN);
1804
Al Viroaeb5d722008-09-02 15:28:45 -04001805 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04001806 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807 goto out_putf;
1808
Al Viro2903ff02012-08-28 12:52:22 -04001809 error = flock_make_lock(f.file, &lock, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 if (error)
1811 goto out_putf;
1812 if (can_sleep)
1813 lock->fl_flags |= FL_SLEEP;
1814
Al Viro2903ff02012-08-28 12:52:22 -04001815 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 if (error)
1817 goto out_free;
1818
Al Viro72c2d532013-09-22 16:27:52 -04001819 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04001820 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 (can_sleep) ? F_SETLKW : F_SETLK,
1822 lock);
1823 else
Al Viro2903ff02012-08-28 12:52:22 -04001824 error = flock_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825
1826 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08001827 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828
1829 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04001830 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 out:
1832 return error;
1833}
1834
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001835/**
1836 * vfs_test_lock - test file byte range lock
1837 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04001838 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001839 *
1840 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1841 * setting conf->fl_type to something other than F_UNLCK.
1842 */
1843int vfs_test_lock(struct file *filp, struct file_lock *fl)
1844{
Al Viro72c2d532013-09-22 16:27:52 -04001845 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001846 return filp->f_op->lock(filp, F_GETLK, fl);
1847 posix_test_lock(filp, fl);
1848 return 0;
1849}
1850EXPORT_SYMBOL_GPL(vfs_test_lock);
1851
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001852static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1853{
1854 flock->l_pid = fl->fl_pid;
1855#if BITS_PER_LONG == 32
1856 /*
1857 * Make sure we can represent the posix lock via
1858 * legacy 32bit flock.
1859 */
1860 if (fl->fl_start > OFFT_OFFSET_MAX)
1861 return -EOVERFLOW;
1862 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1863 return -EOVERFLOW;
1864#endif
1865 flock->l_start = fl->fl_start;
1866 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1867 fl->fl_end - fl->fl_start + 1;
1868 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04001869 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001870 return 0;
1871}
1872
1873#if BITS_PER_LONG == 32
1874static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1875{
1876 flock->l_pid = fl->fl_pid;
1877 flock->l_start = fl->fl_start;
1878 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1879 fl->fl_end - fl->fl_start + 1;
1880 flock->l_whence = 0;
1881 flock->l_type = fl->fl_type;
1882}
1883#endif
1884
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885/* Report the first existing lock that would conflict with l.
1886 * This implements the F_GETLK command of fcntl().
1887 */
1888int fcntl_getlk(struct file *filp, struct flock __user *l)
1889{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001890 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891 struct flock flock;
1892 int error;
1893
1894 error = -EFAULT;
1895 if (copy_from_user(&flock, l, sizeof(flock)))
1896 goto out;
1897 error = -EINVAL;
1898 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1899 goto out;
1900
1901 error = flock_to_posix_lock(filp, &file_lock, &flock);
1902 if (error)
1903 goto out;
1904
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001905 error = vfs_test_lock(filp, &file_lock);
1906 if (error)
1907 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001909 flock.l_type = file_lock.fl_type;
1910 if (file_lock.fl_type != F_UNLCK) {
1911 error = posix_lock_to_flock(&flock, &file_lock);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001912 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914 }
1915 error = -EFAULT;
1916 if (!copy_to_user(l, &flock, sizeof(flock)))
1917 error = 0;
1918out:
1919 return error;
1920}
1921
Marc Eshel7723ec92007-01-18 15:08:55 -05001922/**
1923 * vfs_lock_file - file byte range lock
1924 * @filp: The file to apply the lock to
1925 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1926 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001927 * @conf: Place to return a copy of the conflicting lock, if found.
1928 *
1929 * A caller that doesn't care about the conflicting lock may pass NULL
1930 * as the final argument.
1931 *
1932 * If the filesystem defines a private ->lock() method, then @conf will
1933 * be left unchanged; so a caller that cares should initialize it to
1934 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05001935 *
1936 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1937 * locks, the ->lock() interface may return asynchronously, before the lock has
1938 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001939 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05001940 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1941 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001942 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05001943 * request completes.
1944 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07001945 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
1946 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05001947 * nonzero return code and the file system should release the lock. The file
1948 * system is also responsible to keep a corresponding posix lock when it
1949 * grants a lock so the VFS can find out which locks are locally held and do
1950 * the correct lock cleanup when required.
1951 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001952 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05001953 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05001954 */
Marc Eshel150b3932007-01-18 16:15:35 -05001955int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05001956{
Al Viro72c2d532013-09-22 16:27:52 -04001957 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05001958 return filp->f_op->lock(filp, cmd, fl);
1959 else
Marc Eshel150b3932007-01-18 16:15:35 -05001960 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05001961}
1962EXPORT_SYMBOL_GPL(vfs_lock_file);
1963
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001964static int do_lock_file_wait(struct file *filp, unsigned int cmd,
1965 struct file_lock *fl)
1966{
1967 int error;
1968
1969 error = security_file_lock(filp, fl->fl_type);
1970 if (error)
1971 return error;
1972
Miklos Szeredi764c76b2008-07-25 01:48:58 -07001973 for (;;) {
1974 error = vfs_lock_file(filp, cmd, fl, NULL);
1975 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001976 break;
Miklos Szeredi764c76b2008-07-25 01:48:58 -07001977 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1978 if (!error)
1979 continue;
1980
1981 locks_delete_block(fl);
1982 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001983 }
1984
1985 return error;
1986}
1987
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988/* Apply the lock described by l to an open file descriptor.
1989 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1990 */
Peter Staubachc2936212005-07-27 11:45:09 -07001991int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
1992 struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993{
1994 struct file_lock *file_lock = locks_alloc_lock();
1995 struct flock flock;
1996 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04001997 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998 int error;
1999
2000 if (file_lock == NULL)
2001 return -ENOLCK;
2002
2003 /*
2004 * This might block, so we do it before checking the inode.
2005 */
2006 error = -EFAULT;
2007 if (copy_from_user(&flock, l, sizeof(flock)))
2008 goto out;
2009
Al Viro496ad9a2013-01-23 17:07:38 -05002010 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011
2012 /* Don't allow mandatory locks on files that may be memory mapped
2013 * and shared.
2014 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002015 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 error = -EAGAIN;
2017 goto out;
2018 }
2019
Peter Staubachc2936212005-07-27 11:45:09 -07002020again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 error = flock_to_posix_lock(filp, file_lock, &flock);
2022 if (error)
2023 goto out;
2024 if (cmd == F_SETLKW) {
2025 file_lock->fl_flags |= FL_SLEEP;
2026 }
2027
2028 error = -EBADF;
2029 switch (flock.l_type) {
2030 case F_RDLCK:
2031 if (!(filp->f_mode & FMODE_READ))
2032 goto out;
2033 break;
2034 case F_WRLCK:
2035 if (!(filp->f_mode & FMODE_WRITE))
2036 goto out;
2037 break;
2038 case F_UNLCK:
2039 break;
2040 default:
2041 error = -EINVAL;
2042 goto out;
2043 }
2044
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002045 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046
Peter Staubachc2936212005-07-27 11:45:09 -07002047 /*
2048 * Attempt to detect a close/fcntl race and recover by
2049 * releasing the lock that was just acquired.
2050 */
Al Viro0b2bac22008-05-06 13:58:34 -04002051 /*
2052 * we need that spin_lock here - it prevents reordering between
2053 * update of inode->i_flock and check for it done in close().
2054 * rcu_read_lock() wouldn't do.
2055 */
2056 spin_lock(&current->files->file_lock);
2057 f = fcheck(fd);
2058 spin_unlock(&current->files->file_lock);
2059 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002060 flock.l_type = F_UNLCK;
2061 goto again;
2062 }
2063
2064out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065 locks_free_lock(file_lock);
2066 return error;
2067}
2068
2069#if BITS_PER_LONG == 32
2070/* Report the first existing lock that would conflict with l.
2071 * This implements the F_GETLK command of fcntl().
2072 */
2073int fcntl_getlk64(struct file *filp, struct flock64 __user *l)
2074{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002075 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076 struct flock64 flock;
2077 int error;
2078
2079 error = -EFAULT;
2080 if (copy_from_user(&flock, l, sizeof(flock)))
2081 goto out;
2082 error = -EINVAL;
2083 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2084 goto out;
2085
2086 error = flock64_to_posix_lock(filp, &file_lock, &flock);
2087 if (error)
2088 goto out;
2089
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002090 error = vfs_test_lock(filp, &file_lock);
2091 if (error)
2092 goto out;
2093
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002094 flock.l_type = file_lock.fl_type;
2095 if (file_lock.fl_type != F_UNLCK)
2096 posix_lock_to_flock64(&flock, &file_lock);
2097
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 error = -EFAULT;
2099 if (!copy_to_user(l, &flock, sizeof(flock)))
2100 error = 0;
2101
2102out:
2103 return error;
2104}
2105
2106/* Apply the lock described by l to an open file descriptor.
2107 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2108 */
Peter Staubachc2936212005-07-27 11:45:09 -07002109int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2110 struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111{
2112 struct file_lock *file_lock = locks_alloc_lock();
2113 struct flock64 flock;
2114 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002115 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116 int error;
2117
2118 if (file_lock == NULL)
2119 return -ENOLCK;
2120
2121 /*
2122 * This might block, so we do it before checking the inode.
2123 */
2124 error = -EFAULT;
2125 if (copy_from_user(&flock, l, sizeof(flock)))
2126 goto out;
2127
Al Viro496ad9a2013-01-23 17:07:38 -05002128 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129
2130 /* Don't allow mandatory locks on files that may be memory mapped
2131 * and shared.
2132 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002133 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134 error = -EAGAIN;
2135 goto out;
2136 }
2137
Peter Staubachc2936212005-07-27 11:45:09 -07002138again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 error = flock64_to_posix_lock(filp, file_lock, &flock);
2140 if (error)
2141 goto out;
2142 if (cmd == F_SETLKW64) {
2143 file_lock->fl_flags |= FL_SLEEP;
2144 }
2145
2146 error = -EBADF;
2147 switch (flock.l_type) {
2148 case F_RDLCK:
2149 if (!(filp->f_mode & FMODE_READ))
2150 goto out;
2151 break;
2152 case F_WRLCK:
2153 if (!(filp->f_mode & FMODE_WRITE))
2154 goto out;
2155 break;
2156 case F_UNLCK:
2157 break;
2158 default:
2159 error = -EINVAL;
2160 goto out;
2161 }
2162
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002163 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164
Peter Staubachc2936212005-07-27 11:45:09 -07002165 /*
2166 * Attempt to detect a close/fcntl race and recover by
2167 * releasing the lock that was just acquired.
2168 */
Al Viro0b2bac22008-05-06 13:58:34 -04002169 spin_lock(&current->files->file_lock);
2170 f = fcheck(fd);
2171 spin_unlock(&current->files->file_lock);
2172 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002173 flock.l_type = F_UNLCK;
2174 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 }
2176
2177out:
2178 locks_free_lock(file_lock);
2179 return error;
2180}
2181#endif /* BITS_PER_LONG == 32 */
2182
2183/*
2184 * This function is called when the file is being removed
2185 * from the task's fd array. POSIX locks belonging to this task
2186 * are deleted at this time.
2187 */
2188void locks_remove_posix(struct file *filp, fl_owner_t owner)
2189{
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002190 struct file_lock lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191
2192 /*
2193 * If there are no locks held on this file, we don't need to call
2194 * posix_lock_file(). Another process could be setting a lock on this
2195 * file at the same time, but we wouldn't remove that lock anyway.
2196 */
Al Viro496ad9a2013-01-23 17:07:38 -05002197 if (!file_inode(filp)->i_flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 return;
2199
2200 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002201 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202 lock.fl_start = 0;
2203 lock.fl_end = OFFSET_MAX;
2204 lock.fl_owner = owner;
2205 lock.fl_pid = current->tgid;
2206 lock.fl_file = filp;
2207 lock.fl_ops = NULL;
2208 lock.fl_lmops = NULL;
2209
Marc Eshel150b3932007-01-18 16:15:35 -05002210 vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2213 lock.fl_ops->fl_release_private(&lock);
2214}
2215
2216EXPORT_SYMBOL(locks_remove_posix);
2217
2218/*
2219 * This function is called on the last close of an open file.
2220 */
2221void locks_remove_flock(struct file *filp)
2222{
Al Viro496ad9a2013-01-23 17:07:38 -05002223 struct inode * inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 struct file_lock *fl;
2225 struct file_lock **before;
2226
2227 if (!inode->i_flock)
2228 return;
2229
Al Viro72c2d532013-09-22 16:27:52 -04002230 if (filp->f_op->flock) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231 struct file_lock fl = {
2232 .fl_pid = current->tgid,
2233 .fl_file = filp,
2234 .fl_flags = FL_FLOCK,
2235 .fl_type = F_UNLCK,
2236 .fl_end = OFFSET_MAX,
2237 };
2238 filp->f_op->flock(filp, F_SETLKW, &fl);
Trond Myklebust80fec4c2005-06-22 17:16:31 +00002239 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2240 fl.fl_ops->fl_release_private(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241 }
2242
Jeff Layton1c8c6012013-06-21 08:58:15 -04002243 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244 before = &inode->i_flock;
2245
2246 while ((fl = *before) != NULL) {
2247 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 if (IS_LEASE(fl)) {
2249 lease_modify(before, F_UNLCK);
2250 continue;
2251 }
Jeff Layton8c3cac52014-02-03 12:13:07 -05002252
2253 /*
2254 * There's a leftover lock on the list of a type that
2255 * we didn't expect to see. Most likely a classic
2256 * POSIX lock that ended up not getting released
2257 * properly, or that raced onto the list somehow. Log
2258 * some info about it and then just remove it from
2259 * the list.
2260 */
2261 WARN(!IS_FLOCK(fl),
2262 "leftover lock: dev=%u:%u ino=%lu type=%hhd flags=0x%x start=%lld end=%lld\n",
2263 MAJOR(inode->i_sb->s_dev),
2264 MINOR(inode->i_sb->s_dev), inode->i_ino,
2265 fl->fl_type, fl->fl_flags,
2266 fl->fl_start, fl->fl_end);
2267
2268 locks_delete_lock(before);
2269 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270 }
2271 before = &fl->fl_next;
2272 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002273 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274}
2275
2276/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 * posix_unblock_lock - stop waiting for a file lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 * @waiter: the lock which was waiting
2279 *
2280 * lockd needs to block waiting for locks.
2281 */
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002282int
Jeff Laytonf891a292013-06-21 08:58:09 -04002283posix_unblock_lock(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284{
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002285 int status = 0;
2286
Jeff Layton7b2296a2013-06-21 08:58:20 -04002287 spin_lock(&blocked_lock_lock);
J. Bruce Fields5996a292006-01-03 09:55:44 +01002288 if (waiter->fl_next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 __locks_delete_block(waiter);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002290 else
2291 status = -ENOENT;
Jeff Layton7b2296a2013-06-21 08:58:20 -04002292 spin_unlock(&blocked_lock_lock);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002293 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295EXPORT_SYMBOL(posix_unblock_lock);
2296
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002297/**
2298 * vfs_cancel_lock - file byte range unblock lock
2299 * @filp: The file to apply the unblock to
2300 * @fl: The lock to be unblocked
2301 *
2302 * Used by lock managers to cancel blocked requests
2303 */
2304int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2305{
Al Viro72c2d532013-09-22 16:27:52 -04002306 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002307 return filp->f_op->lock(filp, F_CANCELLK, fl);
2308 return 0;
2309}
2310
2311EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2312
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002313#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002314#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002315#include <linux/seq_file.h>
2316
Jeff Layton7012b022013-06-21 08:58:22 -04002317struct locks_iterator {
2318 int li_cpu;
2319 loff_t li_pos;
2320};
2321
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002322static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002323 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324{
2325 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002326 unsigned int fl_pid;
2327
2328 if (fl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -08002329 fl_pid = pid_vnr(fl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002330 else
2331 fl_pid = fl->fl_pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332
2333 if (fl->fl_file != NULL)
Al Viro496ad9a2013-01-23 17:07:38 -05002334 inode = file_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335
Jerome Marchand99dc8292010-10-26 14:22:33 -07002336 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 if (IS_POSIX(fl)) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002338 seq_printf(f, "%6s %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339 (fl->fl_flags & FL_ACCESS) ? "ACCESS" : "POSIX ",
2340 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002341 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342 } else if (IS_FLOCK(fl)) {
2343 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002344 seq_printf(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002346 seq_printf(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 }
2348 } else if (IS_LEASE(fl)) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002349 seq_printf(f, "LEASE ");
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002350 if (lease_breaking(fl))
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002351 seq_printf(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352 else if (fl->fl_file)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002353 seq_printf(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002355 seq_printf(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002357 seq_printf(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358 }
2359 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002360 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361 (fl->fl_type & LOCK_READ)
2362 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2363 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2364 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002365 seq_printf(f, "%s ",
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002366 (lease_breaking(fl))
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04002367 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2368 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369 }
2370 if (inode) {
2371#ifdef WE_CAN_BREAK_LSLK_NOW
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002372 seq_printf(f, "%d %s:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373 inode->i_sb->s_id, inode->i_ino);
2374#else
2375 /* userspace relies on this representation of dev_t ;-( */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002376 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377 MAJOR(inode->i_sb->s_dev),
2378 MINOR(inode->i_sb->s_dev), inode->i_ino);
2379#endif
2380 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002381 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382 }
2383 if (IS_POSIX(fl)) {
2384 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002385 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002387 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002389 seq_printf(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390 }
2391}
2392
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002393static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394{
Jeff Layton7012b022013-06-21 08:58:22 -04002395 struct locks_iterator *iter = f->private;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002396 struct file_lock *fl, *bfl;
2397
Jeff Layton139ca042013-06-21 08:58:17 -04002398 fl = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002399
Jeff Layton7012b022013-06-21 08:58:22 -04002400 lock_get_status(f, fl, iter->li_pos, "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002401
2402 list_for_each_entry(bfl, &fl->fl_block, fl_block)
Jeff Layton7012b022013-06-21 08:58:22 -04002403 lock_get_status(f, bfl, iter->li_pos, " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002404
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002405 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002406}
2407
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002408static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002409 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002410{
Jeff Layton7012b022013-06-21 08:58:22 -04002411 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002412
Jeff Layton7012b022013-06-21 08:58:22 -04002413 iter->li_pos = *pos + 1;
2414 lg_global_lock(&file_lock_lglock);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002415 spin_lock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002416 return seq_hlist_start_percpu(&file_lock_list, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417}
2418
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002419static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2420{
Jeff Layton7012b022013-06-21 08:58:22 -04002421 struct locks_iterator *iter = f->private;
2422
2423 ++iter->li_pos;
2424 return seq_hlist_next_percpu(v, &file_lock_list, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002425}
2426
2427static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002428 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002429{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002430 spin_unlock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002431 lg_global_unlock(&file_lock_lglock);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002432}
2433
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002434static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002435 .start = locks_start,
2436 .next = locks_next,
2437 .stop = locks_stop,
2438 .show = locks_show,
2439};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002440
2441static int locks_open(struct inode *inode, struct file *filp)
2442{
Jeff Layton7012b022013-06-21 08:58:22 -04002443 return seq_open_private(filp, &locks_seq_operations,
2444 sizeof(struct locks_iterator));
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002445}
2446
2447static const struct file_operations proc_locks_operations = {
2448 .open = locks_open,
2449 .read = seq_read,
2450 .llseek = seq_lseek,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002451 .release = seq_release_private,
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002452};
2453
2454static int __init proc_locks_init(void)
2455{
2456 proc_create("locks", 0, NULL, &proc_locks_operations);
2457 return 0;
2458}
2459module_init(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002460#endif
2461
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462/**
2463 * lock_may_read - checks that the region is free of locks
2464 * @inode: the inode that is being read
2465 * @start: the first byte to read
2466 * @len: the number of bytes to read
2467 *
2468 * Emulates Windows locking requirements. Whole-file
2469 * mandatory locks (share modes) can prohibit a read and
2470 * byte-range POSIX locks can prohibit a read if they overlap.
2471 *
2472 * N.B. this function is only ever called
2473 * from knfsd and ownership of locks is never checked.
2474 */
2475int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2476{
2477 struct file_lock *fl;
2478 int result = 1;
Jeff Layton1c8c6012013-06-21 08:58:15 -04002479
2480 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2482 if (IS_POSIX(fl)) {
2483 if (fl->fl_type == F_RDLCK)
2484 continue;
2485 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2486 continue;
2487 } else if (IS_FLOCK(fl)) {
2488 if (!(fl->fl_type & LOCK_MAND))
2489 continue;
2490 if (fl->fl_type & LOCK_READ)
2491 continue;
2492 } else
2493 continue;
2494 result = 0;
2495 break;
2496 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002497 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002498 return result;
2499}
2500
2501EXPORT_SYMBOL(lock_may_read);
2502
2503/**
2504 * lock_may_write - checks that the region is free of locks
2505 * @inode: the inode that is being written
2506 * @start: the first byte to write
2507 * @len: the number of bytes to write
2508 *
2509 * Emulates Windows locking requirements. Whole-file
2510 * mandatory locks (share modes) can prohibit a write and
2511 * byte-range POSIX locks can prohibit a write if they overlap.
2512 *
2513 * N.B. this function is only ever called
2514 * from knfsd and ownership of locks is never checked.
2515 */
2516int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2517{
2518 struct file_lock *fl;
2519 int result = 1;
Jeff Layton1c8c6012013-06-21 08:58:15 -04002520
2521 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2523 if (IS_POSIX(fl)) {
2524 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2525 continue;
2526 } else if (IS_FLOCK(fl)) {
2527 if (!(fl->fl_type & LOCK_MAND))
2528 continue;
2529 if (fl->fl_type & LOCK_WRITE)
2530 continue;
2531 } else
2532 continue;
2533 result = 0;
2534 break;
2535 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002536 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537 return result;
2538}
2539
2540EXPORT_SYMBOL(lock_may_write);
2541
Linus Torvalds1da177e2005-04-16 15:20:36 -07002542static int __init filelock_init(void)
2543{
Jeff Layton7012b022013-06-21 08:58:22 -04002544 int i;
2545
Linus Torvalds1da177e2005-04-16 15:20:36 -07002546 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002547 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2548
Jeff Layton7012b022013-06-21 08:58:22 -04002549 lg_lock_init(&file_lock_lglock, "file_lock_lglock");
2550
2551 for_each_possible_cpu(i)
2552 INIT_HLIST_HEAD(per_cpu_ptr(&file_lock_list, i));
2553
Linus Torvalds1da177e2005-04-16 15:20:36 -07002554 return 0;
2555}
2556
2557core_initcall(filelock_init);