blob: 2c2d4f5022a7df0925d1ac099278ca2497d0a83b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/fs/locks.c
3 *
4 * Provide support for fcntl()'s F_GETLK, F_SETLK, and F_SETLKW calls.
5 * Doug Evans (dje@spiff.uucp), August 07, 1992
6 *
7 * Deadlock detection added.
8 * FIXME: one thing isn't handled yet:
9 * - mandatory locks (requires lots of changes elsewhere)
10 * Kelly Carmichael (kelly@[142.24.8.65]), September 17, 1994.
11 *
12 * Miscellaneous edits, and a total rewrite of posix_lock_file() code.
13 * Kai Petzke (wpp@marie.physik.tu-berlin.de), 1994
14 *
15 * Converted file_lock_table to a linked list from an array, which eliminates
16 * the limits on how many active file locks are open.
17 * Chad Page (pageone@netcom.com), November 27, 1994
18 *
19 * Removed dependency on file descriptors. dup()'ed file descriptors now
20 * get the same locks as the original file descriptors, and a close() on
21 * any file descriptor removes ALL the locks on the file for the current
22 * process. Since locks still depend on the process id, locks are inherited
23 * after an exec() but not after a fork(). This agrees with POSIX, and both
24 * BSD and SVR4 practice.
25 * Andy Walker (andy@lysaker.kvaerner.no), February 14, 1995
26 *
27 * Scrapped free list which is redundant now that we allocate locks
28 * dynamically with kmalloc()/kfree().
29 * Andy Walker (andy@lysaker.kvaerner.no), February 21, 1995
30 *
31 * Implemented two lock personalities - FL_FLOCK and FL_POSIX.
32 *
33 * FL_POSIX locks are created with calls to fcntl() and lockf() through the
34 * fcntl() system call. They have the semantics described above.
35 *
36 * FL_FLOCK locks are created with calls to flock(), through the flock()
37 * system call, which is new. Old C libraries implement flock() via fcntl()
38 * and will continue to use the old, broken implementation.
39 *
40 * FL_FLOCK locks follow the 4.4 BSD flock() semantics. They are associated
41 * with a file pointer (filp). As a result they can be shared by a parent
42 * process and its children after a fork(). They are removed when the last
43 * file descriptor referring to the file pointer is closed (unless explicitly
44 * unlocked).
45 *
46 * FL_FLOCK locks never deadlock, an existing lock is always removed before
47 * upgrading from shared to exclusive (or vice versa). When this happens
48 * any processes blocked by the current lock are woken up and allowed to
49 * run before the new lock is applied.
50 * Andy Walker (andy@lysaker.kvaerner.no), June 09, 1995
51 *
52 * Removed some race conditions in flock_lock_file(), marked other possible
53 * races. Just grep for FIXME to see them.
54 * Dmitry Gorodchanin (pgmdsg@ibi.com), February 09, 1996.
55 *
56 * Addressed Dmitry's concerns. Deadlock checking no longer recursive.
57 * Lock allocation changed to GFP_ATOMIC as we can't afford to sleep
58 * once we've checked for blocking and deadlocking.
59 * Andy Walker (andy@lysaker.kvaerner.no), April 03, 1996.
60 *
61 * Initial implementation of mandatory locks. SunOS turned out to be
62 * a rotten model, so I implemented the "obvious" semantics.
Paul Bolle395cf962011-08-15 02:02:26 +020063 * See 'Documentation/filesystems/mandatory-locking.txt' for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 * Andy Walker (andy@lysaker.kvaerner.no), April 06, 1996.
65 *
66 * Don't allow mandatory locks on mmap()'ed files. Added simple functions to
67 * check if a file has mandatory locks, used by mmap(), open() and creat() to
68 * see if system call should be rejected. Ref. HP-UX/SunOS/Solaris Reference
69 * Manual, Section 2.
70 * Andy Walker (andy@lysaker.kvaerner.no), April 09, 1996.
71 *
72 * Tidied up block list handling. Added '/proc/locks' interface.
73 * Andy Walker (andy@lysaker.kvaerner.no), April 24, 1996.
74 *
75 * Fixed deadlock condition for pathological code that mixes calls to
76 * flock() and fcntl().
77 * Andy Walker (andy@lysaker.kvaerner.no), April 29, 1996.
78 *
79 * Allow only one type of locking scheme (FL_POSIX or FL_FLOCK) to be in use
80 * for a given file at a time. Changed the CONFIG_LOCK_MANDATORY scheme to
81 * guarantee sensible behaviour in the case where file system modules might
82 * be compiled with different options than the kernel itself.
83 * Andy Walker (andy@lysaker.kvaerner.no), May 15, 1996.
84 *
85 * Added a couple of missing wake_up() calls. Thanks to Thomas Meckel
86 * (Thomas.Meckel@mni.fh-giessen.de) for spotting this.
87 * Andy Walker (andy@lysaker.kvaerner.no), May 15, 1996.
88 *
89 * Changed FL_POSIX locks to use the block list in the same way as FL_FLOCK
90 * locks. Changed process synchronisation to avoid dereferencing locks that
91 * have already been freed.
92 * Andy Walker (andy@lysaker.kvaerner.no), Sep 21, 1996.
93 *
94 * Made the block list a circular list to minimise searching in the list.
95 * Andy Walker (andy@lysaker.kvaerner.no), Sep 25, 1996.
96 *
97 * Made mandatory locking a mount option. Default is not to allow mandatory
98 * locking.
99 * Andy Walker (andy@lysaker.kvaerner.no), Oct 04, 1996.
100 *
101 * Some adaptations for NFS support.
102 * Olaf Kirch (okir@monad.swb.de), Dec 1996,
103 *
104 * Fixed /proc/locks interface so that we can't overrun the buffer we are handed.
105 * Andy Walker (andy@lysaker.kvaerner.no), May 12, 1997.
106 *
107 * Use slab allocator instead of kmalloc/kfree.
108 * Use generic list implementation from <linux/list.h>.
109 * Sped up posix_locks_deadlock by only considering blocked locks.
110 * Matthew Wilcox <willy@debian.org>, March, 2000.
111 *
112 * Leases and LOCK_MAND
113 * Matthew Wilcox <willy@debian.org>, June, 2000.
114 * Stephen Rothwell <sfr@canb.auug.org.au>, June, 2000.
115 */
116
117#include <linux/capability.h>
118#include <linux/file.h>
Al Viro9f3acc32008-04-24 07:44:08 -0400119#include <linux/fdtable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120#include <linux/fs.h>
121#include <linux/init.h>
122#include <linux/module.h>
123#include <linux/security.h>
124#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125#include <linux/syscalls.h>
126#include <linux/time.h>
Dipankar Sarma4fb3a532005-09-16 19:28:13 -0700127#include <linux/rcupdate.h>
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000128#include <linux/pid_namespace.h>
Jeff Layton48f74182013-06-21 08:58:18 -0400129#include <linux/hashtable.h>
Jeff Layton7012b022013-06-21 08:58:22 -0400130#include <linux/percpu.h>
131#include <linux/lglock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Jeff Layton62af4f12014-05-09 14:13:05 -0400133#define CREATE_TRACE_POINTS
134#include <trace/events/filelock.h>
135
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136#include <asm/uaccess.h>
137
138#define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
139#define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
J. Bruce Fields617588d2011-07-01 15:18:34 -0400140#define IS_LEASE(fl) (fl->fl_flags & (FL_LEASE|FL_DELEG))
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400141#define IS_OFDLCK(fl) (fl->fl_flags & FL_OFDLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400143static bool lease_breaking(struct file_lock *fl)
144{
J. Bruce Fields778fc542011-07-26 18:25:49 -0400145 return fl->fl_flags & (FL_UNLOCK_PENDING | FL_DOWNGRADE_PENDING);
146}
147
148static int target_leasetype(struct file_lock *fl)
149{
150 if (fl->fl_flags & FL_UNLOCK_PENDING)
151 return F_UNLCK;
152 if (fl->fl_flags & FL_DOWNGRADE_PENDING)
153 return F_RDLCK;
154 return fl->fl_type;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400155}
156
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157int leases_enable = 1;
158int lease_break_time = 45;
159
160#define for_each_lock(inode, lockp) \
161 for (lockp = &inode->i_flock; *lockp != NULL; lockp = &(*lockp)->fl_next)
162
Jeff Layton1c8c6012013-06-21 08:58:15 -0400163/*
Jeff Layton7012b022013-06-21 08:58:22 -0400164 * The global file_lock_list is only used for displaying /proc/locks, so we
165 * keep a list on each CPU, with each list protected by its own spinlock via
166 * the file_lock_lglock. Note that alterations to the list also require that
167 * the relevant i_lock is held.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400168 */
Jeff Layton7012b022013-06-21 08:58:22 -0400169DEFINE_STATIC_LGLOCK(file_lock_lglock);
170static DEFINE_PER_CPU(struct hlist_head, file_lock_list);
Jeff Layton88974692013-06-21 08:58:14 -0400171
Jeff Layton1c8c6012013-06-21 08:58:15 -0400172/*
Jeff Layton48f74182013-06-21 08:58:18 -0400173 * The blocked_hash is used to find POSIX lock loops for deadlock detection.
Jeff Layton7b2296a2013-06-21 08:58:20 -0400174 * It is protected by blocked_lock_lock.
Jeff Layton48f74182013-06-21 08:58:18 -0400175 *
176 * We hash locks by lockowner in order to optimize searching for the lock a
177 * particular lockowner is waiting on.
178 *
179 * FIXME: make this value scale via some heuristic? We generally will want more
180 * buckets when we have more lockowners holding locks, but that's a little
181 * difficult to determine without knowing what the workload will look like.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400182 */
Jeff Layton48f74182013-06-21 08:58:18 -0400183#define BLOCKED_HASH_BITS 7
184static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
Jeff Layton88974692013-06-21 08:58:14 -0400185
Jeff Layton1c8c6012013-06-21 08:58:15 -0400186/*
Jeff Layton7b2296a2013-06-21 08:58:20 -0400187 * This lock protects the blocked_hash. Generally, if you're accessing it, you
188 * want to be holding this lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400189 *
190 * In addition, it also protects the fl->fl_block list, and the fl->fl_next
191 * pointer for file_lock structures that are acting as lock requests (in
192 * contrast to those that are acting as records of acquired locks).
193 *
194 * Note that when we acquire this lock in order to change the above fields,
195 * we often hold the i_lock as well. In certain cases, when reading the fields
196 * protected by this lock, we can skip acquiring it iff we already hold the
197 * i_lock.
198 *
199 * In particular, adding an entry to the fl_block list requires that you hold
200 * both the i_lock and the blocked_lock_lock (acquired in that order). Deleting
201 * an entry from the list however only requires the file_lock_lock.
202 */
Jeff Layton7b2296a2013-06-21 08:58:20 -0400203static DEFINE_SPINLOCK(blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Christoph Lametere18b8902006-12-06 20:33:20 -0800205static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Miklos Szerediee19cc42011-07-07 13:06:09 +0200207static void locks_init_lock_heads(struct file_lock *fl)
Miklos Szeredia51cb912011-07-06 12:33:55 +0200208{
Jeff Layton139ca042013-06-21 08:58:17 -0400209 INIT_HLIST_NODE(&fl->fl_link);
Miklos Szerediee19cc42011-07-07 13:06:09 +0200210 INIT_LIST_HEAD(&fl->fl_block);
211 init_waitqueue_head(&fl->fl_wait);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200212}
213
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200215struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200217 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200218
219 if (fl)
Miklos Szerediee19cc42011-07-07 13:06:09 +0200220 locks_init_lock_heads(fl);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200221
222 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200224EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500226void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500227{
228 if (fl->fl_ops) {
229 if (fl->fl_ops->fl_release_private)
230 fl->fl_ops->fl_release_private(fl);
231 fl->fl_ops = NULL;
232 }
J. Bruce Fields068535f2012-08-01 07:56:16 -0400233 fl->fl_lmops = NULL;
Trond Myklebust47831f32006-03-20 13:44:05 -0500234
235}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500236EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500237
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238/* Free a lock which is not in use. */
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400239void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240{
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800241 BUG_ON(waitqueue_active(&fl->fl_wait));
242 BUG_ON(!list_empty(&fl->fl_block));
Jeff Layton139ca042013-06-21 08:58:17 -0400243 BUG_ON(!hlist_unhashed(&fl->fl_link));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
Trond Myklebust47831f32006-03-20 13:44:05 -0500245 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 kmem_cache_free(filelock_cache, fl);
247}
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400248EXPORT_SYMBOL(locks_free_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
250void locks_init_lock(struct file_lock *fl)
251{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200252 memset(fl, 0, sizeof(struct file_lock));
253 locks_init_lock_heads(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254}
255
256EXPORT_SYMBOL(locks_init_lock);
257
Trond Myklebust47831f32006-03-20 13:44:05 -0500258static void locks_copy_private(struct file_lock *new, struct file_lock *fl)
259{
260 if (fl->fl_ops) {
261 if (fl->fl_ops->fl_copy_lock)
262 fl->fl_ops->fl_copy_lock(new, fl);
263 new->fl_ops = fl->fl_ops;
264 }
Christoph Hellwigbb8430a2010-10-31 08:35:31 -0400265 if (fl->fl_lmops)
Trond Myklebust47831f32006-03-20 13:44:05 -0500266 new->fl_lmops = fl->fl_lmops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500267}
268
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269/*
270 * Initialize a new lock from an existing file_lock structure.
271 */
J. Bruce Fields1a747ee2008-04-24 10:08:22 -0400272void __locks_copy_lock(struct file_lock *new, const struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273{
274 new->fl_owner = fl->fl_owner;
275 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500276 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 new->fl_flags = fl->fl_flags;
278 new->fl_type = fl->fl_type;
279 new->fl_start = fl->fl_start;
280 new->fl_end = fl->fl_end;
Trond Myklebust09969052006-03-20 13:44:38 -0500281 new->fl_ops = NULL;
282 new->fl_lmops = NULL;
283}
Roland Dreier3dd7b712008-04-25 15:32:51 -0700284EXPORT_SYMBOL(__locks_copy_lock);
Trond Myklebust09969052006-03-20 13:44:38 -0500285
286void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
287{
Jeff Layton566709b2014-08-11 14:09:35 -0400288 /* "new" must be a freshly-initialized lock */
289 WARN_ON_ONCE(new->fl_ops);
Trond Myklebust09969052006-03-20 13:44:38 -0500290
291 __locks_copy_lock(new, fl);
292 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 new->fl_ops = fl->fl_ops;
294 new->fl_lmops = fl->fl_lmops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500295
296 locks_copy_private(new, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297}
298
299EXPORT_SYMBOL(locks_copy_lock);
300
301static inline int flock_translate_cmd(int cmd) {
302 if (cmd & LOCK_MAND)
303 return cmd & (LOCK_MAND | LOCK_RW);
304 switch (cmd) {
305 case LOCK_SH:
306 return F_RDLCK;
307 case LOCK_EX:
308 return F_WRLCK;
309 case LOCK_UN:
310 return F_UNLCK;
311 }
312 return -EINVAL;
313}
314
315/* Fill in a file_lock structure with an appropriate FLOCK lock. */
316static int flock_make_lock(struct file *filp, struct file_lock **lock,
317 unsigned int cmd)
318{
319 struct file_lock *fl;
320 int type = flock_translate_cmd(cmd);
321 if (type < 0)
322 return type;
323
324 fl = locks_alloc_lock();
325 if (fl == NULL)
326 return -ENOMEM;
327
328 fl->fl_file = filp;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +0200329 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 fl->fl_pid = current->tgid;
331 fl->fl_flags = FL_FLOCK;
332 fl->fl_type = type;
333 fl->fl_end = OFFSET_MAX;
334
335 *lock = fl;
336 return 0;
337}
338
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400339static int assign_type(struct file_lock *fl, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340{
341 switch (type) {
342 case F_RDLCK:
343 case F_WRLCK:
344 case F_UNLCK:
345 fl->fl_type = type;
346 break;
347 default:
348 return -EINVAL;
349 }
350 return 0;
351}
352
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500353static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
354 struct flock64 *l)
355{
356 switch (l->l_whence) {
357 case SEEK_SET:
358 fl->fl_start = 0;
359 break;
360 case SEEK_CUR:
361 fl->fl_start = filp->f_pos;
362 break;
363 case SEEK_END:
364 fl->fl_start = i_size_read(file_inode(filp));
365 break;
366 default:
367 return -EINVAL;
368 }
369 if (l->l_start > OFFSET_MAX - fl->fl_start)
370 return -EOVERFLOW;
371 fl->fl_start += l->l_start;
372 if (fl->fl_start < 0)
373 return -EINVAL;
374
375 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
376 POSIX-2001 defines it. */
377 if (l->l_len > 0) {
378 if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
379 return -EOVERFLOW;
380 fl->fl_end = fl->fl_start + l->l_len - 1;
381
382 } else if (l->l_len < 0) {
383 if (fl->fl_start + l->l_len < 0)
384 return -EINVAL;
385 fl->fl_end = fl->fl_start - 1;
386 fl->fl_start += l->l_len;
387 } else
388 fl->fl_end = OFFSET_MAX;
389
390 fl->fl_owner = current->files;
391 fl->fl_pid = current->tgid;
392 fl->fl_file = filp;
393 fl->fl_flags = FL_POSIX;
394 fl->fl_ops = NULL;
395 fl->fl_lmops = NULL;
396
397 return assign_type(fl, l->l_type);
398}
399
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
401 * style lock.
402 */
403static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
404 struct flock *l)
405{
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500406 struct flock64 ll = {
407 .l_type = l->l_type,
408 .l_whence = l->l_whence,
409 .l_start = l->l_start,
410 .l_len = l->l_len,
411 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500413 return flock64_to_posix_lock(filp, fl, &ll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414}
415
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416/* default lease lock manager operations */
417static void lease_break_callback(struct file_lock *fl)
418{
419 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
420}
421
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700422static const struct lock_manager_operations lease_manager_ops = {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400423 .lm_break = lease_break_callback,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400424 .lm_change = lease_modify,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425};
426
427/*
428 * Initialize a lease, use the default lock manager operations
429 */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400430static int lease_init(struct file *filp, long type, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 {
Trond Myklebust75dff552006-05-07 23:02:42 -0400432 if (assign_type(fl, type) != 0)
433 return -EINVAL;
434
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +0200435 fl->fl_owner = current->files;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 fl->fl_pid = current->tgid;
437
438 fl->fl_file = filp;
439 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 fl->fl_start = 0;
441 fl->fl_end = OFFSET_MAX;
442 fl->fl_ops = NULL;
443 fl->fl_lmops = &lease_manager_ops;
444 return 0;
445}
446
447/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400448static struct file_lock *lease_alloc(struct file *filp, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449{
450 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400451 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452
453 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500454 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455
456 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400457 if (error) {
458 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500459 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400460 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500461 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462}
463
464/* Check if two locks overlap each other.
465 */
466static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
467{
468 return ((fl1->fl_end >= fl2->fl_start) &&
469 (fl2->fl_end >= fl1->fl_start));
470}
471
472/*
473 * Check whether two locks have the same owner.
474 */
Matt Mackall33443c42006-01-08 01:05:22 -0800475static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476{
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400477 if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 return fl2->fl_lmops == fl1->fl_lmops &&
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400479 fl1->fl_lmops->lm_compare_owner(fl1, fl2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 return fl1->fl_owner == fl2->fl_owner;
481}
482
Jeff Layton7012b022013-06-21 08:58:22 -0400483/* Must be called with the i_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500484static void locks_insert_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400485{
Jeff Layton7012b022013-06-21 08:58:22 -0400486 lg_local_lock(&file_lock_lglock);
487 fl->fl_link_cpu = smp_processor_id();
488 hlist_add_head(&fl->fl_link, this_cpu_ptr(&file_lock_list));
489 lg_local_unlock(&file_lock_lglock);
Jeff Layton88974692013-06-21 08:58:14 -0400490}
491
Jeff Layton7012b022013-06-21 08:58:22 -0400492/* Must be called with the i_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500493static void locks_delete_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400494{
Jeff Layton7012b022013-06-21 08:58:22 -0400495 /*
496 * Avoid taking lock if already unhashed. This is safe since this check
497 * is done while holding the i_lock, and new insertions into the list
498 * also require that it be held.
499 */
500 if (hlist_unhashed(&fl->fl_link))
501 return;
502 lg_local_lock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton139ca042013-06-21 08:58:17 -0400503 hlist_del_init(&fl->fl_link);
Jeff Layton7012b022013-06-21 08:58:22 -0400504 lg_local_unlock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton88974692013-06-21 08:58:14 -0400505}
506
Jeff Layton3999e492013-06-21 08:58:19 -0400507static unsigned long
508posix_owner_key(struct file_lock *fl)
509{
510 if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
511 return fl->fl_lmops->lm_owner_key(fl);
512 return (unsigned long)fl->fl_owner;
513}
514
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500515static void locks_insert_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400516{
Jeff Layton3999e492013-06-21 08:58:19 -0400517 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
Jeff Layton88974692013-06-21 08:58:14 -0400518}
519
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500520static void locks_delete_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400521{
Jeff Layton48f74182013-06-21 08:58:18 -0400522 hash_del(&waiter->fl_link);
Jeff Layton88974692013-06-21 08:58:14 -0400523}
524
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525/* Remove waiter from blocker's block list.
526 * When blocker ends up pointing to itself then the list is empty.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400527 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400528 * Must be called with blocked_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 */
Matt Mackall33443c42006-01-08 01:05:22 -0800530static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531{
Jeff Layton88974692013-06-21 08:58:14 -0400532 locks_delete_global_blocked(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 list_del_init(&waiter->fl_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 waiter->fl_next = NULL;
535}
536
Jeff Layton1a9e64a2013-06-21 08:58:10 -0400537static void locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400539 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 __locks_delete_block(waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400541 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542}
543
544/* Insert waiter into blocker's block list.
545 * We use a circular list so that processes can be easily woken up in
546 * the order they blocked. The documentation doesn't require this but
547 * it seems like the reasonable thing to do.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400548 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400549 * Must be called with both the i_lock and blocked_lock_lock held. The fl_block
Jeff Layton46dad762014-02-03 12:13:06 -0500550 * list itself is protected by the blocked_lock_lock, but by ensuring that the
Jeff Layton7b2296a2013-06-21 08:58:20 -0400551 * i_lock is also held on insertions we can avoid taking the blocked_lock_lock
Jeff Layton4e8c7652013-06-21 08:58:16 -0400552 * in some cases when we see that the fl_block list is empty.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400554static void __locks_insert_block(struct file_lock *blocker,
555 struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556{
J. Bruce Fields6dc0fe82006-03-26 01:37:24 -0800557 BUG_ON(!list_empty(&waiter->fl_block));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 waiter->fl_next = blocker;
Jeff Layton88974692013-06-21 08:58:14 -0400559 list_add_tail(&waiter->fl_block, &blocker->fl_block);
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400560 if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400561 locks_insert_global_blocked(waiter);
562}
563
564/* Must be called with i_lock held. */
565static void locks_insert_block(struct file_lock *blocker,
566 struct file_lock *waiter)
567{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400568 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400569 __locks_insert_block(blocker, waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400570 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571}
572
Jeff Layton1cb36012013-06-21 08:58:12 -0400573/*
574 * Wake up processes blocked waiting for blocker.
575 *
Jeff Layton1c8c6012013-06-21 08:58:15 -0400576 * Must be called with the inode->i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 */
578static void locks_wake_up_blocks(struct file_lock *blocker)
579{
Jeff Layton4e8c7652013-06-21 08:58:16 -0400580 /*
581 * Avoid taking global lock if list is empty. This is safe since new
582 * blocked requests are only added to the list under the i_lock, and
583 * the i_lock is always held here. Note that removal from the fl_block
584 * list does not require the i_lock, so we must recheck list_empty()
Jeff Layton7b2296a2013-06-21 08:58:20 -0400585 * after acquiring the blocked_lock_lock.
Jeff Layton4e8c7652013-06-21 08:58:16 -0400586 */
587 if (list_empty(&blocker->fl_block))
588 return;
589
Jeff Layton7b2296a2013-06-21 08:58:20 -0400590 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 while (!list_empty(&blocker->fl_block)) {
Pavel Emelyanovf0c1cd02007-09-19 16:44:07 +0400592 struct file_lock *waiter;
593
594 waiter = list_first_entry(&blocker->fl_block,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 struct file_lock, fl_block);
596 __locks_delete_block(waiter);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400597 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
598 waiter->fl_lmops->lm_notify(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 else
600 wake_up(&waiter->fl_wait);
601 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400602 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603}
604
605/* Insert file lock fl into an inode's lock list at the position indicated
606 * by pos. At the same time add the lock to the global file lock list.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400607 *
608 * Must be called with the i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 */
610static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
611{
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000612 fl->fl_nspid = get_pid(task_tgid(current));
613
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 /* insert into file's list */
615 fl->fl_next = *pos;
616 *pos = fl;
Jeff Layton88974692013-06-21 08:58:14 -0400617
618 locks_insert_global_locks(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619}
620
Jeff Layton24cbe782014-02-03 12:13:06 -0500621/**
622 * locks_delete_lock - Delete a lock and then free it.
623 * @thisfl_p: pointer that points to the fl_next field of the previous
624 * inode->i_flock list entry
625 *
626 * Unlink a lock from all lists and free the namespace reference, but don't
627 * free it yet. Wake up processes that are blocked waiting for this lock and
628 * notify the FS that the lock has been cleared.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400629 *
630 * Must be called with the i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 */
Jeff Layton24cbe782014-02-03 12:13:06 -0500632static void locks_unlink_lock(struct file_lock **thisfl_p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633{
634 struct file_lock *fl = *thisfl_p;
635
Jeff Layton88974692013-06-21 08:58:14 -0400636 locks_delete_global_locks(fl);
637
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 *thisfl_p = fl->fl_next;
639 fl->fl_next = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000641 if (fl->fl_nspid) {
642 put_pid(fl->fl_nspid);
643 fl->fl_nspid = NULL;
644 }
645
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 locks_wake_up_blocks(fl);
Jeff Layton24cbe782014-02-03 12:13:06 -0500647}
648
649/*
650 * Unlink a lock from all lists and free it.
651 *
652 * Must be called with i_lock held!
653 */
654static void locks_delete_lock(struct file_lock **thisfl_p)
655{
656 struct file_lock *fl = *thisfl_p;
657
658 locks_unlink_lock(thisfl_p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 locks_free_lock(fl);
660}
661
662/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
663 * checks for shared/exclusive status of overlapping locks.
664 */
665static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
666{
667 if (sys_fl->fl_type == F_WRLCK)
668 return 1;
669 if (caller_fl->fl_type == F_WRLCK)
670 return 1;
671 return 0;
672}
673
674/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
675 * checking before calling the locks_conflict().
676 */
677static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
678{
679 /* POSIX locks owned by the same process do not conflict with
680 * each other.
681 */
682 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
683 return (0);
684
685 /* Check whether they overlap */
686 if (!locks_overlap(caller_fl, sys_fl))
687 return 0;
688
689 return (locks_conflict(caller_fl, sys_fl));
690}
691
692/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
693 * checking before calling the locks_conflict().
694 */
695static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
696{
697 /* FLOCK locks referring to the same filp do not conflict with
698 * each other.
699 */
700 if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
701 return (0);
702 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
703 return 0;
704
705 return (locks_conflict(caller_fl, sys_fl));
706}
707
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400708void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500709posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710{
711 struct file_lock *cfl;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400712 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
Jeff Layton1c8c6012013-06-21 08:58:15 -0400714 spin_lock(&inode->i_lock);
Al Viro496ad9a2013-01-23 17:07:38 -0500715 for (cfl = file_inode(filp)->i_flock; cfl; cfl = cfl->fl_next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 if (!IS_POSIX(cfl))
717 continue;
J. Bruce Fieldsb842e242007-05-10 19:02:07 -0400718 if (posix_locks_conflict(fl, cfl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 break;
720 }
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000721 if (cfl) {
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500722 __locks_copy_lock(fl, cfl);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000723 if (cfl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -0800724 fl->fl_pid = pid_vnr(cfl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000725 } else
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400726 fl->fl_type = F_UNLCK;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400727 spin_unlock(&inode->i_lock);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400728 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730EXPORT_SYMBOL(posix_test_lock);
731
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400732/*
733 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400735 * We attempt to detect deadlocks that are due purely to posix file
736 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400738 * We assume that a task can be waiting for at most one lock at a time.
739 * So for any acquired lock, the process holding that lock may be
740 * waiting on at most one other lock. That lock in turns may be held by
741 * someone waiting for at most one other lock. Given a requested lock
742 * caller_fl which is about to wait for a conflicting lock block_fl, we
743 * follow this chain of waiters to ensure we are not about to create a
744 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400745 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400746 * Since we do this before we ever put a process to sleep on a lock, we
747 * are ensured that there is never a cycle; that is what guarantees that
748 * the while() loop in posix_locks_deadlock() eventually completes.
749 *
750 * Note: the above assumption may not be true when handling lock
751 * requests from a broken NFS client. It may also fail in the presence
752 * of tasks (such as posix threads) sharing the same open file table.
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400753 * To handle those cases, we just bail out after a few iterations.
Jeff Layton57b65322014-02-03 12:13:09 -0500754 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400755 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
Jeff Layton57b65322014-02-03 12:13:09 -0500756 * Because the owner is not even nominally tied to a thread of
757 * execution, the deadlock detection below can't reasonably work well. Just
758 * skip it for those.
759 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400760 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
Jeff Layton57b65322014-02-03 12:13:09 -0500761 * locks that just checks for the case where two tasks are attempting to
762 * upgrade from read to write locks on the same inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400764
765#define MAX_DEADLK_ITERATIONS 10
766
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400767/* Find a lock that the owner of the given block_fl is blocking on. */
768static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
769{
770 struct file_lock *fl;
771
Jeff Layton3999e492013-06-21 08:58:19 -0400772 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400773 if (posix_same_owner(fl, block_fl))
774 return fl->fl_next;
775 }
776 return NULL;
777}
778
Jeff Layton7b2296a2013-06-21 08:58:20 -0400779/* Must be called with the blocked_lock_lock held! */
Adrian Bunkb0904e12006-06-23 02:05:13 -0700780static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 struct file_lock *block_fl)
782{
J. Bruce Fields97855b42007-10-30 11:20:02 -0400783 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
Jeff Layton57b65322014-02-03 12:13:09 -0500785 /*
786 * This deadlock detector can't reasonably detect deadlocks with
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400787 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
Jeff Layton57b65322014-02-03 12:13:09 -0500788 */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400789 if (IS_OFDLCK(caller_fl))
Jeff Layton57b65322014-02-03 12:13:09 -0500790 return 0;
791
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400792 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
793 if (i++ > MAX_DEADLK_ITERATIONS)
794 return 0;
795 if (posix_same_owner(caller_fl, block_fl))
796 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 }
798 return 0;
799}
800
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -0400802 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -0400803 *
804 * Note that if called with an FL_EXISTS argument, the caller may determine
805 * whether or not a lock was successfully freed by testing the return
806 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 */
Trond Myklebust993dfa82006-03-31 02:30:55 -0800808static int flock_lock_file(struct file *filp, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809{
Trond Myklebust993dfa82006-03-31 02:30:55 -0800810 struct file_lock *new_fl = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 struct file_lock **before;
Al Viro496ad9a2013-01-23 17:07:38 -0500812 struct inode * inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 int error = 0;
814 int found = 0;
815
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200816 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
817 new_fl = locks_alloc_lock();
818 if (!new_fl)
819 return -ENOMEM;
820 }
821
Jeff Layton1c8c6012013-06-21 08:58:15 -0400822 spin_lock(&inode->i_lock);
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400823 if (request->fl_flags & FL_ACCESS)
824 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +0400825
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 for_each_lock(inode, before) {
827 struct file_lock *fl = *before;
828 if (IS_POSIX(fl))
829 break;
830 if (IS_LEASE(fl))
831 continue;
832 if (filp != fl->fl_file)
833 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800834 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 goto out;
836 found = 1;
837 locks_delete_lock(before);
838 break;
839 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840
Trond Myklebustf475ae92006-06-29 16:38:32 -0400841 if (request->fl_type == F_UNLCK) {
842 if ((request->fl_flags & FL_EXISTS) && !found)
843 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800844 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400845 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846
847 /*
848 * If a higher-priority process was blocked on the old file lock,
849 * give it the opportunity to lock the file.
850 */
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200851 if (found) {
Jeff Layton1c8c6012013-06-21 08:58:15 -0400852 spin_unlock(&inode->i_lock);
Frederic Weisbeckerdef01bc2009-07-16 15:44:29 +0200853 cond_resched();
Jeff Layton1c8c6012013-06-21 08:58:15 -0400854 spin_lock(&inode->i_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200855 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400857find_conflict:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 for_each_lock(inode, before) {
859 struct file_lock *fl = *before;
860 if (IS_POSIX(fl))
861 break;
862 if (IS_LEASE(fl))
863 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800864 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 continue;
866 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700867 if (!(request->fl_flags & FL_SLEEP))
868 goto out;
869 error = FILE_LOCK_DEFERRED;
870 locks_insert_block(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 goto out;
872 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400873 if (request->fl_flags & FL_ACCESS)
874 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800875 locks_copy_lock(new_fl, request);
Pavel Emelyanov0e2f6db2007-09-11 15:24:01 -0700876 locks_insert_lock(before, new_fl);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800877 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +0400878 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879
880out:
Jeff Layton1c8c6012013-06-21 08:58:15 -0400881 spin_unlock(&inode->i_lock);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800882 if (new_fl)
883 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 return error;
885}
886
Marc Eshel150b3932007-01-18 16:15:35 -0500887static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888{
889 struct file_lock *fl;
Miklos Szeredi39005d02006-06-23 02:05:10 -0700890 struct file_lock *new_fl = NULL;
891 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 struct file_lock *left = NULL;
893 struct file_lock *right = NULL;
894 struct file_lock **before;
Jeff Laytonb9746ef2013-06-21 08:58:13 -0400895 int error;
896 bool added = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897
898 /*
899 * We may need two file_lock structures for this operation,
900 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -0700901 *
902 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 */
Miklos Szeredi39005d02006-06-23 02:05:10 -0700904 if (!(request->fl_flags & FL_ACCESS) &&
905 (request->fl_type != F_UNLCK ||
906 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
907 new_fl = locks_alloc_lock();
908 new_fl2 = locks_alloc_lock();
909 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910
Jeff Layton1c8c6012013-06-21 08:58:15 -0400911 spin_lock(&inode->i_lock);
Jeff Layton1cb36012013-06-21 08:58:12 -0400912 /*
913 * New lock request. Walk all POSIX locks and look for conflicts. If
914 * there are any, either return error or put the request on the
Jeff Layton48f74182013-06-21 08:58:18 -0400915 * blocker's list of waiters and the global blocked_hash.
Jeff Layton1cb36012013-06-21 08:58:12 -0400916 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 if (request->fl_type != F_UNLCK) {
918 for_each_lock(inode, before) {
J. Bruce Fields526985b2006-11-14 16:54:36 -0500919 fl = *before;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 if (!IS_POSIX(fl))
921 continue;
922 if (!posix_locks_conflict(request, fl))
923 continue;
Andy Adamson5842add2006-03-26 01:37:26 -0800924 if (conflock)
J. Bruce Fields1a747ee2008-04-24 10:08:22 -0400925 __locks_copy_lock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 error = -EAGAIN;
927 if (!(request->fl_flags & FL_SLEEP))
928 goto out;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400929 /*
930 * Deadlock detection and insertion into the blocked
931 * locks list must be done while holding the same lock!
932 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 error = -EDEADLK;
Jeff Layton7b2296a2013-06-21 08:58:20 -0400934 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400935 if (likely(!posix_locks_deadlock(request, fl))) {
936 error = FILE_LOCK_DEFERRED;
937 __locks_insert_block(fl, request);
938 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400939 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 goto out;
941 }
942 }
943
944 /* If we're just looking for a conflict, we're done. */
945 error = 0;
946 if (request->fl_flags & FL_ACCESS)
947 goto out;
948
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 * Find the first old lock with the same owner as the new lock.
951 */
952
953 before = &inode->i_flock;
954
955 /* First skip locks owned by other processes. */
956 while ((fl = *before) && (!IS_POSIX(fl) ||
957 !posix_same_owner(request, fl))) {
958 before = &fl->fl_next;
959 }
960
Jeff Layton1cb36012013-06-21 08:58:12 -0400961 /* Process locks with this owner. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 while ((fl = *before) && posix_same_owner(request, fl)) {
963 /* Detect adjacent or overlapping regions (if same lock type)
964 */
965 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -0700966 /* In all comparisons of start vs end, use
967 * "start - 1" rather than "end + 1". If end
968 * is OFFSET_MAX, end + 1 will become negative.
969 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 if (fl->fl_end < request->fl_start - 1)
971 goto next_lock;
972 /* If the next lock in the list has entirely bigger
973 * addresses than the new one, insert the lock here.
974 */
Olaf Kirch449231d2005-08-25 16:25:35 -0700975 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 break;
977
978 /* If we come here, the new and old lock are of the
979 * same type and adjacent or overlapping. Make one
980 * lock yielding from the lower start address of both
981 * locks to the higher end address.
982 */
983 if (fl->fl_start > request->fl_start)
984 fl->fl_start = request->fl_start;
985 else
986 request->fl_start = fl->fl_start;
987 if (fl->fl_end < request->fl_end)
988 fl->fl_end = request->fl_end;
989 else
990 request->fl_end = fl->fl_end;
991 if (added) {
992 locks_delete_lock(before);
993 continue;
994 }
995 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -0400996 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 }
998 else {
999 /* Processing for different lock types is a bit
1000 * more complex.
1001 */
1002 if (fl->fl_end < request->fl_start)
1003 goto next_lock;
1004 if (fl->fl_start > request->fl_end)
1005 break;
1006 if (request->fl_type == F_UNLCK)
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001007 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 if (fl->fl_start < request->fl_start)
1009 left = fl;
1010 /* If the next lock in the list has a higher end
1011 * address than the new one, insert the new one here.
1012 */
1013 if (fl->fl_end > request->fl_end) {
1014 right = fl;
1015 break;
1016 }
1017 if (fl->fl_start >= request->fl_start) {
1018 /* The new lock completely replaces an old
1019 * one (This may happen several times).
1020 */
1021 if (added) {
1022 locks_delete_lock(before);
1023 continue;
1024 }
1025 /* Replace the old lock with the new one.
1026 * Wake up anybody waiting for the old one,
1027 * as the change in lock type might satisfy
1028 * their needs.
1029 */
1030 locks_wake_up_blocks(fl);
1031 fl->fl_start = request->fl_start;
1032 fl->fl_end = request->fl_end;
1033 fl->fl_type = request->fl_type;
Trond Myklebust47831f32006-03-20 13:44:05 -05001034 locks_release_private(fl);
1035 locks_copy_private(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001037 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 }
1039 }
1040 /* Go on to next lock.
1041 */
1042 next_lock:
1043 before = &fl->fl_next;
1044 }
1045
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001046 /*
Jeff Layton1cb36012013-06-21 08:58:12 -04001047 * The above code only modifies existing locks in case of merging or
1048 * replacing. If new lock(s) need to be inserted all modifications are
1049 * done below this, so it's safe yet to bail out.
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001050 */
1051 error = -ENOLCK; /* "no luck" */
1052 if (right && left == right && !new_fl2)
1053 goto out;
1054
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 error = 0;
1056 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -04001057 if (request->fl_type == F_UNLCK) {
1058 if (request->fl_flags & FL_EXISTS)
1059 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001061 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001062
1063 if (!new_fl) {
1064 error = -ENOLCK;
1065 goto out;
1066 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 locks_copy_lock(new_fl, request);
1068 locks_insert_lock(before, new_fl);
1069 new_fl = NULL;
1070 }
1071 if (right) {
1072 if (left == right) {
1073 /* The new lock breaks the old one in two pieces,
1074 * so we have to use the second new lock.
1075 */
1076 left = new_fl2;
1077 new_fl2 = NULL;
1078 locks_copy_lock(left, right);
1079 locks_insert_lock(before, left);
1080 }
1081 right->fl_start = request->fl_end + 1;
1082 locks_wake_up_blocks(right);
1083 }
1084 if (left) {
1085 left->fl_end = request->fl_start - 1;
1086 locks_wake_up_blocks(left);
1087 }
1088 out:
Jeff Layton1c8c6012013-06-21 08:58:15 -04001089 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 /*
1091 * Free any unused locks.
1092 */
1093 if (new_fl)
1094 locks_free_lock(new_fl);
1095 if (new_fl2)
1096 locks_free_lock(new_fl2);
1097 return error;
1098}
1099
1100/**
1101 * posix_lock_file - Apply a POSIX-style lock to a file
1102 * @filp: The file to apply the lock to
1103 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001104 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105 *
1106 * Add a POSIX style lock to a file.
1107 * We merge adjacent & overlapping locks whenever possible.
1108 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001109 *
1110 * Note that if called with an FL_EXISTS argument, the caller may determine
1111 * whether or not a lock was successfully freed by testing the return
1112 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 */
Marc Eshel150b3932007-01-18 16:15:35 -05001114int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001115 struct file_lock *conflock)
1116{
Al Viro496ad9a2013-01-23 17:07:38 -05001117 return __posix_lock_file(file_inode(filp), fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001118}
Marc Eshel150b3932007-01-18 16:15:35 -05001119EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120
1121/**
1122 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1123 * @filp: The file to apply the lock to
1124 * @fl: The lock to be applied
1125 *
1126 * Add a POSIX style lock to a file.
1127 * We merge adjacent & overlapping locks whenever possible.
1128 * POSIX locks are sorted by owner task, then by starting address
1129 */
1130int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1131{
1132 int error;
1133 might_sleep ();
1134 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001135 error = posix_lock_file(filp, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001136 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137 break;
1138 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1139 if (!error)
1140 continue;
1141
1142 locks_delete_block(fl);
1143 break;
1144 }
1145 return error;
1146}
1147EXPORT_SYMBOL(posix_lock_file_wait);
1148
1149/**
1150 * locks_mandatory_locked - Check for an active lock
Jeff Laytond7a06982014-03-10 09:54:15 -04001151 * @file: the file to check
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 *
1153 * Searches the inode's list of locks to find any POSIX locks which conflict.
1154 * This function is called from locks_verify_locked() only.
1155 */
Jeff Laytond7a06982014-03-10 09:54:15 -04001156int locks_mandatory_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157{
Jeff Laytond7a06982014-03-10 09:54:15 -04001158 struct inode *inode = file_inode(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 struct file_lock *fl;
1160
1161 /*
1162 * Search the lock list for this inode for any POSIX locks.
1163 */
Jeff Layton1c8c6012013-06-21 08:58:15 -04001164 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1166 if (!IS_POSIX(fl))
1167 continue;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001168 if (fl->fl_owner != current->files &&
1169 fl->fl_owner != file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170 break;
1171 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04001172 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 return fl ? -EAGAIN : 0;
1174}
1175
1176/**
1177 * locks_mandatory_area - Check for a conflicting lock
1178 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1179 * for shared
1180 * @inode: the file to check
1181 * @filp: how the file was opened (if it was)
1182 * @offset: start of area to check
1183 * @count: length of area to check
1184 *
1185 * Searches the inode's list of locks to find any POSIX locks which conflict.
1186 * This function is called from rw_verify_area() and
1187 * locks_verify_truncate().
1188 */
1189int locks_mandatory_area(int read_write, struct inode *inode,
1190 struct file *filp, loff_t offset,
1191 size_t count)
1192{
1193 struct file_lock fl;
1194 int error;
Jeff Layton29723ad2014-03-10 09:54:19 -04001195 bool sleep = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196
1197 locks_init_lock(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 fl.fl_pid = current->tgid;
1199 fl.fl_file = filp;
1200 fl.fl_flags = FL_POSIX | FL_ACCESS;
1201 if (filp && !(filp->f_flags & O_NONBLOCK))
Jeff Layton29723ad2014-03-10 09:54:19 -04001202 sleep = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1204 fl.fl_start = offset;
1205 fl.fl_end = offset + count - 1;
1206
1207 for (;;) {
Jeff Layton29723ad2014-03-10 09:54:19 -04001208 if (filp) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001209 fl.fl_owner = filp;
Jeff Layton29723ad2014-03-10 09:54:19 -04001210 fl.fl_flags &= ~FL_SLEEP;
1211 error = __posix_lock_file(inode, &fl, NULL);
1212 if (!error)
1213 break;
1214 }
1215
1216 if (sleep)
1217 fl.fl_flags |= FL_SLEEP;
1218 fl.fl_owner = current->files;
Marc Eshel150b3932007-01-18 16:15:35 -05001219 error = __posix_lock_file(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001220 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 break;
1222 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1223 if (!error) {
1224 /*
1225 * If we've been sleeping someone might have
1226 * changed the permissions behind our back.
1227 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001228 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 continue;
1230 }
1231
1232 locks_delete_block(&fl);
1233 break;
1234 }
1235
1236 return error;
1237}
1238
1239EXPORT_SYMBOL(locks_mandatory_area);
1240
J. Bruce Fields778fc542011-07-26 18:25:49 -04001241static void lease_clear_pending(struct file_lock *fl, int arg)
1242{
1243 switch (arg) {
1244 case F_UNLCK:
1245 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1246 /* fall through: */
1247 case F_RDLCK:
1248 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1249 }
1250}
1251
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252/* We already had a lease on this file; just change its type */
1253int lease_modify(struct file_lock **before, int arg)
1254{
1255 struct file_lock *fl = *before;
1256 int error = assign_type(fl, arg);
1257
1258 if (error)
1259 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001260 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001262 if (arg == F_UNLCK) {
1263 struct file *filp = fl->fl_file;
1264
1265 f_delown(filp);
1266 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001267 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1268 if (fl->fl_fasync != NULL) {
1269 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1270 fl->fl_fasync = NULL;
1271 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 locks_delete_lock(before);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001273 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 return 0;
1275}
1276
1277EXPORT_SYMBOL(lease_modify);
1278
J. Bruce Fields778fc542011-07-26 18:25:49 -04001279static bool past_time(unsigned long then)
1280{
1281 if (!then)
1282 /* 0 is a special value meaning "this never expires": */
1283 return false;
1284 return time_after(jiffies, then);
1285}
1286
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287static void time_out_leases(struct inode *inode)
1288{
1289 struct file_lock **before;
1290 struct file_lock *fl;
1291
1292 before = &inode->i_flock;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04001293 while ((fl = *before) && IS_LEASE(fl) && lease_breaking(fl)) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001294 trace_time_out_leases(inode, fl);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001295 if (past_time(fl->fl_downgrade_time))
1296 lease_modify(before, F_RDLCK);
1297 if (past_time(fl->fl_break_time))
1298 lease_modify(before, F_UNLCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 if (fl == *before) /* lease_modify may have freed fl */
1300 before = &fl->fl_next;
1301 }
1302}
1303
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001304static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1305{
1306 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1307 return false;
1308 return locks_conflict(breaker, lease);
1309}
1310
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311/**
1312 * __break_lease - revoke all outstanding leases on file
1313 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001314 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1315 * break all leases
1316 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1317 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 *
david m. richter87250dd2007-05-09 16:10:27 -04001319 * break_lease (inlined for speed) has checked there already is at least
1320 * some kind of lock (maybe a lease) on this file. Leases are broken on
1321 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 * specified %O_NONBLOCK to your open().
1323 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001324int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001326 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 struct file_lock *new_fl, *flock;
1328 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 unsigned long break_time;
1330 int i_have_this_lease = 0;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001331 bool lease_conflict = false;
Al Viro8737c932009-12-24 06:47:55 -05001332 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333
Al Viro8737c932009-12-24 06:47:55 -05001334 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001335 if (IS_ERR(new_fl))
1336 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001337 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338
Jeff Layton1c8c6012013-06-21 08:58:15 -04001339 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340
1341 time_out_leases(inode);
1342
1343 flock = inode->i_flock;
1344 if ((flock == NULL) || !IS_LEASE(flock))
1345 goto out;
1346
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001347 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1348 if (leases_conflict(fl, new_fl)) {
1349 lease_conflict = true;
1350 if (fl->fl_owner == current->files)
1351 i_have_this_lease = 1;
1352 }
1353 }
1354 if (!lease_conflict)
J. Bruce Fields778fc542011-07-26 18:25:49 -04001355 goto out;
1356
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 break_time = 0;
1358 if (lease_break_time > 0) {
1359 break_time = jiffies + lease_break_time * HZ;
1360 if (break_time == 0)
1361 break_time++; /* so that 0 means no break time */
1362 }
1363
1364 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001365 if (!leases_conflict(fl, new_fl))
1366 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001367 if (want_write) {
1368 if (fl->fl_flags & FL_UNLOCK_PENDING)
1369 continue;
1370 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001372 } else {
1373 if (lease_breaking(flock))
1374 continue;
1375 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1376 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 }
J. Bruce Fields778fc542011-07-26 18:25:49 -04001378 fl->fl_lmops->lm_break(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 }
1380
1381 if (i_have_this_lease || (mode & O_NONBLOCK)) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001382 trace_break_lease_noblock(inode, new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 error = -EWOULDBLOCK;
1384 goto out;
1385 }
1386
1387restart:
1388 break_time = flock->fl_break_time;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001389 if (break_time != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 break_time -= jiffies;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001391 if (break_time == 0)
1392 break_time++;
Matthew Wilcox4321e012008-01-14 21:28:30 -07001393 locks_insert_block(flock, new_fl);
Jeff Layton62af4f12014-05-09 14:13:05 -04001394 trace_break_lease_block(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001395 spin_unlock(&inode->i_lock);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001396 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1397 !new_fl->fl_next, break_time);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001398 spin_lock(&inode->i_lock);
Jeff Layton62af4f12014-05-09 14:13:05 -04001399 trace_break_lease_unblock(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001400 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 if (error >= 0) {
1402 if (error == 0)
1403 time_out_leases(inode);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001404 /*
1405 * Wait for the next conflicting lease that has not been
1406 * broken yet
1407 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1409 flock = flock->fl_next) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001410 if (leases_conflict(new_fl, flock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411 goto restart;
1412 }
1413 error = 0;
1414 }
1415
1416out:
Jeff Layton1c8c6012013-06-21 08:58:15 -04001417 spin_unlock(&inode->i_lock);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001418 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 return error;
1420}
1421
1422EXPORT_SYMBOL(__break_lease);
1423
1424/**
Randy Dunlapa6b91912008-03-19 17:01:00 -07001425 * lease_get_mtime - get the last modified time of an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 * @inode: the inode
1427 * @time: pointer to a timespec which will contain the last modified time
1428 *
1429 * This is to force NFS clients to flush their caches for files with
1430 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001431 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 */
1433void lease_get_mtime(struct inode *inode, struct timespec *time)
1434{
1435 struct file_lock *flock = inode->i_flock;
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04001436 if (flock && IS_LEASE(flock) && (flock->fl_type == F_WRLCK))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 *time = current_fs_time(inode->i_sb);
1438 else
1439 *time = inode->i_mtime;
1440}
1441
1442EXPORT_SYMBOL(lease_get_mtime);
1443
1444/**
1445 * fcntl_getlease - Enquire what lease is currently active
1446 * @filp: the file
1447 *
1448 * The value returned by this function will be one of
1449 * (if no lease break is pending):
1450 *
1451 * %F_RDLCK to indicate a shared lease is held.
1452 *
1453 * %F_WRLCK to indicate an exclusive lease is held.
1454 *
1455 * %F_UNLCK to indicate no lease is held.
1456 *
1457 * (if a lease break is pending):
1458 *
1459 * %F_RDLCK to indicate an exclusive lease needs to be
1460 * changed to a shared lease (or removed).
1461 *
1462 * %F_UNLCK to indicate the lease needs to be removed.
1463 *
1464 * XXX: sfr & willy disagree over whether F_INPROGRESS
1465 * should be returned to userspace.
1466 */
1467int fcntl_getlease(struct file *filp)
1468{
1469 struct file_lock *fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001470 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 int type = F_UNLCK;
1472
Jeff Layton1c8c6012013-06-21 08:58:15 -04001473 spin_lock(&inode->i_lock);
Al Viro496ad9a2013-01-23 17:07:38 -05001474 time_out_leases(file_inode(filp));
1475 for (fl = file_inode(filp)->i_flock; fl && IS_LEASE(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 fl = fl->fl_next) {
1477 if (fl->fl_file == filp) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001478 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479 break;
1480 }
1481 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04001482 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 return type;
1484}
1485
Jeff Layton24cbe782014-02-03 12:13:06 -05001486/**
1487 * check_conflicting_open - see if the given dentry points to a file that has
1488 * an existing open that would conflict with the
1489 * desired lease.
1490 * @dentry: dentry to check
1491 * @arg: type of lease that we're trying to acquire
1492 *
1493 * Check to see if there's an existing open fd on this file that would
1494 * conflict with the lease we're trying to set.
1495 */
1496static int
1497check_conflicting_open(const struct dentry *dentry, const long arg)
1498{
1499 int ret = 0;
1500 struct inode *inode = dentry->d_inode;
1501
1502 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1503 return -EAGAIN;
1504
1505 if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1506 (atomic_read(&inode->i_count) > 1)))
1507 ret = -EAGAIN;
1508
1509 return ret;
1510}
1511
Jeff Laytond4f22d12013-06-21 08:58:11 -04001512static int generic_add_lease(struct file *filp, long arg, struct file_lock **flp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513{
KAMBAROV, ZAUR7eaae282005-07-07 17:57:06 -07001514 struct file_lock *fl, **before, **my_before = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001515 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 struct inode *inode = dentry->d_inode;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001517 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001518 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519
J. Bruce Fields096657b2010-10-30 17:31:14 -04001520 lease = *flp;
Jeff Layton62af4f12014-05-09 14:13:05 -04001521 trace_generic_add_lease(inode, lease);
1522
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001523 /*
1524 * In the delegation case we need mutual exclusion with
1525 * a number of operations that take the i_mutex. We trylock
1526 * because delegations are an optional optimization, and if
1527 * there's some chance of a conflict--we'd rather not
1528 * bother, maybe that's a sign this just isn't a good file to
1529 * hand out a delegation on.
1530 */
1531 if (is_deleg && !mutex_trylock(&inode->i_mutex))
1532 return -EAGAIN;
1533
1534 if (is_deleg && arg == F_WRLCK) {
1535 /* Write delegations are not currently supported: */
Dan Carpenter4fdb7932013-11-13 10:56:27 +03001536 mutex_unlock(&inode->i_mutex);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001537 WARN_ON_ONCE(1);
1538 return -EINVAL;
1539 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001540
Jeff Layton24cbe782014-02-03 12:13:06 -05001541 error = check_conflicting_open(dentry, arg);
1542 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001543 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001544
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 /*
1546 * At this point, we know that if there is an exclusive
1547 * lease on this file, then we hold it on this filp
1548 * (otherwise our open of this file would have blocked).
1549 * And if we are trying to acquire an exclusive lease,
1550 * then the file is not open by anyone (including us)
1551 * except for this filp.
1552 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001553 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 for (before = &inode->i_flock;
1555 ((fl = *before) != NULL) && IS_LEASE(fl);
1556 before = &fl->fl_next) {
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001557 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 my_before = before;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001559 continue;
1560 }
1561 /*
1562 * No exclusive leases if someone else has a lease on
1563 * this file:
1564 */
1565 if (arg == F_WRLCK)
1566 goto out;
1567 /*
1568 * Modifying our existing lease is OK, but no getting a
1569 * new lease if someone else is opening for write:
1570 */
1571 if (fl->fl_flags & FL_UNLOCK_PENDING)
1572 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 }
1574
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 if (my_before != NULL) {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001576 error = lease->fl_lmops->lm_change(my_before, arg);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001577 if (!error)
1578 *flp = *my_before;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 goto out;
1580 }
1581
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 error = -EINVAL;
1583 if (!leases_enable)
1584 goto out;
1585
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001586 locks_insert_lock(before, lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001587 /*
1588 * The check in break_lease() is lockless. It's possible for another
1589 * open to race in after we did the earlier check for a conflicting
1590 * open but before the lease was inserted. Check again for a
1591 * conflicting open and cancel the lease if there is one.
1592 *
1593 * We also add a barrier here to ensure that the insertion of the lock
1594 * precedes these checks.
1595 */
1596 smp_mb();
1597 error = check_conflicting_open(dentry, arg);
1598 if (error)
1599 locks_unlink_lock(flp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600out:
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001601 if (is_deleg)
1602 mutex_unlock(&inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 return error;
1604}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001605
Jeff Laytond4f22d12013-06-21 08:58:11 -04001606static int generic_delete_lease(struct file *filp, struct file_lock **flp)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001607{
1608 struct file_lock *fl, **before;
1609 struct dentry *dentry = filp->f_path.dentry;
1610 struct inode *inode = dentry->d_inode;
1611
Jeff Layton62af4f12014-05-09 14:13:05 -04001612 trace_generic_delete_lease(inode, *flp);
1613
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001614 for (before = &inode->i_flock;
1615 ((fl = *before) != NULL) && IS_LEASE(fl);
1616 before = &fl->fl_next) {
1617 if (fl->fl_file != filp)
1618 continue;
1619 return (*flp)->fl_lmops->lm_change(before, F_UNLCK);
1620 }
1621 return -EAGAIN;
1622}
1623
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624/**
1625 * generic_setlease - sets a lease on an open file
1626 * @filp: file pointer
1627 * @arg: type of lease to obtain
1628 * @flp: input - file_lock to use, output - file_lock inserted
1629 *
1630 * The (input) flp->fl_lmops->lm_break function is required
1631 * by break_lease().
1632 *
Jeff Layton1c8c6012013-06-21 08:58:15 -04001633 * Called with inode->i_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 */
1635int generic_setlease(struct file *filp, long arg, struct file_lock **flp)
1636{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 struct dentry *dentry = filp->f_path.dentry;
1638 struct inode *inode = dentry->d_inode;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001639 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001641 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001642 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001644 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 error = security_file_lock(filp, arg);
1646 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001647 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648
1649 time_out_leases(inode);
1650
1651 BUG_ON(!(*flp)->fl_lmops->lm_break);
1652
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001653 switch (arg) {
1654 case F_UNLCK:
1655 return generic_delete_lease(filp, flp);
1656 case F_RDLCK:
1657 case F_WRLCK:
1658 return generic_add_lease(filp, arg, flp);
1659 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001660 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001663EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001665static int __vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
1666{
Al Viro72c2d532013-09-22 16:27:52 -04001667 if (filp->f_op->setlease)
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001668 return filp->f_op->setlease(filp, arg, lease);
1669 else
1670 return generic_setlease(filp, arg, lease);
1671}
1672
1673/**
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001674 * vfs_setlease - sets a lease on an open file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 * @filp: file pointer
1676 * @arg: type of lease to obtain
1677 * @lease: file_lock to use
1678 *
1679 * Call this to establish a lease on the file.
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001680 * The (*lease)->fl_lmops->lm_break operation must be set; if not,
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001681 * break_lease will oops!
1682 *
1683 * This will call the filesystem's setlease file method, if
1684 * defined. Note that there is no getlease method; instead, the
1685 * filesystem setlease method should call back to setlease() to
1686 * add a lease to the inode's lease list, where fcntl_getlease() can
1687 * find it. Since fcntl_getlease() only reports whether the current
1688 * task holds a lease, a cluster filesystem need only do this for
1689 * leases held by processes on this node.
1690 *
1691 * There is also no break_lease method; filesystems that
Adam Buchbinderc9404c92009-12-18 15:40:42 -05001692 * handle their own leases should break leases themselves from the
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001693 * filesystem's open, create, and (on truncate) setattr methods.
1694 *
1695 * Warning: the only current setlease methods exist only to disable
1696 * leases in certain cases. More vfs changes may be required to
1697 * allow a full filesystem lease implementation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 */
1699
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001700int vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701{
Jeff Layton1c8c6012013-06-21 08:58:15 -04001702 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 int error;
1704
Jeff Layton1c8c6012013-06-21 08:58:15 -04001705 spin_lock(&inode->i_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001706 error = __vfs_setlease(filp, arg, lease);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001707 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708
1709 return error;
1710}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001711EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001713static int do_fcntl_delete_lease(struct file *filp)
1714{
1715 struct file_lock fl, *flp = &fl;
1716
1717 lease_init(filp, F_UNLCK, flp);
1718
1719 return vfs_setlease(filp, F_UNLCK, &flp);
1720}
1721
1722static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723{
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001724 struct file_lock *fl, *ret;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001725 struct inode *inode = file_inode(filp);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001726 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727 int error;
1728
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001729 fl = lease_alloc(filp, arg);
1730 if (IS_ERR(fl))
1731 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001733 new = fasync_alloc();
1734 if (!new) {
1735 locks_free_lock(fl);
1736 return -ENOMEM;
1737 }
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001738 ret = fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001739 spin_lock(&inode->i_lock);
J. Bruce Fields8896b932010-11-03 18:09:18 -04001740 error = __vfs_setlease(filp, arg, &ret);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001741 if (error) {
Jeff Layton1c8c6012013-06-21 08:58:15 -04001742 spin_unlock(&inode->i_lock);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001743 locks_free_lock(fl);
1744 goto out_free_fasync;
1745 }
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001746 if (ret != fl)
1747 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001749 /*
1750 * fasync_insert_entry() returns the old entry if any.
1751 * If there was no old entry, then it used 'new' and
1752 * inserted it into the fasync list. Clear new so that
1753 * we don't release it here.
1754 */
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001755 if (!fasync_insert_entry(fd, filp, &ret->fl_fasync, new))
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001756 new = NULL;
1757
J. Bruce Fields8896b932010-11-03 18:09:18 -04001758 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001759 spin_unlock(&inode->i_lock);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001760
1761out_free_fasync:
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001762 if (new)
1763 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764 return error;
1765}
1766
1767/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001768 * fcntl_setlease - sets a lease on an open file
1769 * @fd: open file descriptor
1770 * @filp: file pointer
1771 * @arg: type of lease to obtain
1772 *
1773 * Call this fcntl to establish a lease on the file.
1774 * Note that you also need to call %F_SETSIG to
1775 * receive a signal when the lease is broken.
1776 */
1777int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1778{
1779 if (arg == F_UNLCK)
1780 return do_fcntl_delete_lease(filp);
1781 return do_fcntl_add_lease(fd, filp, arg);
1782}
1783
1784/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1786 * @filp: The file to apply the lock to
1787 * @fl: The lock to be applied
1788 *
1789 * Add a FLOCK style lock to a file.
1790 */
1791int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1792{
1793 int error;
1794 might_sleep();
1795 for (;;) {
1796 error = flock_lock_file(filp, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001797 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 break;
1799 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1800 if (!error)
1801 continue;
1802
1803 locks_delete_block(fl);
1804 break;
1805 }
1806 return error;
1807}
1808
1809EXPORT_SYMBOL(flock_lock_file_wait);
1810
1811/**
1812 * sys_flock: - flock() system call.
1813 * @fd: the file descriptor to lock.
1814 * @cmd: the type of lock to apply.
1815 *
1816 * Apply a %FL_FLOCK style lock to an open file descriptor.
1817 * The @cmd can be one of
1818 *
1819 * %LOCK_SH -- a shared lock.
1820 *
1821 * %LOCK_EX -- an exclusive lock.
1822 *
1823 * %LOCK_UN -- remove an existing lock.
1824 *
1825 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1826 *
1827 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1828 * processes read and write access respectively.
1829 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001830SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831{
Al Viro2903ff02012-08-28 12:52:22 -04001832 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833 struct file_lock *lock;
1834 int can_sleep, unlock;
1835 int error;
1836
1837 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001838 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839 goto out;
1840
1841 can_sleep = !(cmd & LOCK_NB);
1842 cmd &= ~LOCK_NB;
1843 unlock = (cmd == LOCK_UN);
1844
Al Viroaeb5d722008-09-02 15:28:45 -04001845 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04001846 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847 goto out_putf;
1848
Al Viro2903ff02012-08-28 12:52:22 -04001849 error = flock_make_lock(f.file, &lock, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850 if (error)
1851 goto out_putf;
1852 if (can_sleep)
1853 lock->fl_flags |= FL_SLEEP;
1854
Al Viro2903ff02012-08-28 12:52:22 -04001855 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 if (error)
1857 goto out_free;
1858
Al Viro72c2d532013-09-22 16:27:52 -04001859 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04001860 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861 (can_sleep) ? F_SETLKW : F_SETLK,
1862 lock);
1863 else
Al Viro2903ff02012-08-28 12:52:22 -04001864 error = flock_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865
1866 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08001867 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868
1869 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04001870 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871 out:
1872 return error;
1873}
1874
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001875/**
1876 * vfs_test_lock - test file byte range lock
1877 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04001878 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001879 *
1880 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1881 * setting conf->fl_type to something other than F_UNLCK.
1882 */
1883int vfs_test_lock(struct file *filp, struct file_lock *fl)
1884{
Al Viro72c2d532013-09-22 16:27:52 -04001885 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001886 return filp->f_op->lock(filp, F_GETLK, fl);
1887 posix_test_lock(filp, fl);
1888 return 0;
1889}
1890EXPORT_SYMBOL_GPL(vfs_test_lock);
1891
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001892static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1893{
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001894 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001895#if BITS_PER_LONG == 32
1896 /*
1897 * Make sure we can represent the posix lock via
1898 * legacy 32bit flock.
1899 */
1900 if (fl->fl_start > OFFT_OFFSET_MAX)
1901 return -EOVERFLOW;
1902 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1903 return -EOVERFLOW;
1904#endif
1905 flock->l_start = fl->fl_start;
1906 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1907 fl->fl_end - fl->fl_start + 1;
1908 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04001909 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001910 return 0;
1911}
1912
1913#if BITS_PER_LONG == 32
1914static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1915{
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001916 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001917 flock->l_start = fl->fl_start;
1918 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1919 fl->fl_end - fl->fl_start + 1;
1920 flock->l_whence = 0;
1921 flock->l_type = fl->fl_type;
1922}
1923#endif
1924
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925/* Report the first existing lock that would conflict with l.
1926 * This implements the F_GETLK command of fcntl().
1927 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001928int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001930 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 struct flock flock;
1932 int error;
1933
1934 error = -EFAULT;
1935 if (copy_from_user(&flock, l, sizeof(flock)))
1936 goto out;
1937 error = -EINVAL;
1938 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1939 goto out;
1940
1941 error = flock_to_posix_lock(filp, &file_lock, &flock);
1942 if (error)
1943 goto out;
1944
Jeff Layton0d3f7a22014-04-22 08:23:58 -04001945 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05001946 error = -EINVAL;
1947 if (flock.l_pid != 0)
1948 goto out;
1949
Jeff Layton5d50ffd2014-02-03 12:13:10 -05001950 cmd = F_GETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001951 file_lock.fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001952 file_lock.fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05001953 }
1954
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001955 error = vfs_test_lock(filp, &file_lock);
1956 if (error)
1957 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001959 flock.l_type = file_lock.fl_type;
1960 if (file_lock.fl_type != F_UNLCK) {
1961 error = posix_lock_to_flock(&flock, &file_lock);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001962 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 }
1965 error = -EFAULT;
1966 if (!copy_to_user(l, &flock, sizeof(flock)))
1967 error = 0;
1968out:
1969 return error;
1970}
1971
Marc Eshel7723ec92007-01-18 15:08:55 -05001972/**
1973 * vfs_lock_file - file byte range lock
1974 * @filp: The file to apply the lock to
1975 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1976 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001977 * @conf: Place to return a copy of the conflicting lock, if found.
1978 *
1979 * A caller that doesn't care about the conflicting lock may pass NULL
1980 * as the final argument.
1981 *
1982 * If the filesystem defines a private ->lock() method, then @conf will
1983 * be left unchanged; so a caller that cares should initialize it to
1984 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05001985 *
1986 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1987 * locks, the ->lock() interface may return asynchronously, before the lock has
1988 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001989 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05001990 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1991 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001992 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05001993 * request completes.
1994 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07001995 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
1996 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05001997 * nonzero return code and the file system should release the lock. The file
1998 * system is also responsible to keep a corresponding posix lock when it
1999 * grants a lock so the VFS can find out which locks are locally held and do
2000 * the correct lock cleanup when required.
2001 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002002 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05002003 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05002004 */
Marc Eshel150b3932007-01-18 16:15:35 -05002005int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05002006{
Al Viro72c2d532013-09-22 16:27:52 -04002007 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05002008 return filp->f_op->lock(filp, cmd, fl);
2009 else
Marc Eshel150b3932007-01-18 16:15:35 -05002010 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05002011}
2012EXPORT_SYMBOL_GPL(vfs_lock_file);
2013
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002014static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2015 struct file_lock *fl)
2016{
2017 int error;
2018
2019 error = security_file_lock(filp, fl->fl_type);
2020 if (error)
2021 return error;
2022
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002023 for (;;) {
2024 error = vfs_lock_file(filp, cmd, fl, NULL);
2025 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002026 break;
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002027 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
2028 if (!error)
2029 continue;
2030
2031 locks_delete_block(fl);
2032 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002033 }
2034
2035 return error;
2036}
2037
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002038/* Ensure that fl->fl_filp has compatible f_mode for F_SETLK calls */
2039static int
2040check_fmode_for_setlk(struct file_lock *fl)
2041{
2042 switch (fl->fl_type) {
2043 case F_RDLCK:
2044 if (!(fl->fl_file->f_mode & FMODE_READ))
2045 return -EBADF;
2046 break;
2047 case F_WRLCK:
2048 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2049 return -EBADF;
2050 }
2051 return 0;
2052}
2053
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054/* Apply the lock described by l to an open file descriptor.
2055 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2056 */
Peter Staubachc2936212005-07-27 11:45:09 -07002057int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
2058 struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059{
2060 struct file_lock *file_lock = locks_alloc_lock();
2061 struct flock flock;
2062 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002063 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 int error;
2065
2066 if (file_lock == NULL)
2067 return -ENOLCK;
2068
2069 /*
2070 * This might block, so we do it before checking the inode.
2071 */
2072 error = -EFAULT;
2073 if (copy_from_user(&flock, l, sizeof(flock)))
2074 goto out;
2075
Al Viro496ad9a2013-01-23 17:07:38 -05002076 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077
2078 /* Don't allow mandatory locks on files that may be memory mapped
2079 * and shared.
2080 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002081 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 error = -EAGAIN;
2083 goto out;
2084 }
2085
Peter Staubachc2936212005-07-27 11:45:09 -07002086again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 error = flock_to_posix_lock(filp, file_lock, &flock);
2088 if (error)
2089 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002090
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002091 error = check_fmode_for_setlk(file_lock);
2092 if (error)
2093 goto out;
2094
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002095 /*
2096 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002097 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002098 */
2099 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002100 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002101 error = -EINVAL;
2102 if (flock.l_pid != 0)
2103 goto out;
2104
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002105 cmd = F_SETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002106 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002107 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002108 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002109 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002110 error = -EINVAL;
2111 if (flock.l_pid != 0)
2112 goto out;
2113
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002114 cmd = F_SETLKW;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002115 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002116 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002117 /* Fallthrough */
2118 case F_SETLKW:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 file_lock->fl_flags |= FL_SLEEP;
2120 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002121
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002122 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123
Peter Staubachc2936212005-07-27 11:45:09 -07002124 /*
2125 * Attempt to detect a close/fcntl race and recover by
2126 * releasing the lock that was just acquired.
2127 */
Al Viro0b2bac22008-05-06 13:58:34 -04002128 /*
2129 * we need that spin_lock here - it prevents reordering between
2130 * update of inode->i_flock and check for it done in close().
2131 * rcu_read_lock() wouldn't do.
2132 */
2133 spin_lock(&current->files->file_lock);
2134 f = fcheck(fd);
2135 spin_unlock(&current->files->file_lock);
2136 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002137 flock.l_type = F_UNLCK;
2138 goto again;
2139 }
2140
2141out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 locks_free_lock(file_lock);
2143 return error;
2144}
2145
2146#if BITS_PER_LONG == 32
2147/* Report the first existing lock that would conflict with l.
2148 * This implements the F_GETLK command of fcntl().
2149 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05002150int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002152 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 struct flock64 flock;
2154 int error;
2155
2156 error = -EFAULT;
2157 if (copy_from_user(&flock, l, sizeof(flock)))
2158 goto out;
2159 error = -EINVAL;
2160 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2161 goto out;
2162
2163 error = flock64_to_posix_lock(filp, &file_lock, &flock);
2164 if (error)
2165 goto out;
2166
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002167 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002168 error = -EINVAL;
2169 if (flock.l_pid != 0)
2170 goto out;
2171
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002172 cmd = F_GETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002173 file_lock.fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002174 file_lock.fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002175 }
2176
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002177 error = vfs_test_lock(filp, &file_lock);
2178 if (error)
2179 goto out;
2180
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002181 flock.l_type = file_lock.fl_type;
2182 if (file_lock.fl_type != F_UNLCK)
2183 posix_lock_to_flock64(&flock, &file_lock);
2184
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185 error = -EFAULT;
2186 if (!copy_to_user(l, &flock, sizeof(flock)))
2187 error = 0;
2188
2189out:
2190 return error;
2191}
2192
2193/* Apply the lock described by l to an open file descriptor.
2194 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2195 */
Peter Staubachc2936212005-07-27 11:45:09 -07002196int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2197 struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198{
2199 struct file_lock *file_lock = locks_alloc_lock();
2200 struct flock64 flock;
2201 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002202 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 int error;
2204
2205 if (file_lock == NULL)
2206 return -ENOLCK;
2207
2208 /*
2209 * This might block, so we do it before checking the inode.
2210 */
2211 error = -EFAULT;
2212 if (copy_from_user(&flock, l, sizeof(flock)))
2213 goto out;
2214
Al Viro496ad9a2013-01-23 17:07:38 -05002215 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216
2217 /* Don't allow mandatory locks on files that may be memory mapped
2218 * and shared.
2219 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002220 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 error = -EAGAIN;
2222 goto out;
2223 }
2224
Peter Staubachc2936212005-07-27 11:45:09 -07002225again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 error = flock64_to_posix_lock(filp, file_lock, &flock);
2227 if (error)
2228 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002229
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002230 error = check_fmode_for_setlk(file_lock);
2231 if (error)
2232 goto out;
2233
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002234 /*
2235 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002236 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002237 */
2238 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002239 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002240 error = -EINVAL;
2241 if (flock.l_pid != 0)
2242 goto out;
2243
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002244 cmd = F_SETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002245 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002246 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002247 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002248 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002249 error = -EINVAL;
2250 if (flock.l_pid != 0)
2251 goto out;
2252
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002253 cmd = F_SETLKW64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002254 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002255 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002256 /* Fallthrough */
2257 case F_SETLKW64:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 file_lock->fl_flags |= FL_SLEEP;
2259 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002260
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002261 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262
Peter Staubachc2936212005-07-27 11:45:09 -07002263 /*
2264 * Attempt to detect a close/fcntl race and recover by
2265 * releasing the lock that was just acquired.
2266 */
Al Viro0b2bac22008-05-06 13:58:34 -04002267 spin_lock(&current->files->file_lock);
2268 f = fcheck(fd);
2269 spin_unlock(&current->files->file_lock);
2270 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002271 flock.l_type = F_UNLCK;
2272 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273 }
2274
2275out:
2276 locks_free_lock(file_lock);
2277 return error;
2278}
2279#endif /* BITS_PER_LONG == 32 */
2280
2281/*
2282 * This function is called when the file is being removed
2283 * from the task's fd array. POSIX locks belonging to this task
2284 * are deleted at this time.
2285 */
2286void locks_remove_posix(struct file *filp, fl_owner_t owner)
2287{
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002288 struct file_lock lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289
2290 /*
2291 * If there are no locks held on this file, we don't need to call
2292 * posix_lock_file(). Another process could be setting a lock on this
2293 * file at the same time, but we wouldn't remove that lock anyway.
2294 */
Al Viro496ad9a2013-01-23 17:07:38 -05002295 if (!file_inode(filp)->i_flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296 return;
2297
2298 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002299 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300 lock.fl_start = 0;
2301 lock.fl_end = OFFSET_MAX;
2302 lock.fl_owner = owner;
2303 lock.fl_pid = current->tgid;
2304 lock.fl_file = filp;
2305 lock.fl_ops = NULL;
2306 lock.fl_lmops = NULL;
2307
Marc Eshel150b3932007-01-18 16:15:35 -05002308 vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2311 lock.fl_ops->fl_release_private(&lock);
2312}
2313
2314EXPORT_SYMBOL(locks_remove_posix);
2315
2316/*
2317 * This function is called on the last close of an open file.
2318 */
Jeff Layton78ed8a12014-02-03 12:13:08 -05002319void locks_remove_file(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320{
Al Viro496ad9a2013-01-23 17:07:38 -05002321 struct inode * inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 struct file_lock *fl;
2323 struct file_lock **before;
2324
2325 if (!inode->i_flock)
2326 return;
2327
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002328 locks_remove_posix(filp, filp);
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002329
Al Viro72c2d532013-09-22 16:27:52 -04002330 if (filp->f_op->flock) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331 struct file_lock fl = {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002332 .fl_owner = filp,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 .fl_pid = current->tgid,
2334 .fl_file = filp,
2335 .fl_flags = FL_FLOCK,
2336 .fl_type = F_UNLCK,
2337 .fl_end = OFFSET_MAX,
2338 };
2339 filp->f_op->flock(filp, F_SETLKW, &fl);
Trond Myklebust80fec4c2005-06-22 17:16:31 +00002340 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2341 fl.fl_ops->fl_release_private(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342 }
2343
Jeff Layton1c8c6012013-06-21 08:58:15 -04002344 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345 before = &inode->i_flock;
2346
2347 while ((fl = *before) != NULL) {
2348 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 if (IS_LEASE(fl)) {
2350 lease_modify(before, F_UNLCK);
2351 continue;
2352 }
Jeff Layton8c3cac52014-02-03 12:13:07 -05002353
2354 /*
2355 * There's a leftover lock on the list of a type that
2356 * we didn't expect to see. Most likely a classic
2357 * POSIX lock that ended up not getting released
2358 * properly, or that raced onto the list somehow. Log
2359 * some info about it and then just remove it from
2360 * the list.
2361 */
2362 WARN(!IS_FLOCK(fl),
2363 "leftover lock: dev=%u:%u ino=%lu type=%hhd flags=0x%x start=%lld end=%lld\n",
2364 MAJOR(inode->i_sb->s_dev),
2365 MINOR(inode->i_sb->s_dev), inode->i_ino,
2366 fl->fl_type, fl->fl_flags,
2367 fl->fl_start, fl->fl_end);
2368
2369 locks_delete_lock(before);
2370 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371 }
2372 before = &fl->fl_next;
2373 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002374 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375}
2376
2377/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378 * posix_unblock_lock - stop waiting for a file lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 * @waiter: the lock which was waiting
2380 *
2381 * lockd needs to block waiting for locks.
2382 */
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002383int
Jeff Laytonf891a292013-06-21 08:58:09 -04002384posix_unblock_lock(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385{
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002386 int status = 0;
2387
Jeff Layton7b2296a2013-06-21 08:58:20 -04002388 spin_lock(&blocked_lock_lock);
J. Bruce Fields5996a292006-01-03 09:55:44 +01002389 if (waiter->fl_next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390 __locks_delete_block(waiter);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002391 else
2392 status = -ENOENT;
Jeff Layton7b2296a2013-06-21 08:58:20 -04002393 spin_unlock(&blocked_lock_lock);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002394 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396EXPORT_SYMBOL(posix_unblock_lock);
2397
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002398/**
2399 * vfs_cancel_lock - file byte range unblock lock
2400 * @filp: The file to apply the unblock to
2401 * @fl: The lock to be unblocked
2402 *
2403 * Used by lock managers to cancel blocked requests
2404 */
2405int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2406{
Al Viro72c2d532013-09-22 16:27:52 -04002407 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002408 return filp->f_op->lock(filp, F_CANCELLK, fl);
2409 return 0;
2410}
2411
2412EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2413
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002414#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002415#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002416#include <linux/seq_file.h>
2417
Jeff Layton7012b022013-06-21 08:58:22 -04002418struct locks_iterator {
2419 int li_cpu;
2420 loff_t li_pos;
2421};
2422
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002423static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002424 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425{
2426 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002427 unsigned int fl_pid;
2428
2429 if (fl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -08002430 fl_pid = pid_vnr(fl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002431 else
2432 fl_pid = fl->fl_pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002433
2434 if (fl->fl_file != NULL)
Al Viro496ad9a2013-01-23 17:07:38 -05002435 inode = file_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436
Jerome Marchand99dc8292010-10-26 14:22:33 -07002437 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 if (IS_POSIX(fl)) {
Jeff Laytonc918d422014-02-03 12:13:09 -05002439 if (fl->fl_flags & FL_ACCESS)
Fabian Frederick5315c262014-05-09 14:13:05 -04002440 seq_puts(f, "ACCESS");
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002441 else if (IS_OFDLCK(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002442 seq_puts(f, "OFDLCK");
Jeff Laytonc918d422014-02-03 12:13:09 -05002443 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002444 seq_puts(f, "POSIX ");
Jeff Laytonc918d422014-02-03 12:13:09 -05002445
2446 seq_printf(f, " %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002448 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449 } else if (IS_FLOCK(fl)) {
2450 if (fl->fl_type & LOCK_MAND) {
Fabian Frederick5315c262014-05-09 14:13:05 -04002451 seq_puts(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002452 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002453 seq_puts(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454 }
2455 } else if (IS_LEASE(fl)) {
Jeff Layton8144f1f2014-08-11 13:36:54 -04002456 if (fl->fl_flags & FL_DELEG)
2457 seq_puts(f, "DELEG ");
2458 else
2459 seq_puts(f, "LEASE ");
2460
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002461 if (lease_breaking(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002462 seq_puts(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 else if (fl->fl_file)
Fabian Frederick5315c262014-05-09 14:13:05 -04002464 seq_puts(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002466 seq_puts(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002468 seq_puts(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469 }
2470 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002471 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472 (fl->fl_type & LOCK_READ)
2473 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2474 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2475 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002476 seq_printf(f, "%s ",
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002477 (lease_breaking(fl))
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04002478 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2479 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480 }
2481 if (inode) {
2482#ifdef WE_CAN_BREAK_LSLK_NOW
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002483 seq_printf(f, "%d %s:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484 inode->i_sb->s_id, inode->i_ino);
2485#else
2486 /* userspace relies on this representation of dev_t ;-( */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002487 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488 MAJOR(inode->i_sb->s_dev),
2489 MINOR(inode->i_sb->s_dev), inode->i_ino);
2490#endif
2491 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002492 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493 }
2494 if (IS_POSIX(fl)) {
2495 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002496 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002498 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002499 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002500 seq_puts(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501 }
2502}
2503
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002504static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002505{
Jeff Layton7012b022013-06-21 08:58:22 -04002506 struct locks_iterator *iter = f->private;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002507 struct file_lock *fl, *bfl;
2508
Jeff Layton139ca042013-06-21 08:58:17 -04002509 fl = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002510
Jeff Layton7012b022013-06-21 08:58:22 -04002511 lock_get_status(f, fl, iter->li_pos, "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002512
2513 list_for_each_entry(bfl, &fl->fl_block, fl_block)
Jeff Layton7012b022013-06-21 08:58:22 -04002514 lock_get_status(f, bfl, iter->li_pos, " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002515
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002516 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517}
2518
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002519static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002520 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521{
Jeff Layton7012b022013-06-21 08:58:22 -04002522 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002523
Jeff Layton7012b022013-06-21 08:58:22 -04002524 iter->li_pos = *pos + 1;
2525 lg_global_lock(&file_lock_lglock);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002526 spin_lock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002527 return seq_hlist_start_percpu(&file_lock_list, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528}
2529
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002530static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2531{
Jeff Layton7012b022013-06-21 08:58:22 -04002532 struct locks_iterator *iter = f->private;
2533
2534 ++iter->li_pos;
2535 return seq_hlist_next_percpu(v, &file_lock_list, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002536}
2537
2538static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002539 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002540{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002541 spin_unlock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002542 lg_global_unlock(&file_lock_lglock);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002543}
2544
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002545static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002546 .start = locks_start,
2547 .next = locks_next,
2548 .stop = locks_stop,
2549 .show = locks_show,
2550};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002551
2552static int locks_open(struct inode *inode, struct file *filp)
2553{
Jeff Layton7012b022013-06-21 08:58:22 -04002554 return seq_open_private(filp, &locks_seq_operations,
2555 sizeof(struct locks_iterator));
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002556}
2557
2558static const struct file_operations proc_locks_operations = {
2559 .open = locks_open,
2560 .read = seq_read,
2561 .llseek = seq_lseek,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002562 .release = seq_release_private,
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002563};
2564
2565static int __init proc_locks_init(void)
2566{
2567 proc_create("locks", 0, NULL, &proc_locks_operations);
2568 return 0;
2569}
2570module_init(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002571#endif
2572
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573/**
2574 * lock_may_read - checks that the region is free of locks
2575 * @inode: the inode that is being read
2576 * @start: the first byte to read
2577 * @len: the number of bytes to read
2578 *
2579 * Emulates Windows locking requirements. Whole-file
2580 * mandatory locks (share modes) can prohibit a read and
2581 * byte-range POSIX locks can prohibit a read if they overlap.
2582 *
2583 * N.B. this function is only ever called
2584 * from knfsd and ownership of locks is never checked.
2585 */
2586int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2587{
2588 struct file_lock *fl;
2589 int result = 1;
Jeff Layton1c8c6012013-06-21 08:58:15 -04002590
2591 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002592 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2593 if (IS_POSIX(fl)) {
2594 if (fl->fl_type == F_RDLCK)
2595 continue;
2596 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2597 continue;
2598 } else if (IS_FLOCK(fl)) {
2599 if (!(fl->fl_type & LOCK_MAND))
2600 continue;
2601 if (fl->fl_type & LOCK_READ)
2602 continue;
2603 } else
2604 continue;
2605 result = 0;
2606 break;
2607 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002608 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609 return result;
2610}
2611
2612EXPORT_SYMBOL(lock_may_read);
2613
2614/**
2615 * lock_may_write - checks that the region is free of locks
2616 * @inode: the inode that is being written
2617 * @start: the first byte to write
2618 * @len: the number of bytes to write
2619 *
2620 * Emulates Windows locking requirements. Whole-file
2621 * mandatory locks (share modes) can prohibit a write and
2622 * byte-range POSIX locks can prohibit a write if they overlap.
2623 *
2624 * N.B. this function is only ever called
2625 * from knfsd and ownership of locks is never checked.
2626 */
2627int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2628{
2629 struct file_lock *fl;
2630 int result = 1;
Jeff Layton1c8c6012013-06-21 08:58:15 -04002631
2632 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2634 if (IS_POSIX(fl)) {
2635 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2636 continue;
2637 } else if (IS_FLOCK(fl)) {
2638 if (!(fl->fl_type & LOCK_MAND))
2639 continue;
2640 if (fl->fl_type & LOCK_WRITE)
2641 continue;
2642 } else
2643 continue;
2644 result = 0;
2645 break;
2646 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002647 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002648 return result;
2649}
2650
2651EXPORT_SYMBOL(lock_may_write);
2652
Linus Torvalds1da177e2005-04-16 15:20:36 -07002653static int __init filelock_init(void)
2654{
Jeff Layton7012b022013-06-21 08:58:22 -04002655 int i;
2656
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002658 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2659
Jeff Layton7012b022013-06-21 08:58:22 -04002660 lg_lock_init(&file_lock_lglock, "file_lock_lglock");
2661
2662 for_each_possible_cpu(i)
2663 INIT_HLIST_HEAD(per_cpu_ptr(&file_lock_list, i));
2664
Linus Torvalds1da177e2005-04-16 15:20:36 -07002665 return 0;
2666}
2667
2668core_initcall(filelock_init);