blob: e50bb4d9e757c91d9da2488ed30c71d034dc39e4 [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
Jeff Layton1c8c6012013-06-21 08:58:15 -0400160/*
Jeff Layton7012b022013-06-21 08:58:22 -0400161 * The global file_lock_list is only used for displaying /proc/locks, so we
162 * keep a list on each CPU, with each list protected by its own spinlock via
163 * the file_lock_lglock. Note that alterations to the list also require that
164 * the relevant i_lock is held.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400165 */
Jeff Layton7012b022013-06-21 08:58:22 -0400166DEFINE_STATIC_LGLOCK(file_lock_lglock);
167static DEFINE_PER_CPU(struct hlist_head, file_lock_list);
Jeff Layton88974692013-06-21 08:58:14 -0400168
Jeff Layton1c8c6012013-06-21 08:58:15 -0400169/*
Jeff Layton48f74182013-06-21 08:58:18 -0400170 * The blocked_hash is used to find POSIX lock loops for deadlock detection.
Jeff Layton7b2296a2013-06-21 08:58:20 -0400171 * It is protected by blocked_lock_lock.
Jeff Layton48f74182013-06-21 08:58:18 -0400172 *
173 * We hash locks by lockowner in order to optimize searching for the lock a
174 * particular lockowner is waiting on.
175 *
176 * FIXME: make this value scale via some heuristic? We generally will want more
177 * buckets when we have more lockowners holding locks, but that's a little
178 * difficult to determine without knowing what the workload will look like.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400179 */
Jeff Layton48f74182013-06-21 08:58:18 -0400180#define BLOCKED_HASH_BITS 7
181static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
Jeff Layton88974692013-06-21 08:58:14 -0400182
Jeff Layton1c8c6012013-06-21 08:58:15 -0400183/*
Jeff Layton7b2296a2013-06-21 08:58:20 -0400184 * This lock protects the blocked_hash. Generally, if you're accessing it, you
185 * want to be holding this lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400186 *
187 * In addition, it also protects the fl->fl_block list, and the fl->fl_next
188 * pointer for file_lock structures that are acting as lock requests (in
189 * contrast to those that are acting as records of acquired locks).
190 *
191 * Note that when we acquire this lock in order to change the above fields,
192 * we often hold the i_lock as well. In certain cases, when reading the fields
193 * protected by this lock, we can skip acquiring it iff we already hold the
194 * i_lock.
195 *
196 * In particular, adding an entry to the fl_block list requires that you hold
197 * both the i_lock and the blocked_lock_lock (acquired in that order). Deleting
198 * an entry from the list however only requires the file_lock_lock.
199 */
Jeff Layton7b2296a2013-06-21 08:58:20 -0400200static DEFINE_SPINLOCK(blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
Jeff Layton4a075e32015-01-16 15:05:54 -0500202static struct kmem_cache *flctx_cache __read_mostly;
Christoph Lametere18b8902006-12-06 20:33:20 -0800203static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Jeff Layton4a075e32015-01-16 15:05:54 -0500205static struct file_lock_context *
206locks_get_lock_context(struct inode *inode)
207{
208 struct file_lock_context *new;
209
210 if (likely(inode->i_flctx))
211 goto out;
212
213 new = kmem_cache_alloc(flctx_cache, GFP_KERNEL);
214 if (!new)
215 goto out;
216
217 INIT_LIST_HEAD(&new->flc_flock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500218 INIT_LIST_HEAD(&new->flc_posix);
Jeff Layton4a075e32015-01-16 15:05:54 -0500219
220 /*
221 * Assign the pointer if it's not already assigned. If it is, then
222 * free the context we just allocated.
223 */
224 spin_lock(&inode->i_lock);
225 if (likely(!inode->i_flctx)) {
226 inode->i_flctx = new;
227 new = NULL;
228 }
229 spin_unlock(&inode->i_lock);
230
231 if (new)
232 kmem_cache_free(flctx_cache, new);
233out:
234 return inode->i_flctx;
235}
236
237void
238locks_free_lock_context(struct file_lock_context *ctx)
239{
240 if (ctx) {
241 WARN_ON_ONCE(!list_empty(&ctx->flc_flock));
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500242 WARN_ON_ONCE(!list_empty(&ctx->flc_posix));
Jeff Layton4a075e32015-01-16 15:05:54 -0500243 kmem_cache_free(flctx_cache, ctx);
244 }
245}
246
Miklos Szerediee19cc42011-07-07 13:06:09 +0200247static void locks_init_lock_heads(struct file_lock *fl)
Miklos Szeredia51cb912011-07-06 12:33:55 +0200248{
Jeff Layton139ca042013-06-21 08:58:17 -0400249 INIT_HLIST_NODE(&fl->fl_link);
Jeff Layton6dee60f2015-01-16 15:05:54 -0500250 INIT_LIST_HEAD(&fl->fl_list);
Miklos Szerediee19cc42011-07-07 13:06:09 +0200251 INIT_LIST_HEAD(&fl->fl_block);
252 init_waitqueue_head(&fl->fl_wait);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200253}
254
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200256struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200258 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200259
260 if (fl)
Miklos Szerediee19cc42011-07-07 13:06:09 +0200261 locks_init_lock_heads(fl);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200262
263 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200265EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500267void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500268{
269 if (fl->fl_ops) {
270 if (fl->fl_ops->fl_release_private)
271 fl->fl_ops->fl_release_private(fl);
272 fl->fl_ops = NULL;
273 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500274
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400275 if (fl->fl_lmops) {
276 if (fl->fl_lmops->lm_put_owner)
277 fl->fl_lmops->lm_put_owner(fl);
278 fl->fl_lmops = NULL;
279 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500280}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500281EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500282
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283/* Free a lock which is not in use. */
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400284void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285{
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800286 BUG_ON(waitqueue_active(&fl->fl_wait));
Jeff Layton6dee60f2015-01-16 15:05:54 -0500287 BUG_ON(!list_empty(&fl->fl_list));
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800288 BUG_ON(!list_empty(&fl->fl_block));
Jeff Layton139ca042013-06-21 08:58:17 -0400289 BUG_ON(!hlist_unhashed(&fl->fl_link));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
Trond Myklebust47831f32006-03-20 13:44:05 -0500291 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 kmem_cache_free(filelock_cache, fl);
293}
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400294EXPORT_SYMBOL(locks_free_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
Jeff Laytoned9814d2014-08-11 14:20:31 -0400296static void
297locks_dispose_list(struct list_head *dispose)
298{
299 struct file_lock *fl;
300
301 while (!list_empty(dispose)) {
Jeff Layton6dee60f2015-01-16 15:05:54 -0500302 fl = list_first_entry(dispose, struct file_lock, fl_list);
303 list_del_init(&fl->fl_list);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400304 locks_free_lock(fl);
305 }
306}
307
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308void locks_init_lock(struct file_lock *fl)
309{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200310 memset(fl, 0, sizeof(struct file_lock));
311 locks_init_lock_heads(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312}
313
314EXPORT_SYMBOL(locks_init_lock);
315
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316/*
317 * Initialize a new lock from an existing file_lock structure.
318 */
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400319void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320{
321 new->fl_owner = fl->fl_owner;
322 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500323 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 new->fl_flags = fl->fl_flags;
325 new->fl_type = fl->fl_type;
326 new->fl_start = fl->fl_start;
327 new->fl_end = fl->fl_end;
Kinglong Meef3282962014-08-22 10:18:43 -0400328 new->fl_lmops = fl->fl_lmops;
Trond Myklebust09969052006-03-20 13:44:38 -0500329 new->fl_ops = NULL;
Kinglong Meef3282962014-08-22 10:18:43 -0400330
331 if (fl->fl_lmops) {
332 if (fl->fl_lmops->lm_get_owner)
333 fl->fl_lmops->lm_get_owner(new, fl);
334 }
Trond Myklebust09969052006-03-20 13:44:38 -0500335}
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400336EXPORT_SYMBOL(locks_copy_conflock);
Trond Myklebust09969052006-03-20 13:44:38 -0500337
338void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
339{
Jeff Layton566709b2014-08-11 14:09:35 -0400340 /* "new" must be a freshly-initialized lock */
341 WARN_ON_ONCE(new->fl_ops);
Trond Myklebust09969052006-03-20 13:44:38 -0500342
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400343 locks_copy_conflock(new, fl);
Kinglong Meef3282962014-08-22 10:18:43 -0400344
Trond Myklebust09969052006-03-20 13:44:38 -0500345 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 new->fl_ops = fl->fl_ops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500347
Kinglong Meef3282962014-08-22 10:18:43 -0400348 if (fl->fl_ops) {
349 if (fl->fl_ops->fl_copy_lock)
350 fl->fl_ops->fl_copy_lock(new, fl);
351 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352}
353
354EXPORT_SYMBOL(locks_copy_lock);
355
356static inline int flock_translate_cmd(int cmd) {
357 if (cmd & LOCK_MAND)
358 return cmd & (LOCK_MAND | LOCK_RW);
359 switch (cmd) {
360 case LOCK_SH:
361 return F_RDLCK;
362 case LOCK_EX:
363 return F_WRLCK;
364 case LOCK_UN:
365 return F_UNLCK;
366 }
367 return -EINVAL;
368}
369
370/* Fill in a file_lock structure with an appropriate FLOCK lock. */
Jeff Layton6e129d002014-09-04 10:25:06 -0400371static struct file_lock *
372flock_make_lock(struct file *filp, unsigned int cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373{
374 struct file_lock *fl;
375 int type = flock_translate_cmd(cmd);
Jeff Layton6e129d002014-09-04 10:25:06 -0400376
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 if (type < 0)
Jeff Layton6e129d002014-09-04 10:25:06 -0400378 return ERR_PTR(type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
380 fl = locks_alloc_lock();
381 if (fl == NULL)
Jeff Layton6e129d002014-09-04 10:25:06 -0400382 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
384 fl->fl_file = filp;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +0200385 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 fl->fl_pid = current->tgid;
387 fl->fl_flags = FL_FLOCK;
388 fl->fl_type = type;
389 fl->fl_end = OFFSET_MAX;
390
Jeff Layton6e129d002014-09-04 10:25:06 -0400391 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392}
393
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400394static int assign_type(struct file_lock *fl, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395{
396 switch (type) {
397 case F_RDLCK:
398 case F_WRLCK:
399 case F_UNLCK:
400 fl->fl_type = type;
401 break;
402 default:
403 return -EINVAL;
404 }
405 return 0;
406}
407
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500408static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
409 struct flock64 *l)
410{
411 switch (l->l_whence) {
412 case SEEK_SET:
413 fl->fl_start = 0;
414 break;
415 case SEEK_CUR:
416 fl->fl_start = filp->f_pos;
417 break;
418 case SEEK_END:
419 fl->fl_start = i_size_read(file_inode(filp));
420 break;
421 default:
422 return -EINVAL;
423 }
424 if (l->l_start > OFFSET_MAX - fl->fl_start)
425 return -EOVERFLOW;
426 fl->fl_start += l->l_start;
427 if (fl->fl_start < 0)
428 return -EINVAL;
429
430 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
431 POSIX-2001 defines it. */
432 if (l->l_len > 0) {
433 if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
434 return -EOVERFLOW;
435 fl->fl_end = fl->fl_start + l->l_len - 1;
436
437 } else if (l->l_len < 0) {
438 if (fl->fl_start + l->l_len < 0)
439 return -EINVAL;
440 fl->fl_end = fl->fl_start - 1;
441 fl->fl_start += l->l_len;
442 } else
443 fl->fl_end = OFFSET_MAX;
444
445 fl->fl_owner = current->files;
446 fl->fl_pid = current->tgid;
447 fl->fl_file = filp;
448 fl->fl_flags = FL_POSIX;
449 fl->fl_ops = NULL;
450 fl->fl_lmops = NULL;
451
452 return assign_type(fl, l->l_type);
453}
454
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
456 * style lock.
457 */
458static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
459 struct flock *l)
460{
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500461 struct flock64 ll = {
462 .l_type = l->l_type,
463 .l_whence = l->l_whence,
464 .l_start = l->l_start,
465 .l_len = l->l_len,
466 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500468 return flock64_to_posix_lock(filp, fl, &ll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469}
470
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471/* default lease lock manager operations */
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400472static bool
473lease_break_callback(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474{
475 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400476 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477}
478
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400479static void
480lease_setup(struct file_lock *fl, void **priv)
481{
482 struct file *filp = fl->fl_file;
483 struct fasync_struct *fa = *priv;
484
485 /*
486 * fasync_insert_entry() returns the old entry if any. If there was no
487 * old entry, then it used "priv" and inserted it into the fasync list.
488 * Clear the pointer to indicate that it shouldn't be freed.
489 */
490 if (!fasync_insert_entry(fa->fa_fd, filp, &fl->fl_fasync, fa))
491 *priv = NULL;
492
493 __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
494}
495
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700496static const struct lock_manager_operations lease_manager_ops = {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400497 .lm_break = lease_break_callback,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400498 .lm_change = lease_modify,
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400499 .lm_setup = lease_setup,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500};
501
502/*
503 * Initialize a lease, use the default lock manager operations
504 */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400505static int lease_init(struct file *filp, long type, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 {
Trond Myklebust75dff552006-05-07 23:02:42 -0400507 if (assign_type(fl, type) != 0)
508 return -EINVAL;
509
Jeff Layton7ca76312014-09-01 19:04:48 -0400510 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 fl->fl_pid = current->tgid;
512
513 fl->fl_file = filp;
514 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 fl->fl_start = 0;
516 fl->fl_end = OFFSET_MAX;
517 fl->fl_ops = NULL;
518 fl->fl_lmops = &lease_manager_ops;
519 return 0;
520}
521
522/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400523static struct file_lock *lease_alloc(struct file *filp, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524{
525 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400526 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527
528 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500529 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
531 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400532 if (error) {
533 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500534 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400535 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500536 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537}
538
539/* Check if two locks overlap each other.
540 */
541static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
542{
543 return ((fl1->fl_end >= fl2->fl_start) &&
544 (fl2->fl_end >= fl1->fl_start));
545}
546
547/*
548 * Check whether two locks have the same owner.
549 */
Matt Mackall33443c42006-01-08 01:05:22 -0800550static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551{
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400552 if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 return fl2->fl_lmops == fl1->fl_lmops &&
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400554 fl1->fl_lmops->lm_compare_owner(fl1, fl2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 return fl1->fl_owner == fl2->fl_owner;
556}
557
Jeff Layton7012b022013-06-21 08:58:22 -0400558/* Must be called with the i_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500559static void locks_insert_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400560{
Jeff Layton7012b022013-06-21 08:58:22 -0400561 lg_local_lock(&file_lock_lglock);
562 fl->fl_link_cpu = smp_processor_id();
563 hlist_add_head(&fl->fl_link, this_cpu_ptr(&file_lock_list));
564 lg_local_unlock(&file_lock_lglock);
Jeff Layton88974692013-06-21 08:58:14 -0400565}
566
Jeff Layton7012b022013-06-21 08:58:22 -0400567/* Must be called with the i_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500568static void locks_delete_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400569{
Jeff Layton7012b022013-06-21 08:58:22 -0400570 /*
571 * Avoid taking lock if already unhashed. This is safe since this check
572 * is done while holding the i_lock, and new insertions into the list
573 * also require that it be held.
574 */
575 if (hlist_unhashed(&fl->fl_link))
576 return;
577 lg_local_lock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton139ca042013-06-21 08:58:17 -0400578 hlist_del_init(&fl->fl_link);
Jeff Layton7012b022013-06-21 08:58:22 -0400579 lg_local_unlock_cpu(&file_lock_lglock, fl->fl_link_cpu);
Jeff Layton88974692013-06-21 08:58:14 -0400580}
581
Jeff Layton3999e492013-06-21 08:58:19 -0400582static unsigned long
583posix_owner_key(struct file_lock *fl)
584{
585 if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
586 return fl->fl_lmops->lm_owner_key(fl);
587 return (unsigned long)fl->fl_owner;
588}
589
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500590static void locks_insert_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400591{
Jeff Layton3999e492013-06-21 08:58:19 -0400592 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
Jeff Layton88974692013-06-21 08:58:14 -0400593}
594
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500595static void locks_delete_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400596{
Jeff Layton48f74182013-06-21 08:58:18 -0400597 hash_del(&waiter->fl_link);
Jeff Layton88974692013-06-21 08:58:14 -0400598}
599
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600/* Remove waiter from blocker's block list.
601 * When blocker ends up pointing to itself then the list is empty.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400602 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400603 * Must be called with blocked_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 */
Matt Mackall33443c42006-01-08 01:05:22 -0800605static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606{
Jeff Layton88974692013-06-21 08:58:14 -0400607 locks_delete_global_blocked(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 list_del_init(&waiter->fl_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 waiter->fl_next = NULL;
610}
611
Jeff Layton1a9e64a2013-06-21 08:58:10 -0400612static void locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400614 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 __locks_delete_block(waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400616 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617}
618
619/* Insert waiter into blocker's block list.
620 * We use a circular list so that processes can be easily woken up in
621 * the order they blocked. The documentation doesn't require this but
622 * it seems like the reasonable thing to do.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400623 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400624 * Must be called with both the i_lock and blocked_lock_lock held. The fl_block
Jeff Layton46dad762014-02-03 12:13:06 -0500625 * list itself is protected by the blocked_lock_lock, but by ensuring that the
Jeff Layton7b2296a2013-06-21 08:58:20 -0400626 * i_lock is also held on insertions we can avoid taking the blocked_lock_lock
Jeff Layton4e8c7652013-06-21 08:58:16 -0400627 * in some cases when we see that the fl_block list is empty.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400629static void __locks_insert_block(struct file_lock *blocker,
630 struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631{
J. Bruce Fields6dc0fe82006-03-26 01:37:24 -0800632 BUG_ON(!list_empty(&waiter->fl_block));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 waiter->fl_next = blocker;
Jeff Layton88974692013-06-21 08:58:14 -0400634 list_add_tail(&waiter->fl_block, &blocker->fl_block);
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400635 if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400636 locks_insert_global_blocked(waiter);
637}
638
639/* Must be called with i_lock held. */
640static void locks_insert_block(struct file_lock *blocker,
641 struct file_lock *waiter)
642{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400643 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400644 __locks_insert_block(blocker, waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400645 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646}
647
Jeff Layton1cb36012013-06-21 08:58:12 -0400648/*
649 * Wake up processes blocked waiting for blocker.
650 *
Jeff Layton1c8c6012013-06-21 08:58:15 -0400651 * Must be called with the inode->i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 */
653static void locks_wake_up_blocks(struct file_lock *blocker)
654{
Jeff Layton4e8c7652013-06-21 08:58:16 -0400655 /*
656 * Avoid taking global lock if list is empty. This is safe since new
657 * blocked requests are only added to the list under the i_lock, and
658 * the i_lock is always held here. Note that removal from the fl_block
659 * list does not require the i_lock, so we must recheck list_empty()
Jeff Layton7b2296a2013-06-21 08:58:20 -0400660 * after acquiring the blocked_lock_lock.
Jeff Layton4e8c7652013-06-21 08:58:16 -0400661 */
662 if (list_empty(&blocker->fl_block))
663 return;
664
Jeff Layton7b2296a2013-06-21 08:58:20 -0400665 spin_lock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 while (!list_empty(&blocker->fl_block)) {
Pavel Emelyanovf0c1cd02007-09-19 16:44:07 +0400667 struct file_lock *waiter;
668
669 waiter = list_first_entry(&blocker->fl_block,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 struct file_lock, fl_block);
671 __locks_delete_block(waiter);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400672 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
673 waiter->fl_lmops->lm_notify(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 else
675 wake_up(&waiter->fl_wait);
676 }
Jeff Layton7b2296a2013-06-21 08:58:20 -0400677 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678}
679
680/* Insert file lock fl into an inode's lock list at the position indicated
681 * by pos. At the same time add the lock to the global file lock list.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400682 *
683 * Must be called with the i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 */
685static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
686{
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000687 fl->fl_nspid = get_pid(task_tgid(current));
688
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 /* insert into file's list */
690 fl->fl_next = *pos;
691 *pos = fl;
Jeff Layton88974692013-06-21 08:58:14 -0400692
693 locks_insert_global_locks(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694}
695
Jeff Layton5263e312015-01-16 15:05:55 -0500696static void
697locks_insert_lock_ctx(struct file_lock *fl, struct list_head *before)
698{
699 fl->fl_nspid = get_pid(task_tgid(current));
700 list_add_tail(&fl->fl_list, before);
701 locks_insert_global_locks(fl);
702}
703
Jeff Layton24cbe782014-02-03 12:13:06 -0500704/**
705 * locks_delete_lock - Delete a lock and then free it.
706 * @thisfl_p: pointer that points to the fl_next field of the previous
707 * inode->i_flock list entry
708 *
709 * Unlink a lock from all lists and free the namespace reference, but don't
710 * free it yet. Wake up processes that are blocked waiting for this lock and
711 * notify the FS that the lock has been cleared.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400712 *
713 * Must be called with the i_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 */
Jeff Layton24cbe782014-02-03 12:13:06 -0500715static void locks_unlink_lock(struct file_lock **thisfl_p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716{
717 struct file_lock *fl = *thisfl_p;
718
Jeff Layton88974692013-06-21 08:58:14 -0400719 locks_delete_global_locks(fl);
720
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 *thisfl_p = fl->fl_next;
722 fl->fl_next = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000724 if (fl->fl_nspid) {
725 put_pid(fl->fl_nspid);
726 fl->fl_nspid = NULL;
727 }
728
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 locks_wake_up_blocks(fl);
Jeff Layton24cbe782014-02-03 12:13:06 -0500730}
731
732/*
733 * Unlink a lock from all lists and free it.
734 *
735 * Must be called with i_lock held!
736 */
Jeff Laytoned9814d2014-08-11 14:20:31 -0400737static void locks_delete_lock(struct file_lock **thisfl_p,
738 struct list_head *dispose)
Jeff Layton24cbe782014-02-03 12:13:06 -0500739{
740 struct file_lock *fl = *thisfl_p;
741
742 locks_unlink_lock(thisfl_p);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400743 if (dispose)
Jeff Layton6dee60f2015-01-16 15:05:54 -0500744 list_add(&fl->fl_list, dispose);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400745 else
746 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747}
748
Jeff Layton5263e312015-01-16 15:05:55 -0500749static void
750locks_delete_lock_ctx(struct file_lock *fl, struct list_head *dispose)
751{
752 locks_delete_global_locks(fl);
753 if (fl->fl_nspid) {
754 put_pid(fl->fl_nspid);
755 fl->fl_nspid = NULL;
756 }
757 locks_wake_up_blocks(fl);
758 list_move(&fl->fl_list, dispose);
759}
760
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
762 * checks for shared/exclusive status of overlapping locks.
763 */
764static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
765{
766 if (sys_fl->fl_type == F_WRLCK)
767 return 1;
768 if (caller_fl->fl_type == F_WRLCK)
769 return 1;
770 return 0;
771}
772
773/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
774 * checking before calling the locks_conflict().
775 */
776static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
777{
778 /* POSIX locks owned by the same process do not conflict with
779 * each other.
780 */
781 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
782 return (0);
783
784 /* Check whether they overlap */
785 if (!locks_overlap(caller_fl, sys_fl))
786 return 0;
787
788 return (locks_conflict(caller_fl, sys_fl));
789}
790
791/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
792 * checking before calling the locks_conflict().
793 */
794static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
795{
796 /* FLOCK locks referring to the same filp do not conflict with
797 * each other.
798 */
799 if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
800 return (0);
801 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
802 return 0;
803
804 return (locks_conflict(caller_fl, sys_fl));
805}
806
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400807void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500808posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809{
810 struct file_lock *cfl;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500811 struct file_lock_context *ctx;
Jeff Layton1c8c6012013-06-21 08:58:15 -0400812 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500814 ctx = inode->i_flctx;
815 if (!ctx || list_empty_careful(&ctx->flc_posix)) {
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400816 fl->fl_type = F_UNLCK;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500817 return;
818 }
819
820 spin_lock(&inode->i_lock);
821 list_for_each_entry(cfl, &ctx->flc_posix, fl_list) {
822 if (posix_locks_conflict(fl, cfl)) {
823 locks_copy_conflock(fl, cfl);
824 if (cfl->fl_nspid)
825 fl->fl_pid = pid_vnr(cfl->fl_nspid);
826 goto out;
827 }
828 }
829 fl->fl_type = F_UNLCK;
830out:
Jeff Layton1c8c6012013-06-21 08:58:15 -0400831 spin_unlock(&inode->i_lock);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400832 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834EXPORT_SYMBOL(posix_test_lock);
835
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400836/*
837 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400839 * We attempt to detect deadlocks that are due purely to posix file
840 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400842 * We assume that a task can be waiting for at most one lock at a time.
843 * So for any acquired lock, the process holding that lock may be
844 * waiting on at most one other lock. That lock in turns may be held by
845 * someone waiting for at most one other lock. Given a requested lock
846 * caller_fl which is about to wait for a conflicting lock block_fl, we
847 * follow this chain of waiters to ensure we are not about to create a
848 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400849 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400850 * Since we do this before we ever put a process to sleep on a lock, we
851 * are ensured that there is never a cycle; that is what guarantees that
852 * the while() loop in posix_locks_deadlock() eventually completes.
853 *
854 * Note: the above assumption may not be true when handling lock
855 * requests from a broken NFS client. It may also fail in the presence
856 * of tasks (such as posix threads) sharing the same open file table.
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400857 * To handle those cases, we just bail out after a few iterations.
Jeff Layton57b65322014-02-03 12:13:09 -0500858 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400859 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
Jeff Layton57b65322014-02-03 12:13:09 -0500860 * Because the owner is not even nominally tied to a thread of
861 * execution, the deadlock detection below can't reasonably work well. Just
862 * skip it for those.
863 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400864 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
Jeff Layton57b65322014-02-03 12:13:09 -0500865 * locks that just checks for the case where two tasks are attempting to
866 * upgrade from read to write locks on the same inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400868
869#define MAX_DEADLK_ITERATIONS 10
870
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400871/* Find a lock that the owner of the given block_fl is blocking on. */
872static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
873{
874 struct file_lock *fl;
875
Jeff Layton3999e492013-06-21 08:58:19 -0400876 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400877 if (posix_same_owner(fl, block_fl))
878 return fl->fl_next;
879 }
880 return NULL;
881}
882
Jeff Layton7b2296a2013-06-21 08:58:20 -0400883/* Must be called with the blocked_lock_lock held! */
Adrian Bunkb0904e12006-06-23 02:05:13 -0700884static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 struct file_lock *block_fl)
886{
J. Bruce Fields97855b42007-10-30 11:20:02 -0400887 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888
Jeff Layton57b65322014-02-03 12:13:09 -0500889 /*
890 * This deadlock detector can't reasonably detect deadlocks with
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400891 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
Jeff Layton57b65322014-02-03 12:13:09 -0500892 */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400893 if (IS_OFDLCK(caller_fl))
Jeff Layton57b65322014-02-03 12:13:09 -0500894 return 0;
895
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400896 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
897 if (i++ > MAX_DEADLK_ITERATIONS)
898 return 0;
899 if (posix_same_owner(caller_fl, block_fl))
900 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 }
902 return 0;
903}
904
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -0400906 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -0400907 *
908 * Note that if called with an FL_EXISTS argument, the caller may determine
909 * whether or not a lock was successfully freed by testing the return
910 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 */
Trond Myklebust993dfa82006-03-31 02:30:55 -0800912static int flock_lock_file(struct file *filp, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913{
Trond Myklebust993dfa82006-03-31 02:30:55 -0800914 struct file_lock *new_fl = NULL;
Jeff Layton5263e312015-01-16 15:05:55 -0500915 struct file_lock *fl;
916 struct file_lock_context *ctx;
917 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 int error = 0;
Jeff Layton5263e312015-01-16 15:05:55 -0500919 bool found = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -0400920 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
Jeff Layton5263e312015-01-16 15:05:55 -0500922 ctx = locks_get_lock_context(inode);
923 if (!ctx)
924 return -ENOMEM;
925
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200926 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
927 new_fl = locks_alloc_lock();
928 if (!new_fl)
929 return -ENOMEM;
930 }
931
Jeff Layton1c8c6012013-06-21 08:58:15 -0400932 spin_lock(&inode->i_lock);
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400933 if (request->fl_flags & FL_ACCESS)
934 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +0400935
Jeff Layton5263e312015-01-16 15:05:55 -0500936 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 if (filp != fl->fl_file)
938 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800939 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 goto out;
Jeff Layton5263e312015-01-16 15:05:55 -0500941 found = true;
942 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 break;
944 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945
Trond Myklebustf475ae92006-06-29 16:38:32 -0400946 if (request->fl_type == F_UNLCK) {
947 if ((request->fl_flags & FL_EXISTS) && !found)
948 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800949 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400950 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951
952 /*
953 * If a higher-priority process was blocked on the old file lock,
954 * give it the opportunity to lock the file.
955 */
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200956 if (found) {
Jeff Layton1c8c6012013-06-21 08:58:15 -0400957 spin_unlock(&inode->i_lock);
Frederic Weisbeckerdef01bc2009-07-16 15:44:29 +0200958 cond_resched();
Jeff Layton1c8c6012013-06-21 08:58:15 -0400959 spin_lock(&inode->i_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200960 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400962find_conflict:
Jeff Layton5263e312015-01-16 15:05:55 -0500963 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Trond Myklebust993dfa82006-03-31 02:30:55 -0800964 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 continue;
966 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700967 if (!(request->fl_flags & FL_SLEEP))
968 goto out;
969 error = FILE_LOCK_DEFERRED;
970 locks_insert_block(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 goto out;
972 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400973 if (request->fl_flags & FL_ACCESS)
974 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800975 locks_copy_lock(new_fl, request);
Jeff Layton5263e312015-01-16 15:05:55 -0500976 locks_insert_lock_ctx(new_fl, &ctx->flc_flock);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800977 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +0400978 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979
980out:
Jeff Layton1c8c6012013-06-21 08:58:15 -0400981 spin_unlock(&inode->i_lock);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800982 if (new_fl)
983 locks_free_lock(new_fl);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400984 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 return error;
986}
987
Marc Eshel150b3932007-01-18 16:15:35 -0500988static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500990 struct file_lock *fl, *tmp;
Miklos Szeredi39005d02006-06-23 02:05:10 -0700991 struct file_lock *new_fl = NULL;
992 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 struct file_lock *left = NULL;
994 struct file_lock *right = NULL;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500995 struct file_lock_context *ctx;
Jeff Laytonb9746ef2013-06-21 08:58:13 -0400996 int error;
997 bool added = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -0400998 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001000 ctx = locks_get_lock_context(inode);
1001 if (!ctx)
1002 return -ENOMEM;
1003
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 /*
1005 * We may need two file_lock structures for this operation,
1006 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -07001007 *
1008 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 */
Miklos Szeredi39005d02006-06-23 02:05:10 -07001010 if (!(request->fl_flags & FL_ACCESS) &&
1011 (request->fl_type != F_UNLCK ||
1012 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
1013 new_fl = locks_alloc_lock();
1014 new_fl2 = locks_alloc_lock();
1015 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016
Jeff Layton1c8c6012013-06-21 08:58:15 -04001017 spin_lock(&inode->i_lock);
Jeff Layton1cb36012013-06-21 08:58:12 -04001018 /*
1019 * New lock request. Walk all POSIX locks and look for conflicts. If
1020 * there are any, either return error or put the request on the
Jeff Layton48f74182013-06-21 08:58:18 -04001021 * blocker's list of waiters and the global blocked_hash.
Jeff Layton1cb36012013-06-21 08:58:12 -04001022 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 if (request->fl_type != F_UNLCK) {
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001024 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 if (!IS_POSIX(fl))
1026 continue;
1027 if (!posix_locks_conflict(request, fl))
1028 continue;
Andy Adamson5842add2006-03-26 01:37:26 -08001029 if (conflock)
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001030 locks_copy_conflock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 error = -EAGAIN;
1032 if (!(request->fl_flags & FL_SLEEP))
1033 goto out;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001034 /*
1035 * Deadlock detection and insertion into the blocked
1036 * locks list must be done while holding the same lock!
1037 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 error = -EDEADLK;
Jeff Layton7b2296a2013-06-21 08:58:20 -04001039 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001040 if (likely(!posix_locks_deadlock(request, fl))) {
1041 error = FILE_LOCK_DEFERRED;
1042 __locks_insert_block(fl, request);
1043 }
Jeff Layton7b2296a2013-06-21 08:58:20 -04001044 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 goto out;
1046 }
1047 }
1048
1049 /* If we're just looking for a conflict, we're done. */
1050 error = 0;
1051 if (request->fl_flags & FL_ACCESS)
1052 goto out;
1053
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001054 /* Find the first old lock with the same owner as the new lock */
1055 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1056 if (posix_same_owner(request, fl))
1057 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 }
1059
Jeff Layton1cb36012013-06-21 08:58:12 -04001060 /* Process locks with this owner. */
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001061 list_for_each_entry_safe_from(fl, tmp, &ctx->flc_posix, fl_list) {
1062 if (!posix_same_owner(request, fl))
1063 break;
1064
1065 /* Detect adjacent or overlapping regions (if same lock type) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -07001067 /* In all comparisons of start vs end, use
1068 * "start - 1" rather than "end + 1". If end
1069 * is OFFSET_MAX, end + 1 will become negative.
1070 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 if (fl->fl_end < request->fl_start - 1)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001072 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 /* If the next lock in the list has entirely bigger
1074 * addresses than the new one, insert the lock here.
1075 */
Olaf Kirch449231d2005-08-25 16:25:35 -07001076 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 break;
1078
1079 /* If we come here, the new and old lock are of the
1080 * same type and adjacent or overlapping. Make one
1081 * lock yielding from the lower start address of both
1082 * locks to the higher end address.
1083 */
1084 if (fl->fl_start > request->fl_start)
1085 fl->fl_start = request->fl_start;
1086 else
1087 request->fl_start = fl->fl_start;
1088 if (fl->fl_end < request->fl_end)
1089 fl->fl_end = request->fl_end;
1090 else
1091 request->fl_end = fl->fl_end;
1092 if (added) {
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001093 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 continue;
1095 }
1096 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001097 added = true;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001098 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 /* Processing for different lock types is a bit
1100 * more complex.
1101 */
1102 if (fl->fl_end < request->fl_start)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001103 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 if (fl->fl_start > request->fl_end)
1105 break;
1106 if (request->fl_type == F_UNLCK)
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001107 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 if (fl->fl_start < request->fl_start)
1109 left = fl;
1110 /* If the next lock in the list has a higher end
1111 * address than the new one, insert the new one here.
1112 */
1113 if (fl->fl_end > request->fl_end) {
1114 right = fl;
1115 break;
1116 }
1117 if (fl->fl_start >= request->fl_start) {
1118 /* The new lock completely replaces an old
1119 * one (This may happen several times).
1120 */
1121 if (added) {
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001122 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 continue;
1124 }
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001125 /*
1126 * Replace the old lock with new_fl, and
1127 * remove the old one. It's safe to do the
1128 * insert here since we know that we won't be
1129 * using new_fl later, and that the lock is
1130 * just replacing an existing lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131 */
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001132 error = -ENOLCK;
1133 if (!new_fl)
1134 goto out;
1135 locks_copy_lock(new_fl, request);
1136 request = new_fl;
1137 new_fl = NULL;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001138 locks_insert_lock_ctx(request, &fl->fl_list);
1139 locks_delete_lock_ctx(fl, &dispose);
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001140 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 }
1142 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143 }
1144
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001145 /*
Jeff Layton1cb36012013-06-21 08:58:12 -04001146 * The above code only modifies existing locks in case of merging or
1147 * replacing. If new lock(s) need to be inserted all modifications are
1148 * done below this, so it's safe yet to bail out.
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001149 */
1150 error = -ENOLCK; /* "no luck" */
1151 if (right && left == right && !new_fl2)
1152 goto out;
1153
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 error = 0;
1155 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -04001156 if (request->fl_type == F_UNLCK) {
1157 if (request->fl_flags & FL_EXISTS)
1158 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001160 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001161
1162 if (!new_fl) {
1163 error = -ENOLCK;
1164 goto out;
1165 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 locks_copy_lock(new_fl, request);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001167 locks_insert_lock_ctx(new_fl, &fl->fl_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 new_fl = NULL;
1169 }
1170 if (right) {
1171 if (left == right) {
1172 /* The new lock breaks the old one in two pieces,
1173 * so we have to use the second new lock.
1174 */
1175 left = new_fl2;
1176 new_fl2 = NULL;
1177 locks_copy_lock(left, right);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001178 locks_insert_lock_ctx(left, &fl->fl_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 }
1180 right->fl_start = request->fl_end + 1;
1181 locks_wake_up_blocks(right);
1182 }
1183 if (left) {
1184 left->fl_end = request->fl_start - 1;
1185 locks_wake_up_blocks(left);
1186 }
1187 out:
Jeff Layton1c8c6012013-06-21 08:58:15 -04001188 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 /*
1190 * Free any unused locks.
1191 */
1192 if (new_fl)
1193 locks_free_lock(new_fl);
1194 if (new_fl2)
1195 locks_free_lock(new_fl2);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001196 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 return error;
1198}
1199
1200/**
1201 * posix_lock_file - Apply a POSIX-style lock to a file
1202 * @filp: The file to apply the lock to
1203 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001204 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 *
1206 * Add a POSIX style lock to a file.
1207 * We merge adjacent & overlapping locks whenever possible.
1208 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001209 *
1210 * Note that if called with an FL_EXISTS argument, the caller may determine
1211 * whether or not a lock was successfully freed by testing the return
1212 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 */
Marc Eshel150b3932007-01-18 16:15:35 -05001214int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001215 struct file_lock *conflock)
1216{
Al Viro496ad9a2013-01-23 17:07:38 -05001217 return __posix_lock_file(file_inode(filp), fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001218}
Marc Eshel150b3932007-01-18 16:15:35 -05001219EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220
1221/**
1222 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1223 * @filp: The file to apply the lock to
1224 * @fl: The lock to be applied
1225 *
1226 * Add a POSIX style lock to a file.
1227 * We merge adjacent & overlapping locks whenever possible.
1228 * POSIX locks are sorted by owner task, then by starting address
1229 */
1230int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1231{
1232 int error;
1233 might_sleep ();
1234 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001235 error = posix_lock_file(filp, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001236 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 break;
1238 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1239 if (!error)
1240 continue;
1241
1242 locks_delete_block(fl);
1243 break;
1244 }
1245 return error;
1246}
1247EXPORT_SYMBOL(posix_lock_file_wait);
1248
1249/**
1250 * locks_mandatory_locked - Check for an active lock
Jeff Laytond7a06982014-03-10 09:54:15 -04001251 * @file: the file to check
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 *
1253 * Searches the inode's list of locks to find any POSIX locks which conflict.
1254 * This function is called from locks_verify_locked() only.
1255 */
Jeff Laytond7a06982014-03-10 09:54:15 -04001256int locks_mandatory_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001258 int ret;
Jeff Laytond7a06982014-03-10 09:54:15 -04001259 struct inode *inode = file_inode(file);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001260 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 struct file_lock *fl;
1262
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001263 ctx = inode->i_flctx;
1264 if (!ctx || list_empty_careful(&ctx->flc_posix))
1265 return 0;
1266
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 /*
1268 * Search the lock list for this inode for any POSIX locks.
1269 */
Jeff Layton1c8c6012013-06-21 08:58:15 -04001270 spin_lock(&inode->i_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001271 ret = 0;
1272 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001273 if (fl->fl_owner != current->files &&
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001274 fl->fl_owner != file) {
1275 ret = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 break;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001277 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04001279 spin_unlock(&inode->i_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001280 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281}
1282
1283/**
1284 * locks_mandatory_area - Check for a conflicting lock
1285 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1286 * for shared
1287 * @inode: the file to check
1288 * @filp: how the file was opened (if it was)
1289 * @offset: start of area to check
1290 * @count: length of area to check
1291 *
1292 * Searches the inode's list of locks to find any POSIX locks which conflict.
1293 * This function is called from rw_verify_area() and
1294 * locks_verify_truncate().
1295 */
1296int locks_mandatory_area(int read_write, struct inode *inode,
1297 struct file *filp, loff_t offset,
1298 size_t count)
1299{
1300 struct file_lock fl;
1301 int error;
Jeff Layton29723ad2014-03-10 09:54:19 -04001302 bool sleep = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303
1304 locks_init_lock(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305 fl.fl_pid = current->tgid;
1306 fl.fl_file = filp;
1307 fl.fl_flags = FL_POSIX | FL_ACCESS;
1308 if (filp && !(filp->f_flags & O_NONBLOCK))
Jeff Layton29723ad2014-03-10 09:54:19 -04001309 sleep = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1311 fl.fl_start = offset;
1312 fl.fl_end = offset + count - 1;
1313
1314 for (;;) {
Jeff Layton29723ad2014-03-10 09:54:19 -04001315 if (filp) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001316 fl.fl_owner = filp;
Jeff Layton29723ad2014-03-10 09:54:19 -04001317 fl.fl_flags &= ~FL_SLEEP;
1318 error = __posix_lock_file(inode, &fl, NULL);
1319 if (!error)
1320 break;
1321 }
1322
1323 if (sleep)
1324 fl.fl_flags |= FL_SLEEP;
1325 fl.fl_owner = current->files;
Marc Eshel150b3932007-01-18 16:15:35 -05001326 error = __posix_lock_file(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001327 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 break;
1329 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1330 if (!error) {
1331 /*
1332 * If we've been sleeping someone might have
1333 * changed the permissions behind our back.
1334 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001335 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 continue;
1337 }
1338
1339 locks_delete_block(&fl);
1340 break;
1341 }
1342
1343 return error;
1344}
1345
1346EXPORT_SYMBOL(locks_mandatory_area);
1347
J. Bruce Fields778fc542011-07-26 18:25:49 -04001348static void lease_clear_pending(struct file_lock *fl, int arg)
1349{
1350 switch (arg) {
1351 case F_UNLCK:
1352 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1353 /* fall through: */
1354 case F_RDLCK:
1355 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1356 }
1357}
1358
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359/* We already had a lease on this file; just change its type */
Jeff Laytonc45198e2014-09-01 07:12:07 -04001360int lease_modify(struct file_lock **before, int arg, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361{
1362 struct file_lock *fl = *before;
1363 int error = assign_type(fl, arg);
1364
1365 if (error)
1366 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001367 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001369 if (arg == F_UNLCK) {
1370 struct file *filp = fl->fl_file;
1371
1372 f_delown(filp);
1373 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001374 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1375 if (fl->fl_fasync != NULL) {
1376 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1377 fl->fl_fasync = NULL;
1378 }
Jeff Laytonc45198e2014-09-01 07:12:07 -04001379 locks_delete_lock(before, dispose);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001380 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 return 0;
1382}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383EXPORT_SYMBOL(lease_modify);
1384
J. Bruce Fields778fc542011-07-26 18:25:49 -04001385static bool past_time(unsigned long then)
1386{
1387 if (!then)
1388 /* 0 is a special value meaning "this never expires": */
1389 return false;
1390 return time_after(jiffies, then);
1391}
1392
Jeff Laytonc45198e2014-09-01 07:12:07 -04001393static void time_out_leases(struct inode *inode, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394{
1395 struct file_lock **before;
1396 struct file_lock *fl;
1397
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001398 lockdep_assert_held(&inode->i_lock);
1399
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 before = &inode->i_flock;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04001401 while ((fl = *before) && IS_LEASE(fl) && lease_breaking(fl)) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001402 trace_time_out_leases(inode, fl);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001403 if (past_time(fl->fl_downgrade_time))
Jeff Laytonc45198e2014-09-01 07:12:07 -04001404 lease_modify(before, F_RDLCK, dispose);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001405 if (past_time(fl->fl_break_time))
Jeff Laytonc45198e2014-09-01 07:12:07 -04001406 lease_modify(before, F_UNLCK, dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 if (fl == *before) /* lease_modify may have freed fl */
1408 before = &fl->fl_next;
1409 }
1410}
1411
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001412static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1413{
1414 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1415 return false;
1416 return locks_conflict(breaker, lease);
1417}
1418
Jeff Layton03d12dd2014-09-01 14:53:41 -04001419static bool
1420any_leases_conflict(struct inode *inode, struct file_lock *breaker)
1421{
1422 struct file_lock *fl;
1423
1424 lockdep_assert_held(&inode->i_lock);
1425
1426 for (fl = inode->i_flock ; fl && IS_LEASE(fl); fl = fl->fl_next) {
1427 if (leases_conflict(fl, breaker))
1428 return true;
1429 }
1430 return false;
1431}
1432
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433/**
1434 * __break_lease - revoke all outstanding leases on file
1435 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001436 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1437 * break all leases
1438 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1439 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 *
david m. richter87250dd2007-05-09 16:10:27 -04001441 * break_lease (inlined for speed) has checked there already is at least
1442 * some kind of lock (maybe a lease) on this file. Leases are broken on
1443 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 * specified %O_NONBLOCK to your open().
1445 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001446int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001448 int error = 0;
Jeff Layton03d12dd2014-09-01 14:53:41 -04001449 struct file_lock *new_fl;
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001450 struct file_lock *fl, **before;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 unsigned long break_time;
Al Viro8737c932009-12-24 06:47:55 -05001452 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001453 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454
Al Viro8737c932009-12-24 06:47:55 -05001455 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001456 if (IS_ERR(new_fl))
1457 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001458 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459
Jeff Layton1c8c6012013-06-21 08:58:15 -04001460 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461
Jeff Laytonc45198e2014-09-01 07:12:07 -04001462 time_out_leases(inode, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463
Jeff Layton03d12dd2014-09-01 14:53:41 -04001464 if (!any_leases_conflict(inode, new_fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001465 goto out;
1466
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 break_time = 0;
1468 if (lease_break_time > 0) {
1469 break_time = jiffies + lease_break_time * HZ;
1470 if (break_time == 0)
1471 break_time++; /* so that 0 means no break time */
1472 }
1473
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001474 for (before = &inode->i_flock;
1475 ((fl = *before) != NULL) && IS_LEASE(fl);
1476 before = &fl->fl_next) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001477 if (!leases_conflict(fl, new_fl))
1478 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001479 if (want_write) {
1480 if (fl->fl_flags & FL_UNLOCK_PENDING)
1481 continue;
1482 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001484 } else {
Jeff Layton03d12dd2014-09-01 14:53:41 -04001485 if (lease_breaking(inode->i_flock))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001486 continue;
1487 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1488 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 }
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001490 if (fl->fl_lmops->lm_break(fl))
1491 locks_delete_lock(before, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 }
1493
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001494 fl = inode->i_flock;
1495 if (!fl || !IS_LEASE(fl))
1496 goto out;
1497
Jeff Layton843c6b22014-09-01 14:27:43 -04001498 if (mode & O_NONBLOCK) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001499 trace_break_lease_noblock(inode, new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500 error = -EWOULDBLOCK;
1501 goto out;
1502 }
1503
1504restart:
Jeff Layton03d12dd2014-09-01 14:53:41 -04001505 break_time = inode->i_flock->fl_break_time;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001506 if (break_time != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 break_time -= jiffies;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001508 if (break_time == 0)
1509 break_time++;
Jeff Layton03d12dd2014-09-01 14:53:41 -04001510 locks_insert_block(inode->i_flock, new_fl);
Jeff Layton62af4f12014-05-09 14:13:05 -04001511 trace_break_lease_block(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001512 spin_unlock(&inode->i_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001513 locks_dispose_list(&dispose);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001514 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1515 !new_fl->fl_next, break_time);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001516 spin_lock(&inode->i_lock);
Jeff Layton62af4f12014-05-09 14:13:05 -04001517 trace_break_lease_unblock(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001518 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 if (error >= 0) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001520 /*
1521 * Wait for the next conflicting lease that has not been
1522 * broken yet
1523 */
Jeff Layton03d12dd2014-09-01 14:53:41 -04001524 if (error == 0)
1525 time_out_leases(inode, &dispose);
1526 if (any_leases_conflict(inode, new_fl))
1527 goto restart;
1528
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 error = 0;
1530 }
1531
1532out:
Jeff Layton1c8c6012013-06-21 08:58:15 -04001533 spin_unlock(&inode->i_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001534 locks_dispose_list(&dispose);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001535 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536 return error;
1537}
1538
1539EXPORT_SYMBOL(__break_lease);
1540
1541/**
Randy Dunlapa6b91912008-03-19 17:01:00 -07001542 * lease_get_mtime - get the last modified time of an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 * @inode: the inode
1544 * @time: pointer to a timespec which will contain the last modified time
1545 *
1546 * This is to force NFS clients to flush their caches for files with
1547 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001548 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 */
1550void lease_get_mtime(struct inode *inode, struct timespec *time)
1551{
Jeff Laytonbfe86022014-08-22 10:18:44 -04001552 bool has_lease = false;
1553 struct file_lock *flock;
1554
1555 if (inode->i_flock) {
1556 spin_lock(&inode->i_lock);
1557 flock = inode->i_flock;
1558 if (flock && IS_LEASE(flock) && (flock->fl_type == F_WRLCK))
1559 has_lease = true;
1560 spin_unlock(&inode->i_lock);
1561 }
1562
1563 if (has_lease)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 *time = current_fs_time(inode->i_sb);
1565 else
1566 *time = inode->i_mtime;
1567}
1568
1569EXPORT_SYMBOL(lease_get_mtime);
1570
1571/**
1572 * fcntl_getlease - Enquire what lease is currently active
1573 * @filp: the file
1574 *
1575 * The value returned by this function will be one of
1576 * (if no lease break is pending):
1577 *
1578 * %F_RDLCK to indicate a shared lease is held.
1579 *
1580 * %F_WRLCK to indicate an exclusive lease is held.
1581 *
1582 * %F_UNLCK to indicate no lease is held.
1583 *
1584 * (if a lease break is pending):
1585 *
1586 * %F_RDLCK to indicate an exclusive lease needs to be
1587 * changed to a shared lease (or removed).
1588 *
1589 * %F_UNLCK to indicate the lease needs to be removed.
1590 *
1591 * XXX: sfr & willy disagree over whether F_INPROGRESS
1592 * should be returned to userspace.
1593 */
1594int fcntl_getlease(struct file *filp)
1595{
1596 struct file_lock *fl;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001597 struct inode *inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 int type = F_UNLCK;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001599 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600
Jeff Layton1c8c6012013-06-21 08:58:15 -04001601 spin_lock(&inode->i_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001602 time_out_leases(file_inode(filp), &dispose);
Al Viro496ad9a2013-01-23 17:07:38 -05001603 for (fl = file_inode(filp)->i_flock; fl && IS_LEASE(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 fl = fl->fl_next) {
1605 if (fl->fl_file == filp) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001606 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 break;
1608 }
1609 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04001610 spin_unlock(&inode->i_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001611 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 return type;
1613}
1614
Jeff Layton24cbe782014-02-03 12:13:06 -05001615/**
1616 * check_conflicting_open - see if the given dentry points to a file that has
1617 * an existing open that would conflict with the
1618 * desired lease.
1619 * @dentry: dentry to check
1620 * @arg: type of lease that we're trying to acquire
1621 *
1622 * Check to see if there's an existing open fd on this file that would
1623 * conflict with the lease we're trying to set.
1624 */
1625static int
1626check_conflicting_open(const struct dentry *dentry, const long arg)
1627{
1628 int ret = 0;
1629 struct inode *inode = dentry->d_inode;
1630
1631 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1632 return -EAGAIN;
1633
1634 if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1635 (atomic_read(&inode->i_count) > 1)))
1636 ret = -EAGAIN;
1637
1638 return ret;
1639}
1640
Jeff Laytone6f5c782014-08-22 10:40:25 -04001641static int
1642generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643{
KAMBAROV, ZAUR7eaae282005-07-07 17:57:06 -07001644 struct file_lock *fl, **before, **my_before = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001645 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 struct inode *inode = dentry->d_inode;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001647 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001648 int error;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001649 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650
J. Bruce Fields096657b2010-10-30 17:31:14 -04001651 lease = *flp;
Jeff Layton62af4f12014-05-09 14:13:05 -04001652 trace_generic_add_lease(inode, lease);
1653
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001654 /*
1655 * In the delegation case we need mutual exclusion with
1656 * a number of operations that take the i_mutex. We trylock
1657 * because delegations are an optional optimization, and if
1658 * there's some chance of a conflict--we'd rather not
1659 * bother, maybe that's a sign this just isn't a good file to
1660 * hand out a delegation on.
1661 */
1662 if (is_deleg && !mutex_trylock(&inode->i_mutex))
1663 return -EAGAIN;
1664
1665 if (is_deleg && arg == F_WRLCK) {
1666 /* Write delegations are not currently supported: */
Dan Carpenter4fdb7932013-11-13 10:56:27 +03001667 mutex_unlock(&inode->i_mutex);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001668 WARN_ON_ONCE(1);
1669 return -EINVAL;
1670 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001671
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001672 spin_lock(&inode->i_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001673 time_out_leases(inode, &dispose);
Jeff Layton24cbe782014-02-03 12:13:06 -05001674 error = check_conflicting_open(dentry, arg);
1675 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001676 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001677
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 /*
1679 * At this point, we know that if there is an exclusive
1680 * lease on this file, then we hold it on this filp
1681 * (otherwise our open of this file would have blocked).
1682 * And if we are trying to acquire an exclusive lease,
1683 * then the file is not open by anyone (including us)
1684 * except for this filp.
1685 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001686 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687 for (before = &inode->i_flock;
1688 ((fl = *before) != NULL) && IS_LEASE(fl);
1689 before = &fl->fl_next) {
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001690 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 my_before = before;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001692 continue;
1693 }
1694 /*
1695 * No exclusive leases if someone else has a lease on
1696 * this file:
1697 */
1698 if (arg == F_WRLCK)
1699 goto out;
1700 /*
1701 * Modifying our existing lease is OK, but no getting a
1702 * new lease if someone else is opening for write:
1703 */
1704 if (fl->fl_flags & FL_UNLOCK_PENDING)
1705 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 }
1707
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 if (my_before != NULL) {
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001709 lease = *my_before;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001710 error = lease->fl_lmops->lm_change(my_before, arg, &dispose);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001711 if (error)
1712 goto out;
1713 goto out_setup;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714 }
1715
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 error = -EINVAL;
1717 if (!leases_enable)
1718 goto out;
1719
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001720 locks_insert_lock(before, lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001721 /*
1722 * The check in break_lease() is lockless. It's possible for another
1723 * open to race in after we did the earlier check for a conflicting
1724 * open but before the lease was inserted. Check again for a
1725 * conflicting open and cancel the lease if there is one.
1726 *
1727 * We also add a barrier here to ensure that the insertion of the lock
1728 * precedes these checks.
1729 */
1730 smp_mb();
1731 error = check_conflicting_open(dentry, arg);
1732 if (error)
Jeff Laytone6f5c782014-08-22 10:40:25 -04001733 goto out_unlink;
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001734
1735out_setup:
1736 if (lease->fl_lmops->lm_setup)
1737 lease->fl_lmops->lm_setup(lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738out:
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001739 spin_unlock(&inode->i_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001740 locks_dispose_list(&dispose);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001741 if (is_deleg)
1742 mutex_unlock(&inode->i_mutex);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001743 if (!error && !my_before)
1744 *flp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 return error;
Jeff Laytone6f5c782014-08-22 10:40:25 -04001746out_unlink:
1747 locks_unlink_lock(before);
1748 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001750
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001751static int generic_delete_lease(struct file *filp)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001752{
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001753 int error = -EAGAIN;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001754 struct file_lock *fl, **before;
1755 struct dentry *dentry = filp->f_path.dentry;
1756 struct inode *inode = dentry->d_inode;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001757 LIST_HEAD(dispose);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001758
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001759 spin_lock(&inode->i_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001760 time_out_leases(inode, &dispose);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001761 for (before = &inode->i_flock;
1762 ((fl = *before) != NULL) && IS_LEASE(fl);
1763 before = &fl->fl_next) {
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001764 if (fl->fl_file == filp)
1765 break;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001766 }
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001767 trace_generic_delete_lease(inode, fl);
NeilBrown52d304e2015-01-13 15:17:43 +13001768 if (fl && IS_LEASE(fl))
Jeff Laytonc45198e2014-09-01 07:12:07 -04001769 error = fl->fl_lmops->lm_change(before, F_UNLCK, &dispose);
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001770 spin_unlock(&inode->i_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001771 locks_dispose_list(&dispose);
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001772 return error;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001773}
1774
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775/**
1776 * generic_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001777 * @filp: file pointer
1778 * @arg: type of lease to obtain
1779 * @flp: input - file_lock to use, output - file_lock inserted
1780 * @priv: private data for lm_setup (may be NULL if lm_setup
1781 * doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 *
1783 * The (input) flp->fl_lmops->lm_break function is required
1784 * by break_lease().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001786int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
1787 void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 struct dentry *dentry = filp->f_path.dentry;
1790 struct inode *inode = dentry->d_inode;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001791 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001793 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001794 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001796 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 error = security_file_lock(filp, arg);
1798 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001799 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001801 switch (arg) {
1802 case F_UNLCK:
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001803 return generic_delete_lease(filp);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001804 case F_RDLCK:
1805 case F_WRLCK:
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001806 if (!(*flp)->fl_lmops->lm_break) {
1807 WARN_ON_ONCE(1);
1808 return -ENOLCK;
1809 }
Jeff Laytone6f5c782014-08-22 10:40:25 -04001810 return generic_add_lease(filp, arg, flp, priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001811 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001812 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001815EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001817/**
Jeff Laytone51673a2014-08-22 18:13:28 -04001818 * vfs_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001819 * @filp: file pointer
1820 * @arg: type of lease to obtain
1821 * @lease: file_lock to use when adding a lease
1822 * @priv: private info for lm_setup when adding a lease (may be
1823 * NULL if lm_setup doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 *
Jeff Laytone51673a2014-08-22 18:13:28 -04001825 * Call this to establish a lease on the file. The "lease" argument is not
1826 * used for F_UNLCK requests and may be NULL. For commands that set or alter
1827 * an existing lease, the (*lease)->fl_lmops->lm_break operation must be set;
1828 * if not, this function will return -ENOLCK (and generate a scary-looking
1829 * stack trace).
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001830 *
1831 * The "priv" pointer is passed directly to the lm_setup function as-is. It
1832 * may be NULL if the lm_setup operation doesn't require it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001834int
1835vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836{
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001837 if (filp->f_op->setlease)
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001838 return filp->f_op->setlease(filp, arg, lease, priv);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001839 else
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001840 return generic_setlease(filp, arg, lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001842EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001844static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845{
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001846 struct file_lock *fl;
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001847 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848 int error;
1849
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001850 fl = lease_alloc(filp, arg);
1851 if (IS_ERR(fl))
1852 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001854 new = fasync_alloc();
1855 if (!new) {
1856 locks_free_lock(fl);
1857 return -ENOMEM;
1858 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001859 new->fa_fd = fd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001861 error = vfs_setlease(filp, arg, &fl, (void **)&new);
Jeff Layton2dfb9282014-08-11 18:14:12 -04001862 if (fl)
1863 locks_free_lock(fl);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001864 if (new)
1865 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 return error;
1867}
1868
1869/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001870 * fcntl_setlease - sets a lease on an open file
1871 * @fd: open file descriptor
1872 * @filp: file pointer
1873 * @arg: type of lease to obtain
1874 *
1875 * Call this fcntl to establish a lease on the file.
1876 * Note that you also need to call %F_SETSIG to
1877 * receive a signal when the lease is broken.
1878 */
1879int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1880{
1881 if (arg == F_UNLCK)
Jeff Laytone6f5c782014-08-22 10:40:25 -04001882 return vfs_setlease(filp, F_UNLCK, NULL, NULL);
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001883 return do_fcntl_add_lease(fd, filp, arg);
1884}
1885
1886/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1888 * @filp: The file to apply the lock to
1889 * @fl: The lock to be applied
1890 *
1891 * Add a FLOCK style lock to a file.
1892 */
1893int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1894{
1895 int error;
1896 might_sleep();
1897 for (;;) {
1898 error = flock_lock_file(filp, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001899 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900 break;
1901 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1902 if (!error)
1903 continue;
1904
1905 locks_delete_block(fl);
1906 break;
1907 }
1908 return error;
1909}
1910
1911EXPORT_SYMBOL(flock_lock_file_wait);
1912
1913/**
1914 * sys_flock: - flock() system call.
1915 * @fd: the file descriptor to lock.
1916 * @cmd: the type of lock to apply.
1917 *
1918 * Apply a %FL_FLOCK style lock to an open file descriptor.
1919 * The @cmd can be one of
1920 *
1921 * %LOCK_SH -- a shared lock.
1922 *
1923 * %LOCK_EX -- an exclusive lock.
1924 *
1925 * %LOCK_UN -- remove an existing lock.
1926 *
1927 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1928 *
1929 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1930 * processes read and write access respectively.
1931 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001932SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933{
Al Viro2903ff02012-08-28 12:52:22 -04001934 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 struct file_lock *lock;
1936 int can_sleep, unlock;
1937 int error;
1938
1939 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001940 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 goto out;
1942
1943 can_sleep = !(cmd & LOCK_NB);
1944 cmd &= ~LOCK_NB;
1945 unlock = (cmd == LOCK_UN);
1946
Al Viroaeb5d722008-09-02 15:28:45 -04001947 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04001948 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 goto out_putf;
1950
Jeff Layton6e129d002014-09-04 10:25:06 -04001951 lock = flock_make_lock(f.file, cmd);
1952 if (IS_ERR(lock)) {
1953 error = PTR_ERR(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 goto out_putf;
Jeff Layton6e129d002014-09-04 10:25:06 -04001955 }
1956
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 if (can_sleep)
1958 lock->fl_flags |= FL_SLEEP;
1959
Al Viro2903ff02012-08-28 12:52:22 -04001960 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 if (error)
1962 goto out_free;
1963
Al Viro72c2d532013-09-22 16:27:52 -04001964 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04001965 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966 (can_sleep) ? F_SETLKW : F_SETLK,
1967 lock);
1968 else
Al Viro2903ff02012-08-28 12:52:22 -04001969 error = flock_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970
1971 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08001972 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973
1974 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04001975 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976 out:
1977 return error;
1978}
1979
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001980/**
1981 * vfs_test_lock - test file byte range lock
1982 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04001983 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001984 *
1985 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1986 * setting conf->fl_type to something other than F_UNLCK.
1987 */
1988int vfs_test_lock(struct file *filp, struct file_lock *fl)
1989{
Al Viro72c2d532013-09-22 16:27:52 -04001990 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001991 return filp->f_op->lock(filp, F_GETLK, fl);
1992 posix_test_lock(filp, fl);
1993 return 0;
1994}
1995EXPORT_SYMBOL_GPL(vfs_test_lock);
1996
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001997static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1998{
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001999 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002000#if BITS_PER_LONG == 32
2001 /*
2002 * Make sure we can represent the posix lock via
2003 * legacy 32bit flock.
2004 */
2005 if (fl->fl_start > OFFT_OFFSET_MAX)
2006 return -EOVERFLOW;
2007 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
2008 return -EOVERFLOW;
2009#endif
2010 flock->l_start = fl->fl_start;
2011 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2012 fl->fl_end - fl->fl_start + 1;
2013 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04002014 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002015 return 0;
2016}
2017
2018#if BITS_PER_LONG == 32
2019static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
2020{
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002021 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002022 flock->l_start = fl->fl_start;
2023 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2024 fl->fl_end - fl->fl_start + 1;
2025 flock->l_whence = 0;
2026 flock->l_type = fl->fl_type;
2027}
2028#endif
2029
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030/* Report the first existing lock that would conflict with l.
2031 * This implements the F_GETLK command of fcntl().
2032 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05002033int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002035 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036 struct flock flock;
2037 int error;
2038
2039 error = -EFAULT;
2040 if (copy_from_user(&flock, l, sizeof(flock)))
2041 goto out;
2042 error = -EINVAL;
2043 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2044 goto out;
2045
2046 error = flock_to_posix_lock(filp, &file_lock, &flock);
2047 if (error)
2048 goto out;
2049
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002050 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002051 error = -EINVAL;
2052 if (flock.l_pid != 0)
2053 goto out;
2054
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002055 cmd = F_GETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002056 file_lock.fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002057 file_lock.fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002058 }
2059
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002060 error = vfs_test_lock(filp, &file_lock);
2061 if (error)
2062 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002064 flock.l_type = file_lock.fl_type;
2065 if (file_lock.fl_type != F_UNLCK) {
2066 error = posix_lock_to_flock(&flock, &file_lock);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002067 if (error)
Kinglong Meef3282962014-08-22 10:18:43 -04002068 goto rel_priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069 }
2070 error = -EFAULT;
2071 if (!copy_to_user(l, &flock, sizeof(flock)))
2072 error = 0;
Kinglong Meef3282962014-08-22 10:18:43 -04002073rel_priv:
2074 locks_release_private(&file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075out:
2076 return error;
2077}
2078
Marc Eshel7723ec92007-01-18 15:08:55 -05002079/**
2080 * vfs_lock_file - file byte range lock
2081 * @filp: The file to apply the lock to
2082 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2083 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05002084 * @conf: Place to return a copy of the conflicting lock, if found.
2085 *
2086 * A caller that doesn't care about the conflicting lock may pass NULL
2087 * as the final argument.
2088 *
2089 * If the filesystem defines a private ->lock() method, then @conf will
2090 * be left unchanged; so a caller that cares should initialize it to
2091 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05002092 *
2093 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2094 * locks, the ->lock() interface may return asynchronously, before the lock has
2095 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002096 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05002097 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2098 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002099 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05002100 * request completes.
2101 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07002102 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2103 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05002104 * nonzero return code and the file system should release the lock. The file
2105 * system is also responsible to keep a corresponding posix lock when it
2106 * grants a lock so the VFS can find out which locks are locally held and do
2107 * the correct lock cleanup when required.
2108 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002109 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05002110 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05002111 */
Marc Eshel150b3932007-01-18 16:15:35 -05002112int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05002113{
Al Viro72c2d532013-09-22 16:27:52 -04002114 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05002115 return filp->f_op->lock(filp, cmd, fl);
2116 else
Marc Eshel150b3932007-01-18 16:15:35 -05002117 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05002118}
2119EXPORT_SYMBOL_GPL(vfs_lock_file);
2120
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002121static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2122 struct file_lock *fl)
2123{
2124 int error;
2125
2126 error = security_file_lock(filp, fl->fl_type);
2127 if (error)
2128 return error;
2129
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002130 for (;;) {
2131 error = vfs_lock_file(filp, cmd, fl, NULL);
2132 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002133 break;
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002134 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
2135 if (!error)
2136 continue;
2137
2138 locks_delete_block(fl);
2139 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002140 }
2141
2142 return error;
2143}
2144
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002145/* Ensure that fl->fl_filp has compatible f_mode for F_SETLK calls */
2146static int
2147check_fmode_for_setlk(struct file_lock *fl)
2148{
2149 switch (fl->fl_type) {
2150 case F_RDLCK:
2151 if (!(fl->fl_file->f_mode & FMODE_READ))
2152 return -EBADF;
2153 break;
2154 case F_WRLCK:
2155 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2156 return -EBADF;
2157 }
2158 return 0;
2159}
2160
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161/* Apply the lock described by l to an open file descriptor.
2162 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2163 */
Peter Staubachc2936212005-07-27 11:45:09 -07002164int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
2165 struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166{
2167 struct file_lock *file_lock = locks_alloc_lock();
2168 struct flock flock;
2169 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002170 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 int error;
2172
2173 if (file_lock == NULL)
2174 return -ENOLCK;
2175
2176 /*
2177 * This might block, so we do it before checking the inode.
2178 */
2179 error = -EFAULT;
2180 if (copy_from_user(&flock, l, sizeof(flock)))
2181 goto out;
2182
Al Viro496ad9a2013-01-23 17:07:38 -05002183 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184
2185 /* Don't allow mandatory locks on files that may be memory mapped
2186 * and shared.
2187 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002188 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 error = -EAGAIN;
2190 goto out;
2191 }
2192
Peter Staubachc2936212005-07-27 11:45:09 -07002193again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 error = flock_to_posix_lock(filp, file_lock, &flock);
2195 if (error)
2196 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002197
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002198 error = check_fmode_for_setlk(file_lock);
2199 if (error)
2200 goto out;
2201
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002202 /*
2203 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002204 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002205 */
2206 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002207 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002208 error = -EINVAL;
2209 if (flock.l_pid != 0)
2210 goto out;
2211
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002212 cmd = F_SETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002213 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002214 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002215 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002216 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002217 error = -EINVAL;
2218 if (flock.l_pid != 0)
2219 goto out;
2220
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002221 cmd = F_SETLKW;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002222 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002223 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002224 /* Fallthrough */
2225 case F_SETLKW:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 file_lock->fl_flags |= FL_SLEEP;
2227 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002228
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002229 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230
Peter Staubachc2936212005-07-27 11:45:09 -07002231 /*
2232 * Attempt to detect a close/fcntl race and recover by
2233 * releasing the lock that was just acquired.
2234 */
Al Viro0b2bac22008-05-06 13:58:34 -04002235 /*
2236 * we need that spin_lock here - it prevents reordering between
2237 * update of inode->i_flock and check for it done in close().
2238 * rcu_read_lock() wouldn't do.
2239 */
2240 spin_lock(&current->files->file_lock);
2241 f = fcheck(fd);
2242 spin_unlock(&current->files->file_lock);
2243 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002244 flock.l_type = F_UNLCK;
2245 goto again;
2246 }
2247
2248out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249 locks_free_lock(file_lock);
2250 return error;
2251}
2252
2253#if BITS_PER_LONG == 32
2254/* Report the first existing lock that would conflict with l.
2255 * This implements the F_GETLK command of fcntl().
2256 */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05002257int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002259 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 struct flock64 flock;
2261 int error;
2262
2263 error = -EFAULT;
2264 if (copy_from_user(&flock, l, sizeof(flock)))
2265 goto out;
2266 error = -EINVAL;
2267 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2268 goto out;
2269
2270 error = flock64_to_posix_lock(filp, &file_lock, &flock);
2271 if (error)
2272 goto out;
2273
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002274 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002275 error = -EINVAL;
2276 if (flock.l_pid != 0)
2277 goto out;
2278
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002279 cmd = F_GETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002280 file_lock.fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002281 file_lock.fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002282 }
2283
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002284 error = vfs_test_lock(filp, &file_lock);
2285 if (error)
2286 goto out;
2287
Marc Eshel9d6a8c52007-02-21 00:55:18 -05002288 flock.l_type = file_lock.fl_type;
2289 if (file_lock.fl_type != F_UNLCK)
2290 posix_lock_to_flock64(&flock, &file_lock);
2291
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 error = -EFAULT;
2293 if (!copy_to_user(l, &flock, sizeof(flock)))
2294 error = 0;
Kinglong Meef3282962014-08-22 10:18:43 -04002295
2296 locks_release_private(&file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297out:
2298 return error;
2299}
2300
2301/* Apply the lock described by l to an open file descriptor.
2302 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2303 */
Peter Staubachc2936212005-07-27 11:45:09 -07002304int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2305 struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306{
2307 struct file_lock *file_lock = locks_alloc_lock();
2308 struct flock64 flock;
2309 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04002310 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311 int error;
2312
2313 if (file_lock == NULL)
2314 return -ENOLCK;
2315
2316 /*
2317 * This might block, so we do it before checking the inode.
2318 */
2319 error = -EFAULT;
2320 if (copy_from_user(&flock, l, sizeof(flock)))
2321 goto out;
2322
Al Viro496ad9a2013-01-23 17:07:38 -05002323 inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324
2325 /* Don't allow mandatory locks on files that may be memory mapped
2326 * and shared.
2327 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002328 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 error = -EAGAIN;
2330 goto out;
2331 }
2332
Peter Staubachc2936212005-07-27 11:45:09 -07002333again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 error = flock64_to_posix_lock(filp, file_lock, &flock);
2335 if (error)
2336 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002337
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002338 error = check_fmode_for_setlk(file_lock);
2339 if (error)
2340 goto out;
2341
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002342 /*
2343 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002344 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002345 */
2346 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002347 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002348 error = -EINVAL;
2349 if (flock.l_pid != 0)
2350 goto out;
2351
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002352 cmd = F_SETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002353 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002354 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002355 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002356 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002357 error = -EINVAL;
2358 if (flock.l_pid != 0)
2359 goto out;
2360
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002361 cmd = F_SETLKW64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002362 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002363 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002364 /* Fallthrough */
2365 case F_SETLKW64:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366 file_lock->fl_flags |= FL_SLEEP;
2367 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002368
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002369 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370
Peter Staubachc2936212005-07-27 11:45:09 -07002371 /*
2372 * Attempt to detect a close/fcntl race and recover by
2373 * releasing the lock that was just acquired.
2374 */
Al Viro0b2bac22008-05-06 13:58:34 -04002375 spin_lock(&current->files->file_lock);
2376 f = fcheck(fd);
2377 spin_unlock(&current->files->file_lock);
2378 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002379 flock.l_type = F_UNLCK;
2380 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 }
2382
2383out:
2384 locks_free_lock(file_lock);
2385 return error;
2386}
2387#endif /* BITS_PER_LONG == 32 */
2388
2389/*
2390 * This function is called when the file is being removed
2391 * from the task's fd array. POSIX locks belonging to this task
2392 * are deleted at this time.
2393 */
2394void locks_remove_posix(struct file *filp, fl_owner_t owner)
2395{
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002396 struct file_lock lock;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05002397 struct file_lock_context *ctx = file_inode(filp)->i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398
2399 /*
2400 * If there are no locks held on this file, we don't need to call
2401 * posix_lock_file(). Another process could be setting a lock on this
2402 * file at the same time, but we wouldn't remove that lock anyway.
2403 */
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05002404 if (!ctx || list_empty(&ctx->flc_posix))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405 return;
2406
2407 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002408 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 lock.fl_start = 0;
2410 lock.fl_end = OFFSET_MAX;
2411 lock.fl_owner = owner;
2412 lock.fl_pid = current->tgid;
2413 lock.fl_file = filp;
2414 lock.fl_ops = NULL;
2415 lock.fl_lmops = NULL;
2416
Marc Eshel150b3932007-01-18 16:15:35 -05002417 vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2420 lock.fl_ops->fl_release_private(&lock);
2421}
2422
2423EXPORT_SYMBOL(locks_remove_posix);
2424
Jeff Laytondd459bb2015-01-16 15:05:54 -05002425static void
2426locks_remove_flock(struct file *filp)
2427{
2428 struct file_lock fl = {
2429 .fl_owner = filp,
2430 .fl_pid = current->tgid,
2431 .fl_file = filp,
2432 .fl_flags = FL_FLOCK,
2433 .fl_type = F_UNLCK,
2434 .fl_end = OFFSET_MAX,
2435 };
Jeff Layton5263e312015-01-16 15:05:55 -05002436 struct file_lock_context *flctx = file_inode(filp)->i_flctx;
Jeff Laytondd459bb2015-01-16 15:05:54 -05002437
Jeff Layton5263e312015-01-16 15:05:55 -05002438 if (!flctx || list_empty(&flctx->flc_flock))
Jeff Laytondd459bb2015-01-16 15:05:54 -05002439 return;
2440
2441 if (filp->f_op->flock)
2442 filp->f_op->flock(filp, F_SETLKW, &fl);
2443 else
2444 flock_lock_file(filp, &fl);
2445
2446 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2447 fl.fl_ops->fl_release_private(&fl);
2448}
2449
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450/*
2451 * This function is called on the last close of an open file.
2452 */
Jeff Layton78ed8a12014-02-03 12:13:08 -05002453void locks_remove_file(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454{
Al Viro496ad9a2013-01-23 17:07:38 -05002455 struct inode * inode = file_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456 struct file_lock *fl;
2457 struct file_lock **before;
Jeff Laytoned9814d2014-08-11 14:20:31 -04002458 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459
Jeff Laytondd459bb2015-01-16 15:05:54 -05002460 /* remove any OFD locks */
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002461 locks_remove_posix(filp, filp);
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002462
Jeff Laytondd459bb2015-01-16 15:05:54 -05002463 /* remove flock locks */
2464 locks_remove_flock(filp);
2465
2466 if (!inode->i_flock)
2467 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468
Jeff Layton1c8c6012013-06-21 08:58:15 -04002469 spin_lock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470 before = &inode->i_flock;
2471
2472 while ((fl = *before) != NULL) {
2473 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474 if (IS_LEASE(fl)) {
Jeff Laytonc45198e2014-09-01 07:12:07 -04002475 lease_modify(before, F_UNLCK, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 continue;
2477 }
Jeff Layton8c3cac52014-02-03 12:13:07 -05002478
2479 /*
2480 * There's a leftover lock on the list of a type that
2481 * we didn't expect to see. Most likely a classic
2482 * POSIX lock that ended up not getting released
2483 * properly, or that raced onto the list somehow. Log
2484 * some info about it and then just remove it from
2485 * the list.
2486 */
Jeff Laytondd459bb2015-01-16 15:05:54 -05002487 WARN(1, "leftover lock: dev=%u:%u ino=%lu type=%hhd flags=0x%x start=%lld end=%lld\n",
Jeff Layton8c3cac52014-02-03 12:13:07 -05002488 MAJOR(inode->i_sb->s_dev),
2489 MINOR(inode->i_sb->s_dev), inode->i_ino,
2490 fl->fl_type, fl->fl_flags,
2491 fl->fl_start, fl->fl_end);
2492
Jeff Laytoned9814d2014-08-11 14:20:31 -04002493 locks_delete_lock(before, &dispose);
Jeff Layton8c3cac52014-02-03 12:13:07 -05002494 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002495 }
2496 before = &fl->fl_next;
2497 }
Jeff Layton1c8c6012013-06-21 08:58:15 -04002498 spin_unlock(&inode->i_lock);
Jeff Laytoned9814d2014-08-11 14:20:31 -04002499 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002500}
2501
2502/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002503 * posix_unblock_lock - stop waiting for a file lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504 * @waiter: the lock which was waiting
2505 *
2506 * lockd needs to block waiting for locks.
2507 */
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002508int
Jeff Laytonf891a292013-06-21 08:58:09 -04002509posix_unblock_lock(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510{
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002511 int status = 0;
2512
Jeff Layton7b2296a2013-06-21 08:58:20 -04002513 spin_lock(&blocked_lock_lock);
J. Bruce Fields5996a292006-01-03 09:55:44 +01002514 if (waiter->fl_next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515 __locks_delete_block(waiter);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002516 else
2517 status = -ENOENT;
Jeff Layton7b2296a2013-06-21 08:58:20 -04002518 spin_unlock(&blocked_lock_lock);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002519 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521EXPORT_SYMBOL(posix_unblock_lock);
2522
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002523/**
2524 * vfs_cancel_lock - file byte range unblock lock
2525 * @filp: The file to apply the unblock to
2526 * @fl: The lock to be unblocked
2527 *
2528 * Used by lock managers to cancel blocked requests
2529 */
2530int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2531{
Al Viro72c2d532013-09-22 16:27:52 -04002532 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002533 return filp->f_op->lock(filp, F_CANCELLK, fl);
2534 return 0;
2535}
2536
2537EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2538
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002539#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002540#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002541#include <linux/seq_file.h>
2542
Jeff Layton7012b022013-06-21 08:58:22 -04002543struct locks_iterator {
2544 int li_cpu;
2545 loff_t li_pos;
2546};
2547
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002548static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002549 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550{
2551 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002552 unsigned int fl_pid;
2553
2554 if (fl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -08002555 fl_pid = pid_vnr(fl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002556 else
2557 fl_pid = fl->fl_pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558
2559 if (fl->fl_file != NULL)
Al Viro496ad9a2013-01-23 17:07:38 -05002560 inode = file_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002561
Jerome Marchand99dc8292010-10-26 14:22:33 -07002562 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563 if (IS_POSIX(fl)) {
Jeff Laytonc918d422014-02-03 12:13:09 -05002564 if (fl->fl_flags & FL_ACCESS)
Fabian Frederick5315c262014-05-09 14:13:05 -04002565 seq_puts(f, "ACCESS");
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002566 else if (IS_OFDLCK(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002567 seq_puts(f, "OFDLCK");
Jeff Laytonc918d422014-02-03 12:13:09 -05002568 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002569 seq_puts(f, "POSIX ");
Jeff Laytonc918d422014-02-03 12:13:09 -05002570
2571 seq_printf(f, " %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002573 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574 } else if (IS_FLOCK(fl)) {
2575 if (fl->fl_type & LOCK_MAND) {
Fabian Frederick5315c262014-05-09 14:13:05 -04002576 seq_puts(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002577 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002578 seq_puts(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002579 }
2580 } else if (IS_LEASE(fl)) {
Jeff Layton8144f1f2014-08-11 13:36:54 -04002581 if (fl->fl_flags & FL_DELEG)
2582 seq_puts(f, "DELEG ");
2583 else
2584 seq_puts(f, "LEASE ");
2585
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002586 if (lease_breaking(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002587 seq_puts(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588 else if (fl->fl_file)
Fabian Frederick5315c262014-05-09 14:13:05 -04002589 seq_puts(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002590 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002591 seq_puts(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002592 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002593 seq_puts(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002594 }
2595 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002596 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002597 (fl->fl_type & LOCK_READ)
2598 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2599 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2600 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002601 seq_printf(f, "%s ",
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002602 (lease_breaking(fl))
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04002603 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2604 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002605 }
2606 if (inode) {
2607#ifdef WE_CAN_BREAK_LSLK_NOW
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002608 seq_printf(f, "%d %s:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609 inode->i_sb->s_id, inode->i_ino);
2610#else
2611 /* userspace relies on this representation of dev_t ;-( */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002612 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613 MAJOR(inode->i_sb->s_dev),
2614 MINOR(inode->i_sb->s_dev), inode->i_ino);
2615#endif
2616 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002617 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002618 }
2619 if (IS_POSIX(fl)) {
2620 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002621 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002623 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002624 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002625 seq_puts(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626 }
2627}
2628
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002629static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002630{
Jeff Layton7012b022013-06-21 08:58:22 -04002631 struct locks_iterator *iter = f->private;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002632 struct file_lock *fl, *bfl;
2633
Jeff Layton139ca042013-06-21 08:58:17 -04002634 fl = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002635
Jeff Layton7012b022013-06-21 08:58:22 -04002636 lock_get_status(f, fl, iter->li_pos, "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002637
2638 list_for_each_entry(bfl, &fl->fl_block, fl_block)
Jeff Layton7012b022013-06-21 08:58:22 -04002639 lock_get_status(f, bfl, iter->li_pos, " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002640
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002641 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002642}
2643
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002644static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002645 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002646{
Jeff Layton7012b022013-06-21 08:58:22 -04002647 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002648
Jeff Layton7012b022013-06-21 08:58:22 -04002649 iter->li_pos = *pos + 1;
2650 lg_global_lock(&file_lock_lglock);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002651 spin_lock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002652 return seq_hlist_start_percpu(&file_lock_list, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002653}
2654
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002655static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2656{
Jeff Layton7012b022013-06-21 08:58:22 -04002657 struct locks_iterator *iter = f->private;
2658
2659 ++iter->li_pos;
2660 return seq_hlist_next_percpu(v, &file_lock_list, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002661}
2662
2663static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002664 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002665{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002666 spin_unlock(&blocked_lock_lock);
Jeff Layton7012b022013-06-21 08:58:22 -04002667 lg_global_unlock(&file_lock_lglock);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002668}
2669
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002670static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002671 .start = locks_start,
2672 .next = locks_next,
2673 .stop = locks_stop,
2674 .show = locks_show,
2675};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002676
2677static int locks_open(struct inode *inode, struct file *filp)
2678{
Jeff Layton7012b022013-06-21 08:58:22 -04002679 return seq_open_private(filp, &locks_seq_operations,
2680 sizeof(struct locks_iterator));
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002681}
2682
2683static const struct file_operations proc_locks_operations = {
2684 .open = locks_open,
2685 .read = seq_read,
2686 .llseek = seq_lseek,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002687 .release = seq_release_private,
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002688};
2689
2690static int __init proc_locks_init(void)
2691{
2692 proc_create("locks", 0, NULL, &proc_locks_operations);
2693 return 0;
2694}
2695module_init(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002696#endif
2697
Linus Torvalds1da177e2005-04-16 15:20:36 -07002698static int __init filelock_init(void)
2699{
Jeff Layton7012b022013-06-21 08:58:22 -04002700 int i;
2701
Jeff Layton4a075e32015-01-16 15:05:54 -05002702 flctx_cache = kmem_cache_create("file_lock_ctx",
2703 sizeof(struct file_lock_context), 0, SLAB_PANIC, NULL);
2704
Linus Torvalds1da177e2005-04-16 15:20:36 -07002705 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002706 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2707
Jeff Layton7012b022013-06-21 08:58:22 -04002708 lg_lock_init(&file_lock_lglock, "file_lock_lglock");
2709
2710 for_each_possible_cpu(i)
2711 INIT_HLIST_HEAD(per_cpu_ptr(&file_lock_list, i));
2712
Linus Torvalds1da177e2005-04-16 15:20:36 -07002713 return 0;
2714}
2715
2716core_initcall(filelock_init);