blob: 86668dd211ae07384d80235a111b832936e31a90 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130#include <asm/uaccess.h>
131
132#define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
133#define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
134#define IS_LEASE(fl) (fl->fl_flags & FL_LEASE)
135
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400136static bool lease_breaking(struct file_lock *fl)
137{
J. Bruce Fields778fc542011-07-26 18:25:49 -0400138 return fl->fl_flags & (FL_UNLOCK_PENDING | FL_DOWNGRADE_PENDING);
139}
140
141static int target_leasetype(struct file_lock *fl)
142{
143 if (fl->fl_flags & FL_UNLOCK_PENDING)
144 return F_UNLCK;
145 if (fl->fl_flags & FL_DOWNGRADE_PENDING)
146 return F_RDLCK;
147 return fl->fl_type;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400148}
149
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150int leases_enable = 1;
151int lease_break_time = 45;
152
153#define for_each_lock(inode, lockp) \
154 for (lockp = &inode->i_flock; *lockp != NULL; lockp = &(*lockp)->fl_next)
155
Christoph Hellwig26bcbf92006-03-20 13:44:40 -0500156static LIST_HEAD(file_lock_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157static LIST_HEAD(blocked_list);
Arnd Bergmann72f98e72010-10-27 21:39:58 +0200158static DEFINE_SPINLOCK(file_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200160/*
161 * Protects the two list heads above, plus the inode->i_flock list
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200162 */
163void lock_flocks(void)
164{
Arnd Bergmann72f98e72010-10-27 21:39:58 +0200165 spin_lock(&file_lock_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200166}
167EXPORT_SYMBOL_GPL(lock_flocks);
168
169void unlock_flocks(void)
170{
Arnd Bergmann72f98e72010-10-27 21:39:58 +0200171 spin_unlock(&file_lock_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200172}
173EXPORT_SYMBOL_GPL(unlock_flocks);
174
Christoph Lametere18b8902006-12-06 20:33:20 -0800175static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
Miklos Szerediee19cc42011-07-07 13:06:09 +0200177static void locks_init_lock_heads(struct file_lock *fl)
Miklos Szeredia51cb912011-07-06 12:33:55 +0200178{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200179 INIT_LIST_HEAD(&fl->fl_link);
180 INIT_LIST_HEAD(&fl->fl_block);
181 init_waitqueue_head(&fl->fl_wait);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200182}
183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200185struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200187 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200188
189 if (fl)
Miklos Szerediee19cc42011-07-07 13:06:09 +0200190 locks_init_lock_heads(fl);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200191
192 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200194EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500196void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500197{
198 if (fl->fl_ops) {
199 if (fl->fl_ops->fl_release_private)
200 fl->fl_ops->fl_release_private(fl);
201 fl->fl_ops = NULL;
202 }
203 if (fl->fl_lmops) {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400204 if (fl->fl_lmops->lm_release_private)
205 fl->fl_lmops->lm_release_private(fl);
Trond Myklebust47831f32006-03-20 13:44:05 -0500206 fl->fl_lmops = NULL;
207 }
208
209}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500210EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500211
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212/* Free a lock which is not in use. */
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400213void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214{
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800215 BUG_ON(waitqueue_active(&fl->fl_wait));
216 BUG_ON(!list_empty(&fl->fl_block));
217 BUG_ON(!list_empty(&fl->fl_link));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Trond Myklebust47831f32006-03-20 13:44:05 -0500219 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 kmem_cache_free(filelock_cache, fl);
221}
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400222EXPORT_SYMBOL(locks_free_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
224void locks_init_lock(struct file_lock *fl)
225{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200226 memset(fl, 0, sizeof(struct file_lock));
227 locks_init_lock_heads(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228}
229
230EXPORT_SYMBOL(locks_init_lock);
231
Trond Myklebust47831f32006-03-20 13:44:05 -0500232static void locks_copy_private(struct file_lock *new, struct file_lock *fl)
233{
234 if (fl->fl_ops) {
235 if (fl->fl_ops->fl_copy_lock)
236 fl->fl_ops->fl_copy_lock(new, fl);
237 new->fl_ops = fl->fl_ops;
238 }
Christoph Hellwigbb8430a2010-10-31 08:35:31 -0400239 if (fl->fl_lmops)
Trond Myklebust47831f32006-03-20 13:44:05 -0500240 new->fl_lmops = fl->fl_lmops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500241}
242
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243/*
244 * Initialize a new lock from an existing file_lock structure.
245 */
J. Bruce Fields1a747ee2008-04-24 10:08:22 -0400246void __locks_copy_lock(struct file_lock *new, const struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247{
248 new->fl_owner = fl->fl_owner;
249 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500250 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 new->fl_flags = fl->fl_flags;
252 new->fl_type = fl->fl_type;
253 new->fl_start = fl->fl_start;
254 new->fl_end = fl->fl_end;
Trond Myklebust09969052006-03-20 13:44:38 -0500255 new->fl_ops = NULL;
256 new->fl_lmops = NULL;
257}
Roland Dreier3dd7b712008-04-25 15:32:51 -0700258EXPORT_SYMBOL(__locks_copy_lock);
Trond Myklebust09969052006-03-20 13:44:38 -0500259
260void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
261{
262 locks_release_private(new);
263
264 __locks_copy_lock(new, fl);
265 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 new->fl_ops = fl->fl_ops;
267 new->fl_lmops = fl->fl_lmops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500268
269 locks_copy_private(new, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270}
271
272EXPORT_SYMBOL(locks_copy_lock);
273
274static inline int flock_translate_cmd(int cmd) {
275 if (cmd & LOCK_MAND)
276 return cmd & (LOCK_MAND | LOCK_RW);
277 switch (cmd) {
278 case LOCK_SH:
279 return F_RDLCK;
280 case LOCK_EX:
281 return F_WRLCK;
282 case LOCK_UN:
283 return F_UNLCK;
284 }
285 return -EINVAL;
286}
287
288/* Fill in a file_lock structure with an appropriate FLOCK lock. */
289static int flock_make_lock(struct file *filp, struct file_lock **lock,
290 unsigned int cmd)
291{
292 struct file_lock *fl;
293 int type = flock_translate_cmd(cmd);
294 if (type < 0)
295 return type;
296
297 fl = locks_alloc_lock();
298 if (fl == NULL)
299 return -ENOMEM;
300
301 fl->fl_file = filp;
302 fl->fl_pid = current->tgid;
303 fl->fl_flags = FL_FLOCK;
304 fl->fl_type = type;
305 fl->fl_end = OFFSET_MAX;
306
307 *lock = fl;
308 return 0;
309}
310
311static int assign_type(struct file_lock *fl, int type)
312{
313 switch (type) {
314 case F_RDLCK:
315 case F_WRLCK:
316 case F_UNLCK:
317 fl->fl_type = type;
318 break;
319 default:
320 return -EINVAL;
321 }
322 return 0;
323}
324
325/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
326 * style lock.
327 */
328static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
329 struct flock *l)
330{
331 off_t start, end;
332
333 switch (l->l_whence) {
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700334 case SEEK_SET:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 start = 0;
336 break;
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700337 case SEEK_CUR:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 start = filp->f_pos;
339 break;
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700340 case SEEK_END:
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800341 start = i_size_read(filp->f_path.dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 break;
343 default:
344 return -EINVAL;
345 }
346
347 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
348 POSIX-2001 defines it. */
349 start += l->l_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 if (start < 0)
351 return -EINVAL;
Trond Myklebust4c780a42005-10-18 14:20:21 -0700352 fl->fl_end = OFFSET_MAX;
353 if (l->l_len > 0) {
354 end = start + l->l_len - 1;
355 fl->fl_end = end;
356 } else if (l->l_len < 0) {
357 end = start - 1;
358 fl->fl_end = end;
359 start += l->l_len;
360 if (start < 0)
361 return -EINVAL;
362 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 fl->fl_start = start; /* we record the absolute position */
Trond Myklebust4c780a42005-10-18 14:20:21 -0700364 if (fl->fl_end < fl->fl_start)
365 return -EOVERFLOW;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
367 fl->fl_owner = current->files;
368 fl->fl_pid = current->tgid;
369 fl->fl_file = filp;
370 fl->fl_flags = FL_POSIX;
371 fl->fl_ops = NULL;
372 fl->fl_lmops = NULL;
373
374 return assign_type(fl, l->l_type);
375}
376
377#if BITS_PER_LONG == 32
378static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
379 struct flock64 *l)
380{
381 loff_t start;
382
383 switch (l->l_whence) {
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700384 case SEEK_SET:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 start = 0;
386 break;
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700387 case SEEK_CUR:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 start = filp->f_pos;
389 break;
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700390 case SEEK_END:
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800391 start = i_size_read(filp->f_path.dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 break;
393 default:
394 return -EINVAL;
395 }
396
Trond Myklebust4c780a42005-10-18 14:20:21 -0700397 start += l->l_start;
398 if (start < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 return -EINVAL;
Trond Myklebust4c780a42005-10-18 14:20:21 -0700400 fl->fl_end = OFFSET_MAX;
401 if (l->l_len > 0) {
402 fl->fl_end = start + l->l_len - 1;
403 } else if (l->l_len < 0) {
404 fl->fl_end = start - 1;
405 start += l->l_len;
406 if (start < 0)
407 return -EINVAL;
408 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 fl->fl_start = start; /* we record the absolute position */
Trond Myklebust4c780a42005-10-18 14:20:21 -0700410 if (fl->fl_end < fl->fl_start)
411 return -EOVERFLOW;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
413 fl->fl_owner = current->files;
414 fl->fl_pid = current->tgid;
415 fl->fl_file = filp;
416 fl->fl_flags = FL_POSIX;
417 fl->fl_ops = NULL;
418 fl->fl_lmops = NULL;
419
Namhyung Kimf32cb532011-01-17 15:45:59 +0900420 return assign_type(fl, l->l_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421}
422#endif
423
424/* default lease lock manager operations */
425static void lease_break_callback(struct file_lock *fl)
426{
427 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
428}
429
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700430static const struct lock_manager_operations lease_manager_ops = {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400431 .lm_break = lease_break_callback,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400432 .lm_change = lease_modify,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433};
434
435/*
436 * Initialize a lease, use the default lock manager operations
437 */
438static int lease_init(struct file *filp, int type, struct file_lock *fl)
439 {
Trond Myklebust75dff552006-05-07 23:02:42 -0400440 if (assign_type(fl, type) != 0)
441 return -EINVAL;
442
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 fl->fl_owner = current->files;
444 fl->fl_pid = current->tgid;
445
446 fl->fl_file = filp;
447 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 fl->fl_start = 0;
449 fl->fl_end = OFFSET_MAX;
450 fl->fl_ops = NULL;
451 fl->fl_lmops = &lease_manager_ops;
452 return 0;
453}
454
455/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500456static struct file_lock *lease_alloc(struct file *filp, int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457{
458 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400459 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
461 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500462 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
464 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400465 if (error) {
466 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500467 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400468 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500469 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470}
471
472/* Check if two locks overlap each other.
473 */
474static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
475{
476 return ((fl1->fl_end >= fl2->fl_start) &&
477 (fl2->fl_end >= fl1->fl_start));
478}
479
480/*
481 * Check whether two locks have the same owner.
482 */
Matt Mackall33443c42006-01-08 01:05:22 -0800483static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484{
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400485 if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 return fl2->fl_lmops == fl1->fl_lmops &&
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400487 fl1->fl_lmops->lm_compare_owner(fl1, fl2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 return fl1->fl_owner == fl2->fl_owner;
489}
490
491/* Remove waiter from blocker's block list.
492 * When blocker ends up pointing to itself then the list is empty.
493 */
Matt Mackall33443c42006-01-08 01:05:22 -0800494static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495{
496 list_del_init(&waiter->fl_block);
497 list_del_init(&waiter->fl_link);
498 waiter->fl_next = NULL;
499}
500
501/*
502 */
Pavel Shilovsky66189be2012-03-28 21:56:19 +0400503void locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504{
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200505 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 __locks_delete_block(waiter);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200507 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508}
Pavel Shilovsky66189be2012-03-28 21:56:19 +0400509EXPORT_SYMBOL(locks_delete_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
511/* Insert waiter into blocker's block list.
512 * We use a circular list so that processes can be easily woken up in
513 * the order they blocked. The documentation doesn't require this but
514 * it seems like the reasonable thing to do.
515 */
516static void locks_insert_block(struct file_lock *blocker,
517 struct file_lock *waiter)
518{
J. Bruce Fields6dc0fe82006-03-26 01:37:24 -0800519 BUG_ON(!list_empty(&waiter->fl_block));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 list_add_tail(&waiter->fl_block, &blocker->fl_block);
521 waiter->fl_next = blocker;
522 if (IS_POSIX(blocker))
523 list_add(&waiter->fl_link, &blocked_list);
524}
525
526/* Wake up processes blocked waiting for blocker.
527 * If told to wait then schedule the processes until the block list
528 * is empty, otherwise empty the block list ourselves.
529 */
530static void locks_wake_up_blocks(struct file_lock *blocker)
531{
532 while (!list_empty(&blocker->fl_block)) {
Pavel Emelyanovf0c1cd02007-09-19 16:44:07 +0400533 struct file_lock *waiter;
534
535 waiter = list_first_entry(&blocker->fl_block,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 struct file_lock, fl_block);
537 __locks_delete_block(waiter);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400538 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
539 waiter->fl_lmops->lm_notify(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 else
541 wake_up(&waiter->fl_wait);
542 }
543}
544
545/* Insert file lock fl into an inode's lock list at the position indicated
546 * by pos. At the same time add the lock to the global file lock list.
547 */
548static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
549{
550 list_add(&fl->fl_link, &file_lock_list);
551
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000552 fl->fl_nspid = get_pid(task_tgid(current));
553
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 /* insert into file's list */
555 fl->fl_next = *pos;
556 *pos = fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557}
558
559/*
560 * Delete a lock and then free it.
561 * Wake up processes that are blocked waiting for this lock,
562 * notify the FS that the lock has been cleared and
563 * finally free the lock.
564 */
565static void locks_delete_lock(struct file_lock **thisfl_p)
566{
567 struct file_lock *fl = *thisfl_p;
568
569 *thisfl_p = fl->fl_next;
570 fl->fl_next = NULL;
571 list_del_init(&fl->fl_link);
572
573 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
574 if (fl->fl_fasync != NULL) {
575 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
576 fl->fl_fasync = NULL;
577 }
578
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000579 if (fl->fl_nspid) {
580 put_pid(fl->fl_nspid);
581 fl->fl_nspid = NULL;
582 }
583
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 locks_wake_up_blocks(fl);
585 locks_free_lock(fl);
586}
587
588/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
589 * checks for shared/exclusive status of overlapping locks.
590 */
591static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
592{
593 if (sys_fl->fl_type == F_WRLCK)
594 return 1;
595 if (caller_fl->fl_type == F_WRLCK)
596 return 1;
597 return 0;
598}
599
600/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
601 * checking before calling the locks_conflict().
602 */
603static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
604{
605 /* POSIX locks owned by the same process do not conflict with
606 * each other.
607 */
608 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
609 return (0);
610
611 /* Check whether they overlap */
612 if (!locks_overlap(caller_fl, sys_fl))
613 return 0;
614
615 return (locks_conflict(caller_fl, sys_fl));
616}
617
618/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
619 * checking before calling the locks_conflict().
620 */
621static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
622{
623 /* FLOCK locks referring to the same filp do not conflict with
624 * each other.
625 */
626 if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
627 return (0);
628 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
629 return 0;
630
631 return (locks_conflict(caller_fl, sys_fl));
632}
633
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400634void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500635posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636{
637 struct file_lock *cfl;
638
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200639 lock_flocks();
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800640 for (cfl = filp->f_path.dentry->d_inode->i_flock; cfl; cfl = cfl->fl_next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 if (!IS_POSIX(cfl))
642 continue;
J. Bruce Fieldsb842e242007-05-10 19:02:07 -0400643 if (posix_locks_conflict(fl, cfl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 break;
645 }
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000646 if (cfl) {
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500647 __locks_copy_lock(fl, cfl);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000648 if (cfl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -0800649 fl->fl_pid = pid_vnr(cfl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000650 } else
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400651 fl->fl_type = F_UNLCK;
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200652 unlock_flocks();
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400653 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655EXPORT_SYMBOL(posix_test_lock);
656
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400657/*
658 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400660 * We attempt to detect deadlocks that are due purely to posix file
661 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400663 * We assume that a task can be waiting for at most one lock at a time.
664 * So for any acquired lock, the process holding that lock may be
665 * waiting on at most one other lock. That lock in turns may be held by
666 * someone waiting for at most one other lock. Given a requested lock
667 * caller_fl which is about to wait for a conflicting lock block_fl, we
668 * follow this chain of waiters to ensure we are not about to create a
669 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400670 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400671 * Since we do this before we ever put a process to sleep on a lock, we
672 * are ensured that there is never a cycle; that is what guarantees that
673 * the while() loop in posix_locks_deadlock() eventually completes.
674 *
675 * Note: the above assumption may not be true when handling lock
676 * requests from a broken NFS client. It may also fail in the presence
677 * of tasks (such as posix threads) sharing the same open file table.
678 *
679 * To handle those cases, we just bail out after a few iterations.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400681
682#define MAX_DEADLK_ITERATIONS 10
683
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400684/* Find a lock that the owner of the given block_fl is blocking on. */
685static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
686{
687 struct file_lock *fl;
688
689 list_for_each_entry(fl, &blocked_list, fl_link) {
690 if (posix_same_owner(fl, block_fl))
691 return fl->fl_next;
692 }
693 return NULL;
694}
695
Adrian Bunkb0904e12006-06-23 02:05:13 -0700696static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 struct file_lock *block_fl)
698{
J. Bruce Fields97855b42007-10-30 11:20:02 -0400699 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400701 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
702 if (i++ > MAX_DEADLK_ITERATIONS)
703 return 0;
704 if (posix_same_owner(caller_fl, block_fl))
705 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 }
707 return 0;
708}
709
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -0400711 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -0400712 *
713 * Note that if called with an FL_EXISTS argument, the caller may determine
714 * whether or not a lock was successfully freed by testing the return
715 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 */
Trond Myklebust993dfa82006-03-31 02:30:55 -0800717static int flock_lock_file(struct file *filp, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718{
Trond Myklebust993dfa82006-03-31 02:30:55 -0800719 struct file_lock *new_fl = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 struct file_lock **before;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800721 struct inode * inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 int error = 0;
723 int found = 0;
724
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200725 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
726 new_fl = locks_alloc_lock();
727 if (!new_fl)
728 return -ENOMEM;
729 }
730
731 lock_flocks();
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400732 if (request->fl_flags & FL_ACCESS)
733 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +0400734
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 for_each_lock(inode, before) {
736 struct file_lock *fl = *before;
737 if (IS_POSIX(fl))
738 break;
739 if (IS_LEASE(fl))
740 continue;
741 if (filp != fl->fl_file)
742 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800743 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 goto out;
745 found = 1;
746 locks_delete_lock(before);
747 break;
748 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
Trond Myklebustf475ae92006-06-29 16:38:32 -0400750 if (request->fl_type == F_UNLCK) {
751 if ((request->fl_flags & FL_EXISTS) && !found)
752 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800753 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400754 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
756 /*
757 * If a higher-priority process was blocked on the old file lock,
758 * give it the opportunity to lock the file.
759 */
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200760 if (found) {
761 unlock_flocks();
Frederic Weisbeckerdef01bc2009-07-16 15:44:29 +0200762 cond_resched();
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200763 lock_flocks();
764 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400766find_conflict:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 for_each_lock(inode, before) {
768 struct file_lock *fl = *before;
769 if (IS_POSIX(fl))
770 break;
771 if (IS_LEASE(fl))
772 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800773 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 continue;
775 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700776 if (!(request->fl_flags & FL_SLEEP))
777 goto out;
778 error = FILE_LOCK_DEFERRED;
779 locks_insert_block(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 goto out;
781 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400782 if (request->fl_flags & FL_ACCESS)
783 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800784 locks_copy_lock(new_fl, request);
Pavel Emelyanov0e2f6db2007-09-11 15:24:01 -0700785 locks_insert_lock(before, new_fl);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800786 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +0400787 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788
789out:
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200790 unlock_flocks();
Trond Myklebust993dfa82006-03-31 02:30:55 -0800791 if (new_fl)
792 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 return error;
794}
795
Marc Eshel150b3932007-01-18 16:15:35 -0500796static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797{
798 struct file_lock *fl;
Miklos Szeredi39005d02006-06-23 02:05:10 -0700799 struct file_lock *new_fl = NULL;
800 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 struct file_lock *left = NULL;
802 struct file_lock *right = NULL;
803 struct file_lock **before;
804 int error, added = 0;
805
806 /*
807 * We may need two file_lock structures for this operation,
808 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -0700809 *
810 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 */
Miklos Szeredi39005d02006-06-23 02:05:10 -0700812 if (!(request->fl_flags & FL_ACCESS) &&
813 (request->fl_type != F_UNLCK ||
814 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
815 new_fl = locks_alloc_lock();
816 new_fl2 = locks_alloc_lock();
817 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200819 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 if (request->fl_type != F_UNLCK) {
821 for_each_lock(inode, before) {
J. Bruce Fields526985b2006-11-14 16:54:36 -0500822 fl = *before;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 if (!IS_POSIX(fl))
824 continue;
825 if (!posix_locks_conflict(request, fl))
826 continue;
Andy Adamson5842add2006-03-26 01:37:26 -0800827 if (conflock)
J. Bruce Fields1a747ee2008-04-24 10:08:22 -0400828 __locks_copy_lock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 error = -EAGAIN;
830 if (!(request->fl_flags & FL_SLEEP))
831 goto out;
832 error = -EDEADLK;
833 if (posix_locks_deadlock(request, fl))
834 goto out;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700835 error = FILE_LOCK_DEFERRED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 locks_insert_block(fl, request);
837 goto out;
838 }
839 }
840
841 /* If we're just looking for a conflict, we're done. */
842 error = 0;
843 if (request->fl_flags & FL_ACCESS)
844 goto out;
845
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 * Find the first old lock with the same owner as the new lock.
848 */
849
850 before = &inode->i_flock;
851
852 /* First skip locks owned by other processes. */
853 while ((fl = *before) && (!IS_POSIX(fl) ||
854 !posix_same_owner(request, fl))) {
855 before = &fl->fl_next;
856 }
857
858 /* Process locks with this owner. */
859 while ((fl = *before) && posix_same_owner(request, fl)) {
860 /* Detect adjacent or overlapping regions (if same lock type)
861 */
862 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -0700863 /* In all comparisons of start vs end, use
864 * "start - 1" rather than "end + 1". If end
865 * is OFFSET_MAX, end + 1 will become negative.
866 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 if (fl->fl_end < request->fl_start - 1)
868 goto next_lock;
869 /* If the next lock in the list has entirely bigger
870 * addresses than the new one, insert the lock here.
871 */
Olaf Kirch449231d2005-08-25 16:25:35 -0700872 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 break;
874
875 /* If we come here, the new and old lock are of the
876 * same type and adjacent or overlapping. Make one
877 * lock yielding from the lower start address of both
878 * locks to the higher end address.
879 */
880 if (fl->fl_start > request->fl_start)
881 fl->fl_start = request->fl_start;
882 else
883 request->fl_start = fl->fl_start;
884 if (fl->fl_end < request->fl_end)
885 fl->fl_end = request->fl_end;
886 else
887 request->fl_end = fl->fl_end;
888 if (added) {
889 locks_delete_lock(before);
890 continue;
891 }
892 request = fl;
893 added = 1;
894 }
895 else {
896 /* Processing for different lock types is a bit
897 * more complex.
898 */
899 if (fl->fl_end < request->fl_start)
900 goto next_lock;
901 if (fl->fl_start > request->fl_end)
902 break;
903 if (request->fl_type == F_UNLCK)
904 added = 1;
905 if (fl->fl_start < request->fl_start)
906 left = fl;
907 /* If the next lock in the list has a higher end
908 * address than the new one, insert the new one here.
909 */
910 if (fl->fl_end > request->fl_end) {
911 right = fl;
912 break;
913 }
914 if (fl->fl_start >= request->fl_start) {
915 /* The new lock completely replaces an old
916 * one (This may happen several times).
917 */
918 if (added) {
919 locks_delete_lock(before);
920 continue;
921 }
922 /* Replace the old lock with the new one.
923 * Wake up anybody waiting for the old one,
924 * as the change in lock type might satisfy
925 * their needs.
926 */
927 locks_wake_up_blocks(fl);
928 fl->fl_start = request->fl_start;
929 fl->fl_end = request->fl_end;
930 fl->fl_type = request->fl_type;
Trond Myklebust47831f32006-03-20 13:44:05 -0500931 locks_release_private(fl);
932 locks_copy_private(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 request = fl;
934 added = 1;
935 }
936 }
937 /* Go on to next lock.
938 */
939 next_lock:
940 before = &fl->fl_next;
941 }
942
Miklos Szeredi0d9a4902006-06-23 02:05:09 -0700943 /*
944 * The above code only modifies existing locks in case of
945 * merging or replacing. If new lock(s) need to be inserted
946 * all modifications are done bellow this, so it's safe yet to
947 * bail out.
948 */
949 error = -ENOLCK; /* "no luck" */
950 if (right && left == right && !new_fl2)
951 goto out;
952
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 error = 0;
954 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -0400955 if (request->fl_type == F_UNLCK) {
956 if (request->fl_flags & FL_EXISTS)
957 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400959 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -0700960
961 if (!new_fl) {
962 error = -ENOLCK;
963 goto out;
964 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 locks_copy_lock(new_fl, request);
966 locks_insert_lock(before, new_fl);
967 new_fl = NULL;
968 }
969 if (right) {
970 if (left == right) {
971 /* The new lock breaks the old one in two pieces,
972 * so we have to use the second new lock.
973 */
974 left = new_fl2;
975 new_fl2 = NULL;
976 locks_copy_lock(left, right);
977 locks_insert_lock(before, left);
978 }
979 right->fl_start = request->fl_end + 1;
980 locks_wake_up_blocks(right);
981 }
982 if (left) {
983 left->fl_end = request->fl_start - 1;
984 locks_wake_up_blocks(left);
985 }
986 out:
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200987 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 /*
989 * Free any unused locks.
990 */
991 if (new_fl)
992 locks_free_lock(new_fl);
993 if (new_fl2)
994 locks_free_lock(new_fl2);
995 return error;
996}
997
998/**
999 * posix_lock_file - Apply a POSIX-style lock to a file
1000 * @filp: The file to apply the lock to
1001 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001002 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 *
1004 * Add a POSIX style lock to a file.
1005 * We merge adjacent & overlapping locks whenever possible.
1006 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001007 *
1008 * Note that if called with an FL_EXISTS argument, the caller may determine
1009 * whether or not a lock was successfully freed by testing the return
1010 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 */
Marc Eshel150b3932007-01-18 16:15:35 -05001012int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001013 struct file_lock *conflock)
1014{
Marc Eshel150b3932007-01-18 16:15:35 -05001015 return __posix_lock_file(filp->f_path.dentry->d_inode, fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001016}
Marc Eshel150b3932007-01-18 16:15:35 -05001017EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018
1019/**
1020 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1021 * @filp: The file to apply the lock to
1022 * @fl: The lock to be applied
1023 *
1024 * Add a POSIX style lock to a file.
1025 * We merge adjacent & overlapping locks whenever possible.
1026 * POSIX locks are sorted by owner task, then by starting address
1027 */
1028int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1029{
1030 int error;
1031 might_sleep ();
1032 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001033 error = posix_lock_file(filp, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001034 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 break;
1036 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1037 if (!error)
1038 continue;
1039
1040 locks_delete_block(fl);
1041 break;
1042 }
1043 return error;
1044}
1045EXPORT_SYMBOL(posix_lock_file_wait);
1046
1047/**
1048 * locks_mandatory_locked - Check for an active lock
1049 * @inode: the file to check
1050 *
1051 * Searches the inode's list of locks to find any POSIX locks which conflict.
1052 * This function is called from locks_verify_locked() only.
1053 */
1054int locks_mandatory_locked(struct inode *inode)
1055{
1056 fl_owner_t owner = current->files;
1057 struct file_lock *fl;
1058
1059 /*
1060 * Search the lock list for this inode for any POSIX locks.
1061 */
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001062 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1064 if (!IS_POSIX(fl))
1065 continue;
1066 if (fl->fl_owner != owner)
1067 break;
1068 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001069 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 return fl ? -EAGAIN : 0;
1071}
1072
1073/**
1074 * locks_mandatory_area - Check for a conflicting lock
1075 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1076 * for shared
1077 * @inode: the file to check
1078 * @filp: how the file was opened (if it was)
1079 * @offset: start of area to check
1080 * @count: length of area to check
1081 *
1082 * Searches the inode's list of locks to find any POSIX locks which conflict.
1083 * This function is called from rw_verify_area() and
1084 * locks_verify_truncate().
1085 */
1086int locks_mandatory_area(int read_write, struct inode *inode,
1087 struct file *filp, loff_t offset,
1088 size_t count)
1089{
1090 struct file_lock fl;
1091 int error;
1092
1093 locks_init_lock(&fl);
1094 fl.fl_owner = current->files;
1095 fl.fl_pid = current->tgid;
1096 fl.fl_file = filp;
1097 fl.fl_flags = FL_POSIX | FL_ACCESS;
1098 if (filp && !(filp->f_flags & O_NONBLOCK))
1099 fl.fl_flags |= FL_SLEEP;
1100 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1101 fl.fl_start = offset;
1102 fl.fl_end = offset + count - 1;
1103
1104 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001105 error = __posix_lock_file(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001106 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107 break;
1108 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1109 if (!error) {
1110 /*
1111 * If we've been sleeping someone might have
1112 * changed the permissions behind our back.
1113 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001114 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 continue;
1116 }
1117
1118 locks_delete_block(&fl);
1119 break;
1120 }
1121
1122 return error;
1123}
1124
1125EXPORT_SYMBOL(locks_mandatory_area);
1126
J. Bruce Fields778fc542011-07-26 18:25:49 -04001127static void lease_clear_pending(struct file_lock *fl, int arg)
1128{
1129 switch (arg) {
1130 case F_UNLCK:
1131 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1132 /* fall through: */
1133 case F_RDLCK:
1134 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1135 }
1136}
1137
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138/* We already had a lease on this file; just change its type */
1139int lease_modify(struct file_lock **before, int arg)
1140{
1141 struct file_lock *fl = *before;
1142 int error = assign_type(fl, arg);
1143
1144 if (error)
1145 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001146 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001148 if (arg == F_UNLCK) {
1149 struct file *filp = fl->fl_file;
1150
1151 f_delown(filp);
1152 filp->f_owner.signum = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153 locks_delete_lock(before);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001154 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 return 0;
1156}
1157
1158EXPORT_SYMBOL(lease_modify);
1159
J. Bruce Fields778fc542011-07-26 18:25:49 -04001160static bool past_time(unsigned long then)
1161{
1162 if (!then)
1163 /* 0 is a special value meaning "this never expires": */
1164 return false;
1165 return time_after(jiffies, then);
1166}
1167
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168static void time_out_leases(struct inode *inode)
1169{
1170 struct file_lock **before;
1171 struct file_lock *fl;
1172
1173 before = &inode->i_flock;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04001174 while ((fl = *before) && IS_LEASE(fl) && lease_breaking(fl)) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001175 if (past_time(fl->fl_downgrade_time))
1176 lease_modify(before, F_RDLCK);
1177 if (past_time(fl->fl_break_time))
1178 lease_modify(before, F_UNLCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 if (fl == *before) /* lease_modify may have freed fl */
1180 before = &fl->fl_next;
1181 }
1182}
1183
1184/**
1185 * __break_lease - revoke all outstanding leases on file
1186 * @inode: the inode of the file to return
1187 * @mode: the open mode (read or write)
1188 *
david m. richter87250dd2007-05-09 16:10:27 -04001189 * break_lease (inlined for speed) has checked there already is at least
1190 * some kind of lock (maybe a lease) on this file. Leases are broken on
1191 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 * specified %O_NONBLOCK to your open().
1193 */
1194int __break_lease(struct inode *inode, unsigned int mode)
1195{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001196 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 struct file_lock *new_fl, *flock;
1198 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199 unsigned long break_time;
1200 int i_have_this_lease = 0;
Al Viro8737c932009-12-24 06:47:55 -05001201 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202
Al Viro8737c932009-12-24 06:47:55 -05001203 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001204 if (IS_ERR(new_fl))
1205 return PTR_ERR(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001207 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208
1209 time_out_leases(inode);
1210
1211 flock = inode->i_flock;
1212 if ((flock == NULL) || !IS_LEASE(flock))
1213 goto out;
1214
J. Bruce Fields778fc542011-07-26 18:25:49 -04001215 if (!locks_conflict(flock, new_fl))
1216 goto out;
1217
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next)
1219 if (fl->fl_owner == current->files)
1220 i_have_this_lease = 1;
1221
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 break_time = 0;
1223 if (lease_break_time > 0) {
1224 break_time = jiffies + lease_break_time * HZ;
1225 if (break_time == 0)
1226 break_time++; /* so that 0 means no break time */
1227 }
1228
1229 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001230 if (want_write) {
1231 if (fl->fl_flags & FL_UNLOCK_PENDING)
1232 continue;
1233 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001235 } else {
1236 if (lease_breaking(flock))
1237 continue;
1238 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1239 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 }
J. Bruce Fields778fc542011-07-26 18:25:49 -04001241 fl->fl_lmops->lm_break(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 }
1243
1244 if (i_have_this_lease || (mode & O_NONBLOCK)) {
1245 error = -EWOULDBLOCK;
1246 goto out;
1247 }
1248
1249restart:
1250 break_time = flock->fl_break_time;
1251 if (break_time != 0) {
1252 break_time -= jiffies;
1253 if (break_time == 0)
1254 break_time++;
1255 }
Matthew Wilcox4321e012008-01-14 21:28:30 -07001256 locks_insert_block(flock, new_fl);
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001257 unlock_flocks();
Matthew Wilcox4321e012008-01-14 21:28:30 -07001258 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1259 !new_fl->fl_next, break_time);
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001260 lock_flocks();
Matthew Wilcox4321e012008-01-14 21:28:30 -07001261 __locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 if (error >= 0) {
1263 if (error == 0)
1264 time_out_leases(inode);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001265 /*
1266 * Wait for the next conflicting lease that has not been
1267 * broken yet
1268 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1270 flock = flock->fl_next) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001271 if (locks_conflict(new_fl, flock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 goto restart;
1273 }
1274 error = 0;
1275 }
1276
1277out:
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001278 unlock_flocks();
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001279 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 return error;
1281}
1282
1283EXPORT_SYMBOL(__break_lease);
1284
1285/**
Randy Dunlapa6b91912008-03-19 17:01:00 -07001286 * lease_get_mtime - get the last modified time of an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287 * @inode: the inode
1288 * @time: pointer to a timespec which will contain the last modified time
1289 *
1290 * This is to force NFS clients to flush their caches for files with
1291 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001292 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 */
1294void lease_get_mtime(struct inode *inode, struct timespec *time)
1295{
1296 struct file_lock *flock = inode->i_flock;
1297 if (flock && IS_LEASE(flock) && (flock->fl_type & F_WRLCK))
1298 *time = current_fs_time(inode->i_sb);
1299 else
1300 *time = inode->i_mtime;
1301}
1302
1303EXPORT_SYMBOL(lease_get_mtime);
1304
1305/**
1306 * fcntl_getlease - Enquire what lease is currently active
1307 * @filp: the file
1308 *
1309 * The value returned by this function will be one of
1310 * (if no lease break is pending):
1311 *
1312 * %F_RDLCK to indicate a shared lease is held.
1313 *
1314 * %F_WRLCK to indicate an exclusive lease is held.
1315 *
1316 * %F_UNLCK to indicate no lease is held.
1317 *
1318 * (if a lease break is pending):
1319 *
1320 * %F_RDLCK to indicate an exclusive lease needs to be
1321 * changed to a shared lease (or removed).
1322 *
1323 * %F_UNLCK to indicate the lease needs to be removed.
1324 *
1325 * XXX: sfr & willy disagree over whether F_INPROGRESS
1326 * should be returned to userspace.
1327 */
1328int fcntl_getlease(struct file *filp)
1329{
1330 struct file_lock *fl;
1331 int type = F_UNLCK;
1332
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001333 lock_flocks();
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001334 time_out_leases(filp->f_path.dentry->d_inode);
1335 for (fl = filp->f_path.dentry->d_inode->i_flock; fl && IS_LEASE(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 fl = fl->fl_next) {
1337 if (fl->fl_file == filp) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001338 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 break;
1340 }
1341 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001342 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 return type;
1344}
1345
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001346int generic_add_lease(struct file *filp, long arg, struct file_lock **flp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347{
KAMBAROV, ZAUR7eaae282005-07-07 17:57:06 -07001348 struct file_lock *fl, **before, **my_before = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001349 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 struct inode *inode = dentry->d_inode;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001351 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352
J. Bruce Fields096657b2010-10-30 17:31:14 -04001353 lease = *flp;
1354
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001355 error = -EAGAIN;
1356 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
J. Bruce Fields096657b2010-10-30 17:31:14 -04001357 goto out;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001358 if ((arg == F_WRLCK)
1359 && ((dentry->d_count > 1)
1360 || (atomic_read(&inode->i_count) > 1)))
J. Bruce Fields096657b2010-10-30 17:31:14 -04001361 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001362
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 /*
1364 * At this point, we know that if there is an exclusive
1365 * lease on this file, then we hold it on this filp
1366 * (otherwise our open of this file would have blocked).
1367 * And if we are trying to acquire an exclusive lease,
1368 * then the file is not open by anyone (including us)
1369 * except for this filp.
1370 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001371 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372 for (before = &inode->i_flock;
1373 ((fl = *before) != NULL) && IS_LEASE(fl);
1374 before = &fl->fl_next) {
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001375 if (fl->fl_file == filp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 my_before = before;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001377 continue;
1378 }
1379 /*
1380 * No exclusive leases if someone else has a lease on
1381 * this file:
1382 */
1383 if (arg == F_WRLCK)
1384 goto out;
1385 /*
1386 * Modifying our existing lease is OK, but no getting a
1387 * new lease if someone else is opening for write:
1388 */
1389 if (fl->fl_flags & FL_UNLOCK_PENDING)
1390 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 }
1392
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 if (my_before != NULL) {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001394 error = lease->fl_lmops->lm_change(my_before, arg);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001395 if (!error)
1396 *flp = *my_before;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 goto out;
1398 }
1399
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 error = -EINVAL;
1401 if (!leases_enable)
1402 goto out;
1403
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001404 locks_insert_lock(before, lease);
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001405 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407out:
1408 return error;
1409}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001410
1411int generic_delete_lease(struct file *filp, struct file_lock **flp)
1412{
1413 struct file_lock *fl, **before;
1414 struct dentry *dentry = filp->f_path.dentry;
1415 struct inode *inode = dentry->d_inode;
1416
1417 for (before = &inode->i_flock;
1418 ((fl = *before) != NULL) && IS_LEASE(fl);
1419 before = &fl->fl_next) {
1420 if (fl->fl_file != filp)
1421 continue;
1422 return (*flp)->fl_lmops->lm_change(before, F_UNLCK);
1423 }
1424 return -EAGAIN;
1425}
1426
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427/**
1428 * generic_setlease - sets a lease on an open file
1429 * @filp: file pointer
1430 * @arg: type of lease to obtain
1431 * @flp: input - file_lock to use, output - file_lock inserted
1432 *
1433 * The (input) flp->fl_lmops->lm_break function is required
1434 * by break_lease().
1435 *
1436 * Called with file_lock_lock held.
1437 */
1438int generic_setlease(struct file *filp, long arg, struct file_lock **flp)
1439{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 struct dentry *dentry = filp->f_path.dentry;
1441 struct inode *inode = dentry->d_inode;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001442 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001444 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001445 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001447 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 error = security_file_lock(filp, arg);
1449 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001450 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451
1452 time_out_leases(inode);
1453
1454 BUG_ON(!(*flp)->fl_lmops->lm_break);
1455
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001456 switch (arg) {
1457 case F_UNLCK:
1458 return generic_delete_lease(filp, flp);
1459 case F_RDLCK:
1460 case F_WRLCK:
1461 return generic_add_lease(filp, arg, flp);
1462 default:
1463 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001466EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001468static int __vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
1469{
1470 if (filp->f_op && filp->f_op->setlease)
1471 return filp->f_op->setlease(filp, arg, lease);
1472 else
1473 return generic_setlease(filp, arg, lease);
1474}
1475
1476/**
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001477 * vfs_setlease - sets a lease on an open file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 * @filp: file pointer
1479 * @arg: type of lease to obtain
1480 * @lease: file_lock to use
1481 *
1482 * Call this to establish a lease on the file.
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001483 * The (*lease)->fl_lmops->lm_break operation must be set; if not,
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001484 * break_lease will oops!
1485 *
1486 * This will call the filesystem's setlease file method, if
1487 * defined. Note that there is no getlease method; instead, the
1488 * filesystem setlease method should call back to setlease() to
1489 * add a lease to the inode's lease list, where fcntl_getlease() can
1490 * find it. Since fcntl_getlease() only reports whether the current
1491 * task holds a lease, a cluster filesystem need only do this for
1492 * leases held by processes on this node.
1493 *
1494 * There is also no break_lease method; filesystems that
Adam Buchbinderc9404c92009-12-18 15:40:42 -05001495 * handle their own leases should break leases themselves from the
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001496 * filesystem's open, create, and (on truncate) setattr methods.
1497 *
1498 * Warning: the only current setlease methods exist only to disable
1499 * leases in certain cases. More vfs changes may be required to
1500 * allow a full filesystem lease implementation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 */
1502
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001503int vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505 int error;
1506
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001507 lock_flocks();
1508 error = __vfs_setlease(filp, arg, lease);
1509 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510
1511 return error;
1512}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001513EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001515static int do_fcntl_delete_lease(struct file *filp)
1516{
1517 struct file_lock fl, *flp = &fl;
1518
1519 lease_init(filp, F_UNLCK, flp);
1520
1521 return vfs_setlease(filp, F_UNLCK, &flp);
1522}
1523
1524static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525{
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001526 struct file_lock *fl, *ret;
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001527 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 int error;
1529
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001530 fl = lease_alloc(filp, arg);
1531 if (IS_ERR(fl))
1532 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001534 new = fasync_alloc();
1535 if (!new) {
1536 locks_free_lock(fl);
1537 return -ENOMEM;
1538 }
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001539 ret = fl;
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001540 lock_flocks();
J. Bruce Fields8896b932010-11-03 18:09:18 -04001541 error = __vfs_setlease(filp, arg, &ret);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001542 if (error) {
1543 unlock_flocks();
1544 locks_free_lock(fl);
1545 goto out_free_fasync;
1546 }
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001547 if (ret != fl)
1548 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001550 /*
1551 * fasync_insert_entry() returns the old entry if any.
1552 * If there was no old entry, then it used 'new' and
1553 * inserted it into the fasync list. Clear new so that
1554 * we don't release it here.
1555 */
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001556 if (!fasync_insert_entry(fd, filp, &ret->fl_fasync, new))
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001557 new = NULL;
1558
J. Bruce Fields8896b932010-11-03 18:09:18 -04001559 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001560 unlock_flocks();
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001561
1562out_free_fasync:
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001563 if (new)
1564 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 return error;
1566}
1567
1568/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001569 * fcntl_setlease - sets a lease on an open file
1570 * @fd: open file descriptor
1571 * @filp: file pointer
1572 * @arg: type of lease to obtain
1573 *
1574 * Call this fcntl to establish a lease on the file.
1575 * Note that you also need to call %F_SETSIG to
1576 * receive a signal when the lease is broken.
1577 */
1578int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1579{
1580 if (arg == F_UNLCK)
1581 return do_fcntl_delete_lease(filp);
1582 return do_fcntl_add_lease(fd, filp, arg);
1583}
1584
1585/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1587 * @filp: The file to apply the lock to
1588 * @fl: The lock to be applied
1589 *
1590 * Add a FLOCK style lock to a file.
1591 */
1592int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1593{
1594 int error;
1595 might_sleep();
1596 for (;;) {
1597 error = flock_lock_file(filp, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001598 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 break;
1600 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1601 if (!error)
1602 continue;
1603
1604 locks_delete_block(fl);
1605 break;
1606 }
1607 return error;
1608}
1609
1610EXPORT_SYMBOL(flock_lock_file_wait);
1611
1612/**
1613 * sys_flock: - flock() system call.
1614 * @fd: the file descriptor to lock.
1615 * @cmd: the type of lock to apply.
1616 *
1617 * Apply a %FL_FLOCK style lock to an open file descriptor.
1618 * The @cmd can be one of
1619 *
1620 * %LOCK_SH -- a shared lock.
1621 *
1622 * %LOCK_EX -- an exclusive lock.
1623 *
1624 * %LOCK_UN -- remove an existing lock.
1625 *
1626 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1627 *
1628 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1629 * processes read and write access respectively.
1630 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001631SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632{
1633 struct file *filp;
Al Virobdc68952012-04-21 18:46:53 -04001634 int fput_needed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 struct file_lock *lock;
1636 int can_sleep, unlock;
1637 int error;
1638
1639 error = -EBADF;
Al Virobdc68952012-04-21 18:46:53 -04001640 filp = fget_light(fd, &fput_needed);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 if (!filp)
1642 goto out;
1643
1644 can_sleep = !(cmd & LOCK_NB);
1645 cmd &= ~LOCK_NB;
1646 unlock = (cmd == LOCK_UN);
1647
Al Viroaeb5d722008-09-02 15:28:45 -04001648 if (!unlock && !(cmd & LOCK_MAND) &&
1649 !(filp->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 goto out_putf;
1651
1652 error = flock_make_lock(filp, &lock, cmd);
1653 if (error)
1654 goto out_putf;
1655 if (can_sleep)
1656 lock->fl_flags |= FL_SLEEP;
1657
Sten Spans713c0ec2009-07-16 09:41:39 +02001658 error = security_file_lock(filp, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659 if (error)
1660 goto out_free;
1661
1662 if (filp->f_op && filp->f_op->flock)
1663 error = filp->f_op->flock(filp,
1664 (can_sleep) ? F_SETLKW : F_SETLK,
1665 lock);
1666 else
1667 error = flock_lock_file_wait(filp, lock);
1668
1669 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08001670 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671
1672 out_putf:
Al Virobdc68952012-04-21 18:46:53 -04001673 fput_light(filp, fput_needed);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 out:
1675 return error;
1676}
1677
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001678/**
1679 * vfs_test_lock - test file byte range lock
1680 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04001681 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001682 *
1683 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1684 * setting conf->fl_type to something other than F_UNLCK.
1685 */
1686int vfs_test_lock(struct file *filp, struct file_lock *fl)
1687{
1688 if (filp->f_op && filp->f_op->lock)
1689 return filp->f_op->lock(filp, F_GETLK, fl);
1690 posix_test_lock(filp, fl);
1691 return 0;
1692}
1693EXPORT_SYMBOL_GPL(vfs_test_lock);
1694
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001695static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1696{
1697 flock->l_pid = fl->fl_pid;
1698#if BITS_PER_LONG == 32
1699 /*
1700 * Make sure we can represent the posix lock via
1701 * legacy 32bit flock.
1702 */
1703 if (fl->fl_start > OFFT_OFFSET_MAX)
1704 return -EOVERFLOW;
1705 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1706 return -EOVERFLOW;
1707#endif
1708 flock->l_start = fl->fl_start;
1709 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1710 fl->fl_end - fl->fl_start + 1;
1711 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04001712 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001713 return 0;
1714}
1715
1716#if BITS_PER_LONG == 32
1717static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1718{
1719 flock->l_pid = fl->fl_pid;
1720 flock->l_start = fl->fl_start;
1721 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1722 fl->fl_end - fl->fl_start + 1;
1723 flock->l_whence = 0;
1724 flock->l_type = fl->fl_type;
1725}
1726#endif
1727
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728/* Report the first existing lock that would conflict with l.
1729 * This implements the F_GETLK command of fcntl().
1730 */
1731int fcntl_getlk(struct file *filp, struct flock __user *l)
1732{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001733 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 struct flock flock;
1735 int error;
1736
1737 error = -EFAULT;
1738 if (copy_from_user(&flock, l, sizeof(flock)))
1739 goto out;
1740 error = -EINVAL;
1741 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1742 goto out;
1743
1744 error = flock_to_posix_lock(filp, &file_lock, &flock);
1745 if (error)
1746 goto out;
1747
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001748 error = vfs_test_lock(filp, &file_lock);
1749 if (error)
1750 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001752 flock.l_type = file_lock.fl_type;
1753 if (file_lock.fl_type != F_UNLCK) {
1754 error = posix_lock_to_flock(&flock, &file_lock);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001755 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 }
1758 error = -EFAULT;
1759 if (!copy_to_user(l, &flock, sizeof(flock)))
1760 error = 0;
1761out:
1762 return error;
1763}
1764
Marc Eshel7723ec92007-01-18 15:08:55 -05001765/**
1766 * vfs_lock_file - file byte range lock
1767 * @filp: The file to apply the lock to
1768 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1769 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001770 * @conf: Place to return a copy of the conflicting lock, if found.
1771 *
1772 * A caller that doesn't care about the conflicting lock may pass NULL
1773 * as the final argument.
1774 *
1775 * If the filesystem defines a private ->lock() method, then @conf will
1776 * be left unchanged; so a caller that cares should initialize it to
1777 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05001778 *
1779 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1780 * locks, the ->lock() interface may return asynchronously, before the lock has
1781 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001782 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05001783 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1784 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001785 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05001786 * request completes.
1787 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07001788 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
1789 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05001790 * nonzero return code and the file system should release the lock. The file
1791 * system is also responsible to keep a corresponding posix lock when it
1792 * grants a lock so the VFS can find out which locks are locally held and do
1793 * the correct lock cleanup when required.
1794 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001795 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05001796 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05001797 */
Marc Eshel150b3932007-01-18 16:15:35 -05001798int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05001799{
1800 if (filp->f_op && filp->f_op->lock)
1801 return filp->f_op->lock(filp, cmd, fl);
1802 else
Marc Eshel150b3932007-01-18 16:15:35 -05001803 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05001804}
1805EXPORT_SYMBOL_GPL(vfs_lock_file);
1806
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001807static int do_lock_file_wait(struct file *filp, unsigned int cmd,
1808 struct file_lock *fl)
1809{
1810 int error;
1811
1812 error = security_file_lock(filp, fl->fl_type);
1813 if (error)
1814 return error;
1815
Miklos Szeredi764c76b2008-07-25 01:48:58 -07001816 for (;;) {
1817 error = vfs_lock_file(filp, cmd, fl, NULL);
1818 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001819 break;
Miklos Szeredi764c76b2008-07-25 01:48:58 -07001820 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1821 if (!error)
1822 continue;
1823
1824 locks_delete_block(fl);
1825 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001826 }
1827
1828 return error;
1829}
1830
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831/* Apply the lock described by l to an open file descriptor.
1832 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1833 */
Peter Staubachc2936212005-07-27 11:45:09 -07001834int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
1835 struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836{
1837 struct file_lock *file_lock = locks_alloc_lock();
1838 struct flock flock;
1839 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04001840 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 int error;
1842
1843 if (file_lock == NULL)
1844 return -ENOLCK;
1845
1846 /*
1847 * This might block, so we do it before checking the inode.
1848 */
1849 error = -EFAULT;
1850 if (copy_from_user(&flock, l, sizeof(flock)))
1851 goto out;
1852
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001853 inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854
1855 /* Don't allow mandatory locks on files that may be memory mapped
1856 * and shared.
1857 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001858 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 error = -EAGAIN;
1860 goto out;
1861 }
1862
Peter Staubachc2936212005-07-27 11:45:09 -07001863again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 error = flock_to_posix_lock(filp, file_lock, &flock);
1865 if (error)
1866 goto out;
1867 if (cmd == F_SETLKW) {
1868 file_lock->fl_flags |= FL_SLEEP;
1869 }
1870
1871 error = -EBADF;
1872 switch (flock.l_type) {
1873 case F_RDLCK:
1874 if (!(filp->f_mode & FMODE_READ))
1875 goto out;
1876 break;
1877 case F_WRLCK:
1878 if (!(filp->f_mode & FMODE_WRITE))
1879 goto out;
1880 break;
1881 case F_UNLCK:
1882 break;
1883 default:
1884 error = -EINVAL;
1885 goto out;
1886 }
1887
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001888 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889
Peter Staubachc2936212005-07-27 11:45:09 -07001890 /*
1891 * Attempt to detect a close/fcntl race and recover by
1892 * releasing the lock that was just acquired.
1893 */
Al Viro0b2bac22008-05-06 13:58:34 -04001894 /*
1895 * we need that spin_lock here - it prevents reordering between
1896 * update of inode->i_flock and check for it done in close().
1897 * rcu_read_lock() wouldn't do.
1898 */
1899 spin_lock(&current->files->file_lock);
1900 f = fcheck(fd);
1901 spin_unlock(&current->files->file_lock);
1902 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07001903 flock.l_type = F_UNLCK;
1904 goto again;
1905 }
1906
1907out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 locks_free_lock(file_lock);
1909 return error;
1910}
1911
1912#if BITS_PER_LONG == 32
1913/* Report the first existing lock that would conflict with l.
1914 * This implements the F_GETLK command of fcntl().
1915 */
1916int fcntl_getlk64(struct file *filp, struct flock64 __user *l)
1917{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001918 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 struct flock64 flock;
1920 int error;
1921
1922 error = -EFAULT;
1923 if (copy_from_user(&flock, l, sizeof(flock)))
1924 goto out;
1925 error = -EINVAL;
1926 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1927 goto out;
1928
1929 error = flock64_to_posix_lock(filp, &file_lock, &flock);
1930 if (error)
1931 goto out;
1932
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001933 error = vfs_test_lock(filp, &file_lock);
1934 if (error)
1935 goto out;
1936
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001937 flock.l_type = file_lock.fl_type;
1938 if (file_lock.fl_type != F_UNLCK)
1939 posix_lock_to_flock64(&flock, &file_lock);
1940
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 error = -EFAULT;
1942 if (!copy_to_user(l, &flock, sizeof(flock)))
1943 error = 0;
1944
1945out:
1946 return error;
1947}
1948
1949/* Apply the lock described by l to an open file descriptor.
1950 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1951 */
Peter Staubachc2936212005-07-27 11:45:09 -07001952int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
1953 struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954{
1955 struct file_lock *file_lock = locks_alloc_lock();
1956 struct flock64 flock;
1957 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04001958 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959 int error;
1960
1961 if (file_lock == NULL)
1962 return -ENOLCK;
1963
1964 /*
1965 * This might block, so we do it before checking the inode.
1966 */
1967 error = -EFAULT;
1968 if (copy_from_user(&flock, l, sizeof(flock)))
1969 goto out;
1970
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001971 inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972
1973 /* Don't allow mandatory locks on files that may be memory mapped
1974 * and shared.
1975 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001976 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 error = -EAGAIN;
1978 goto out;
1979 }
1980
Peter Staubachc2936212005-07-27 11:45:09 -07001981again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 error = flock64_to_posix_lock(filp, file_lock, &flock);
1983 if (error)
1984 goto out;
1985 if (cmd == F_SETLKW64) {
1986 file_lock->fl_flags |= FL_SLEEP;
1987 }
1988
1989 error = -EBADF;
1990 switch (flock.l_type) {
1991 case F_RDLCK:
1992 if (!(filp->f_mode & FMODE_READ))
1993 goto out;
1994 break;
1995 case F_WRLCK:
1996 if (!(filp->f_mode & FMODE_WRITE))
1997 goto out;
1998 break;
1999 case F_UNLCK:
2000 break;
2001 default:
2002 error = -EINVAL;
2003 goto out;
2004 }
2005
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002006 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007
Peter Staubachc2936212005-07-27 11:45:09 -07002008 /*
2009 * Attempt to detect a close/fcntl race and recover by
2010 * releasing the lock that was just acquired.
2011 */
Al Viro0b2bac22008-05-06 13:58:34 -04002012 spin_lock(&current->files->file_lock);
2013 f = fcheck(fd);
2014 spin_unlock(&current->files->file_lock);
2015 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002016 flock.l_type = F_UNLCK;
2017 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 }
2019
2020out:
2021 locks_free_lock(file_lock);
2022 return error;
2023}
2024#endif /* BITS_PER_LONG == 32 */
2025
2026/*
2027 * This function is called when the file is being removed
2028 * from the task's fd array. POSIX locks belonging to this task
2029 * are deleted at this time.
2030 */
2031void locks_remove_posix(struct file *filp, fl_owner_t owner)
2032{
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002033 struct file_lock lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034
2035 /*
2036 * If there are no locks held on this file, we don't need to call
2037 * posix_lock_file(). Another process could be setting a lock on this
2038 * file at the same time, but we wouldn't remove that lock anyway.
2039 */
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08002040 if (!filp->f_path.dentry->d_inode->i_flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 return;
2042
2043 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002044 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 lock.fl_start = 0;
2046 lock.fl_end = OFFSET_MAX;
2047 lock.fl_owner = owner;
2048 lock.fl_pid = current->tgid;
2049 lock.fl_file = filp;
2050 lock.fl_ops = NULL;
2051 lock.fl_lmops = NULL;
2052
Marc Eshel150b3932007-01-18 16:15:35 -05002053 vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2056 lock.fl_ops->fl_release_private(&lock);
2057}
2058
2059EXPORT_SYMBOL(locks_remove_posix);
2060
2061/*
2062 * This function is called on the last close of an open file.
2063 */
2064void locks_remove_flock(struct file *filp)
2065{
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08002066 struct inode * inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 struct file_lock *fl;
2068 struct file_lock **before;
2069
2070 if (!inode->i_flock)
2071 return;
2072
2073 if (filp->f_op && filp->f_op->flock) {
2074 struct file_lock fl = {
2075 .fl_pid = current->tgid,
2076 .fl_file = filp,
2077 .fl_flags = FL_FLOCK,
2078 .fl_type = F_UNLCK,
2079 .fl_end = OFFSET_MAX,
2080 };
2081 filp->f_op->flock(filp, F_SETLKW, &fl);
Trond Myklebust80fec4c2005-06-22 17:16:31 +00002082 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2083 fl.fl_ops->fl_release_private(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 }
2085
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002086 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 before = &inode->i_flock;
2088
2089 while ((fl = *before) != NULL) {
2090 if (fl->fl_file == filp) {
Peter Staubachc2936212005-07-27 11:45:09 -07002091 if (IS_FLOCK(fl)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 locks_delete_lock(before);
2093 continue;
2094 }
2095 if (IS_LEASE(fl)) {
2096 lease_modify(before, F_UNLCK);
2097 continue;
2098 }
2099 /* What? */
2100 BUG();
2101 }
2102 before = &fl->fl_next;
2103 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002104 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105}
2106
2107/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108 * posix_unblock_lock - stop waiting for a file lock
2109 * @filp: how the file was opened
2110 * @waiter: the lock which was waiting
2111 *
2112 * lockd needs to block waiting for locks.
2113 */
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002114int
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115posix_unblock_lock(struct file *filp, struct file_lock *waiter)
2116{
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002117 int status = 0;
2118
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002119 lock_flocks();
J. Bruce Fields5996a292006-01-03 09:55:44 +01002120 if (waiter->fl_next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 __locks_delete_block(waiter);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002122 else
2123 status = -ENOENT;
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002124 unlock_flocks();
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002125 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126}
2127
2128EXPORT_SYMBOL(posix_unblock_lock);
2129
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002130/**
2131 * vfs_cancel_lock - file byte range unblock lock
2132 * @filp: The file to apply the unblock to
2133 * @fl: The lock to be unblocked
2134 *
2135 * Used by lock managers to cancel blocked requests
2136 */
2137int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2138{
2139 if (filp->f_op && filp->f_op->lock)
2140 return filp->f_op->lock(filp, F_CANCELLK, fl);
2141 return 0;
2142}
2143
2144EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2145
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002146#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002147#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002148#include <linux/seq_file.h>
2149
2150static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002151 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152{
2153 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002154 unsigned int fl_pid;
2155
2156 if (fl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -08002157 fl_pid = pid_vnr(fl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002158 else
2159 fl_pid = fl->fl_pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160
2161 if (fl->fl_file != NULL)
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08002162 inode = fl->fl_file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163
Jerome Marchand99dc8292010-10-26 14:22:33 -07002164 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 if (IS_POSIX(fl)) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002166 seq_printf(f, "%6s %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167 (fl->fl_flags & FL_ACCESS) ? "ACCESS" : "POSIX ",
2168 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002169 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 } else if (IS_FLOCK(fl)) {
2171 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002172 seq_printf(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002174 seq_printf(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 }
2176 } else if (IS_LEASE(fl)) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002177 seq_printf(f, "LEASE ");
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002178 if (lease_breaking(fl))
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002179 seq_printf(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 else if (fl->fl_file)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002181 seq_printf(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002183 seq_printf(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002185 seq_printf(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186 }
2187 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002188 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 (fl->fl_type & LOCK_READ)
2190 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2191 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2192 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002193 seq_printf(f, "%s ",
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002194 (lease_breaking(fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 ? (fl->fl_type & F_UNLCK) ? "UNLCK" : "READ "
2196 : (fl->fl_type & F_WRLCK) ? "WRITE" : "READ ");
2197 }
2198 if (inode) {
2199#ifdef WE_CAN_BREAK_LSLK_NOW
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002200 seq_printf(f, "%d %s:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 inode->i_sb->s_id, inode->i_ino);
2202#else
2203 /* userspace relies on this representation of dev_t ;-( */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002204 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205 MAJOR(inode->i_sb->s_dev),
2206 MINOR(inode->i_sb->s_dev), inode->i_ino);
2207#endif
2208 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002209 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 }
2211 if (IS_POSIX(fl)) {
2212 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002213 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002215 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002217 seq_printf(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 }
2219}
2220
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002221static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222{
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002223 struct file_lock *fl, *bfl;
2224
2225 fl = list_entry(v, struct file_lock, fl_link);
2226
Jerome Marchand99dc8292010-10-26 14:22:33 -07002227 lock_get_status(f, fl, *((loff_t *)f->private), "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002228
2229 list_for_each_entry(bfl, &fl->fl_block, fl_block)
Jerome Marchand99dc8292010-10-26 14:22:33 -07002230 lock_get_status(f, bfl, *((loff_t *)f->private), " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002231
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002232 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233}
2234
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002235static void *locks_start(struct seq_file *f, loff_t *pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236{
Jerome Marchand99dc8292010-10-26 14:22:33 -07002237 loff_t *p = f->private;
2238
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002239 lock_flocks();
Jerome Marchand99dc8292010-10-26 14:22:33 -07002240 *p = (*pos + 1);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002241 return seq_list_start(&file_lock_list, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242}
2243
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002244static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2245{
Jerome Marchand99dc8292010-10-26 14:22:33 -07002246 loff_t *p = f->private;
2247 ++*p;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002248 return seq_list_next(v, &file_lock_list, pos);
2249}
2250
2251static void locks_stop(struct seq_file *f, void *v)
2252{
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002253 unlock_flocks();
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002254}
2255
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002256static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002257 .start = locks_start,
2258 .next = locks_next,
2259 .stop = locks_stop,
2260 .show = locks_show,
2261};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002262
2263static int locks_open(struct inode *inode, struct file *filp)
2264{
Jerome Marchand99dc8292010-10-26 14:22:33 -07002265 return seq_open_private(filp, &locks_seq_operations, sizeof(loff_t));
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002266}
2267
2268static const struct file_operations proc_locks_operations = {
2269 .open = locks_open,
2270 .read = seq_read,
2271 .llseek = seq_lseek,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002272 .release = seq_release_private,
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002273};
2274
2275static int __init proc_locks_init(void)
2276{
2277 proc_create("locks", 0, NULL, &proc_locks_operations);
2278 return 0;
2279}
2280module_init(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002281#endif
2282
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283/**
2284 * lock_may_read - checks that the region is free of locks
2285 * @inode: the inode that is being read
2286 * @start: the first byte to read
2287 * @len: the number of bytes to read
2288 *
2289 * Emulates Windows locking requirements. Whole-file
2290 * mandatory locks (share modes) can prohibit a read and
2291 * byte-range POSIX locks can prohibit a read if they overlap.
2292 *
2293 * N.B. this function is only ever called
2294 * from knfsd and ownership of locks is never checked.
2295 */
2296int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2297{
2298 struct file_lock *fl;
2299 int result = 1;
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002300 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2302 if (IS_POSIX(fl)) {
2303 if (fl->fl_type == F_RDLCK)
2304 continue;
2305 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2306 continue;
2307 } else if (IS_FLOCK(fl)) {
2308 if (!(fl->fl_type & LOCK_MAND))
2309 continue;
2310 if (fl->fl_type & LOCK_READ)
2311 continue;
2312 } else
2313 continue;
2314 result = 0;
2315 break;
2316 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002317 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318 return result;
2319}
2320
2321EXPORT_SYMBOL(lock_may_read);
2322
2323/**
2324 * lock_may_write - checks that the region is free of locks
2325 * @inode: the inode that is being written
2326 * @start: the first byte to write
2327 * @len: the number of bytes to write
2328 *
2329 * Emulates Windows locking requirements. Whole-file
2330 * mandatory locks (share modes) can prohibit a write and
2331 * byte-range POSIX locks can prohibit a write if they overlap.
2332 *
2333 * N.B. this function is only ever called
2334 * from knfsd and ownership of locks is never checked.
2335 */
2336int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2337{
2338 struct file_lock *fl;
2339 int result = 1;
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002340 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2342 if (IS_POSIX(fl)) {
2343 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2344 continue;
2345 } else if (IS_FLOCK(fl)) {
2346 if (!(fl->fl_type & LOCK_MAND))
2347 continue;
2348 if (fl->fl_type & LOCK_WRITE)
2349 continue;
2350 } else
2351 continue;
2352 result = 0;
2353 break;
2354 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002355 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356 return result;
2357}
2358
2359EXPORT_SYMBOL(lock_may_write);
2360
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361static int __init filelock_init(void)
2362{
2363 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002364 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2365
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366 return 0;
2367}
2368
2369core_initcall(filelock_init);