blob: 0391d2ff5a4ed859ca19c5fa65964ddd1c6d85f8 [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.
63 * See 'Documentation/mandatory.txt' for details.
64 * 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>
125#include <linux/smp_lock.h>
126#include <linux/syscalls.h>
127#include <linux/time.h>
Dipankar Sarma4fb3a532005-09-16 19:28:13 -0700128#include <linux/rcupdate.h>
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000129#include <linux/pid_namespace.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131#include <asm/uaccess.h>
132
133#define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
134#define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
135#define IS_LEASE(fl) (fl->fl_flags & FL_LEASE)
136
137int leases_enable = 1;
138int lease_break_time = 45;
139
140#define for_each_lock(inode, lockp) \
141 for (lockp = &inode->i_flock; *lockp != NULL; lockp = &(*lockp)->fl_next)
142
Christoph Hellwig26bcbf92006-03-20 13:44:40 -0500143static LIST_HEAD(file_lock_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144static LIST_HEAD(blocked_list);
145
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200146/*
147 * Protects the two list heads above, plus the inode->i_flock list
148 * FIXME: should use a spinlock, once lockd and ceph are ready.
149 */
150void lock_flocks(void)
151{
152 lock_kernel();
153}
154EXPORT_SYMBOL_GPL(lock_flocks);
155
156void unlock_flocks(void)
157{
158 unlock_kernel();
159}
160EXPORT_SYMBOL_GPL(unlock_flocks);
161
Christoph Lametere18b8902006-12-06 20:33:20 -0800162static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
164/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200165struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166{
Christoph Lametere94b1762006-12-06 20:33:17 -0800167 return kmem_cache_alloc(filelock_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200169EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500171void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500172{
173 if (fl->fl_ops) {
174 if (fl->fl_ops->fl_release_private)
175 fl->fl_ops->fl_release_private(fl);
176 fl->fl_ops = NULL;
177 }
178 if (fl->fl_lmops) {
179 if (fl->fl_lmops->fl_release_private)
180 fl->fl_lmops->fl_release_private(fl);
181 fl->fl_lmops = NULL;
182 }
183
184}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500185EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500186
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187/* Free a lock which is not in use. */
Matt Mackall33443c42006-01-08 01:05:22 -0800188static void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189{
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800190 BUG_ON(waitqueue_active(&fl->fl_wait));
191 BUG_ON(!list_empty(&fl->fl_block));
192 BUG_ON(!list_empty(&fl->fl_link));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
Trond Myklebust47831f32006-03-20 13:44:05 -0500194 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 kmem_cache_free(filelock_cache, fl);
196}
197
198void locks_init_lock(struct file_lock *fl)
199{
200 INIT_LIST_HEAD(&fl->fl_link);
201 INIT_LIST_HEAD(&fl->fl_block);
202 init_waitqueue_head(&fl->fl_wait);
203 fl->fl_next = NULL;
204 fl->fl_fasync = NULL;
205 fl->fl_owner = NULL;
206 fl->fl_pid = 0;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000207 fl->fl_nspid = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 fl->fl_file = NULL;
209 fl->fl_flags = 0;
210 fl->fl_type = 0;
211 fl->fl_start = fl->fl_end = 0;
212 fl->fl_ops = NULL;
213 fl->fl_lmops = NULL;
214}
215
216EXPORT_SYMBOL(locks_init_lock);
217
218/*
219 * Initialises the fields of the file lock which are invariant for
220 * free file_locks.
221 */
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700222static void init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223{
224 struct file_lock *lock = (struct file_lock *) foo;
225
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 locks_init_lock(lock);
227}
228
Trond Myklebust47831f32006-03-20 13:44:05 -0500229static void locks_copy_private(struct file_lock *new, struct file_lock *fl)
230{
231 if (fl->fl_ops) {
232 if (fl->fl_ops->fl_copy_lock)
233 fl->fl_ops->fl_copy_lock(new, fl);
234 new->fl_ops = fl->fl_ops;
235 }
236 if (fl->fl_lmops) {
237 if (fl->fl_lmops->fl_copy_lock)
238 fl->fl_lmops->fl_copy_lock(new, fl);
239 new->fl_lmops = fl->fl_lmops;
240 }
241}
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
420 switch (l->l_type) {
421 case F_RDLCK:
422 case F_WRLCK:
423 case F_UNLCK:
424 fl->fl_type = l->l_type;
425 break;
426 default:
427 return -EINVAL;
428 }
429
430 return (0);
431}
432#endif
433
434/* default lease lock manager operations */
435static void lease_break_callback(struct file_lock *fl)
436{
437 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
438}
439
440static void lease_release_private_callback(struct file_lock *fl)
441{
442 if (!fl->fl_file)
443 return;
444
445 f_delown(fl->fl_file);
446 fl->fl_file->f_owner.signum = 0;
447}
448
Adrian Bunk75c96f82005-05-05 16:16:09 -0700449static int lease_mylease_callback(struct file_lock *fl, struct file_lock *try)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450{
451 return fl->fl_file == try->fl_file;
452}
453
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700454static const struct lock_manager_operations lease_manager_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 .fl_break = lease_break_callback,
456 .fl_release_private = lease_release_private_callback,
457 .fl_mylease = lease_mylease_callback,
458 .fl_change = lease_modify,
459};
460
461/*
462 * Initialize a lease, use the default lock manager operations
463 */
464static int lease_init(struct file *filp, int type, struct file_lock *fl)
465 {
Trond Myklebust75dff552006-05-07 23:02:42 -0400466 if (assign_type(fl, type) != 0)
467 return -EINVAL;
468
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 fl->fl_owner = current->files;
470 fl->fl_pid = current->tgid;
471
472 fl->fl_file = filp;
473 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 fl->fl_start = 0;
475 fl->fl_end = OFFSET_MAX;
476 fl->fl_ops = NULL;
477 fl->fl_lmops = &lease_manager_ops;
478 return 0;
479}
480
481/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500482static struct file_lock *lease_alloc(struct file *filp, int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483{
484 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400485 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486
487 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500488 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
490 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400491 if (error) {
492 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500493 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400494 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500495 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496}
497
498/* Check if two locks overlap each other.
499 */
500static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
501{
502 return ((fl1->fl_end >= fl2->fl_start) &&
503 (fl2->fl_end >= fl1->fl_start));
504}
505
506/*
507 * Check whether two locks have the same owner.
508 */
Matt Mackall33443c42006-01-08 01:05:22 -0800509static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510{
511 if (fl1->fl_lmops && fl1->fl_lmops->fl_compare_owner)
512 return fl2->fl_lmops == fl1->fl_lmops &&
513 fl1->fl_lmops->fl_compare_owner(fl1, fl2);
514 return fl1->fl_owner == fl2->fl_owner;
515}
516
517/* Remove waiter from blocker's block list.
518 * When blocker ends up pointing to itself then the list is empty.
519 */
Matt Mackall33443c42006-01-08 01:05:22 -0800520static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521{
522 list_del_init(&waiter->fl_block);
523 list_del_init(&waiter->fl_link);
524 waiter->fl_next = NULL;
525}
526
527/*
528 */
529static void locks_delete_block(struct file_lock *waiter)
530{
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200531 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 __locks_delete_block(waiter);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200533 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534}
535
536/* Insert waiter into blocker's block list.
537 * We use a circular list so that processes can be easily woken up in
538 * the order they blocked. The documentation doesn't require this but
539 * it seems like the reasonable thing to do.
540 */
541static void locks_insert_block(struct file_lock *blocker,
542 struct file_lock *waiter)
543{
J. Bruce Fields6dc0fe82006-03-26 01:37:24 -0800544 BUG_ON(!list_empty(&waiter->fl_block));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 list_add_tail(&waiter->fl_block, &blocker->fl_block);
546 waiter->fl_next = blocker;
547 if (IS_POSIX(blocker))
548 list_add(&waiter->fl_link, &blocked_list);
549}
550
551/* Wake up processes blocked waiting for blocker.
552 * If told to wait then schedule the processes until the block list
553 * is empty, otherwise empty the block list ourselves.
554 */
555static void locks_wake_up_blocks(struct file_lock *blocker)
556{
557 while (!list_empty(&blocker->fl_block)) {
Pavel Emelyanovf0c1cd02007-09-19 16:44:07 +0400558 struct file_lock *waiter;
559
560 waiter = list_first_entry(&blocker->fl_block,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 struct file_lock, fl_block);
562 __locks_delete_block(waiter);
563 if (waiter->fl_lmops && waiter->fl_lmops->fl_notify)
564 waiter->fl_lmops->fl_notify(waiter);
565 else
566 wake_up(&waiter->fl_wait);
567 }
568}
569
570/* Insert file lock fl into an inode's lock list at the position indicated
571 * by pos. At the same time add the lock to the global file lock list.
572 */
573static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
574{
575 list_add(&fl->fl_link, &file_lock_list);
576
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000577 fl->fl_nspid = get_pid(task_tgid(current));
578
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 /* insert into file's list */
580 fl->fl_next = *pos;
581 *pos = fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582}
583
584/*
585 * Delete a lock and then free it.
586 * Wake up processes that are blocked waiting for this lock,
587 * notify the FS that the lock has been cleared and
588 * finally free the lock.
589 */
590static void locks_delete_lock(struct file_lock **thisfl_p)
591{
592 struct file_lock *fl = *thisfl_p;
593
594 *thisfl_p = fl->fl_next;
595 fl->fl_next = NULL;
596 list_del_init(&fl->fl_link);
597
598 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
599 if (fl->fl_fasync != NULL) {
600 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
601 fl->fl_fasync = NULL;
602 }
603
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000604 if (fl->fl_nspid) {
605 put_pid(fl->fl_nspid);
606 fl->fl_nspid = NULL;
607 }
608
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 locks_wake_up_blocks(fl);
610 locks_free_lock(fl);
611}
612
613/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
614 * checks for shared/exclusive status of overlapping locks.
615 */
616static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
617{
618 if (sys_fl->fl_type == F_WRLCK)
619 return 1;
620 if (caller_fl->fl_type == F_WRLCK)
621 return 1;
622 return 0;
623}
624
625/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
626 * checking before calling the locks_conflict().
627 */
628static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
629{
630 /* POSIX locks owned by the same process do not conflict with
631 * each other.
632 */
633 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
634 return (0);
635
636 /* Check whether they overlap */
637 if (!locks_overlap(caller_fl, sys_fl))
638 return 0;
639
640 return (locks_conflict(caller_fl, sys_fl));
641}
642
643/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
644 * checking before calling the locks_conflict().
645 */
646static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
647{
648 /* FLOCK locks referring to the same filp do not conflict with
649 * each other.
650 */
651 if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
652 return (0);
653 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
654 return 0;
655
656 return (locks_conflict(caller_fl, sys_fl));
657}
658
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400659void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500660posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661{
662 struct file_lock *cfl;
663
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200664 lock_flocks();
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800665 for (cfl = filp->f_path.dentry->d_inode->i_flock; cfl; cfl = cfl->fl_next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 if (!IS_POSIX(cfl))
667 continue;
J. Bruce Fieldsb842e242007-05-10 19:02:07 -0400668 if (posix_locks_conflict(fl, cfl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 break;
670 }
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000671 if (cfl) {
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500672 __locks_copy_lock(fl, cfl);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000673 if (cfl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -0800674 fl->fl_pid = pid_vnr(cfl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000675 } else
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400676 fl->fl_type = F_UNLCK;
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200677 unlock_flocks();
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400678 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680EXPORT_SYMBOL(posix_test_lock);
681
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400682/*
683 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400685 * We attempt to detect deadlocks that are due purely to posix file
686 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400688 * We assume that a task can be waiting for at most one lock at a time.
689 * So for any acquired lock, the process holding that lock may be
690 * waiting on at most one other lock. That lock in turns may be held by
691 * someone waiting for at most one other lock. Given a requested lock
692 * caller_fl which is about to wait for a conflicting lock block_fl, we
693 * follow this chain of waiters to ensure we are not about to create a
694 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400695 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400696 * Since we do this before we ever put a process to sleep on a lock, we
697 * are ensured that there is never a cycle; that is what guarantees that
698 * the while() loop in posix_locks_deadlock() eventually completes.
699 *
700 * Note: the above assumption may not be true when handling lock
701 * requests from a broken NFS client. It may also fail in the presence
702 * of tasks (such as posix threads) sharing the same open file table.
703 *
704 * To handle those cases, we just bail out after a few iterations.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400706
707#define MAX_DEADLK_ITERATIONS 10
708
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400709/* Find a lock that the owner of the given block_fl is blocking on. */
710static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
711{
712 struct file_lock *fl;
713
714 list_for_each_entry(fl, &blocked_list, fl_link) {
715 if (posix_same_owner(fl, block_fl))
716 return fl->fl_next;
717 }
718 return NULL;
719}
720
Adrian Bunkb0904e12006-06-23 02:05:13 -0700721static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 struct file_lock *block_fl)
723{
J. Bruce Fields97855b42007-10-30 11:20:02 -0400724 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400726 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
727 if (i++ > MAX_DEADLK_ITERATIONS)
728 return 0;
729 if (posix_same_owner(caller_fl, block_fl))
730 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 }
732 return 0;
733}
734
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -0400736 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -0400737 *
738 * Note that if called with an FL_EXISTS argument, the caller may determine
739 * whether or not a lock was successfully freed by testing the return
740 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 */
Trond Myklebust993dfa82006-03-31 02:30:55 -0800742static int flock_lock_file(struct file *filp, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743{
Trond Myklebust993dfa82006-03-31 02:30:55 -0800744 struct file_lock *new_fl = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 struct file_lock **before;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800746 struct inode * inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 int error = 0;
748 int found = 0;
749
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200750 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
751 new_fl = locks_alloc_lock();
752 if (!new_fl)
753 return -ENOMEM;
754 }
755
756 lock_flocks();
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400757 if (request->fl_flags & FL_ACCESS)
758 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +0400759
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 for_each_lock(inode, before) {
761 struct file_lock *fl = *before;
762 if (IS_POSIX(fl))
763 break;
764 if (IS_LEASE(fl))
765 continue;
766 if (filp != fl->fl_file)
767 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800768 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 goto out;
770 found = 1;
771 locks_delete_lock(before);
772 break;
773 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774
Trond Myklebustf475ae92006-06-29 16:38:32 -0400775 if (request->fl_type == F_UNLCK) {
776 if ((request->fl_flags & FL_EXISTS) && !found)
777 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800778 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400779 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780
781 /*
782 * If a higher-priority process was blocked on the old file lock,
783 * give it the opportunity to lock the file.
784 */
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200785 if (found) {
786 unlock_flocks();
Frederic Weisbeckerdef01bc2009-07-16 15:44:29 +0200787 cond_resched();
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200788 lock_flocks();
789 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400791find_conflict:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 for_each_lock(inode, before) {
793 struct file_lock *fl = *before;
794 if (IS_POSIX(fl))
795 break;
796 if (IS_LEASE(fl))
797 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800798 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 continue;
800 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700801 if (!(request->fl_flags & FL_SLEEP))
802 goto out;
803 error = FILE_LOCK_DEFERRED;
804 locks_insert_block(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 goto out;
806 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400807 if (request->fl_flags & FL_ACCESS)
808 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800809 locks_copy_lock(new_fl, request);
Pavel Emelyanov0e2f6db2007-09-11 15:24:01 -0700810 locks_insert_lock(before, new_fl);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800811 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +0400812 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
814out:
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200815 unlock_flocks();
Trond Myklebust993dfa82006-03-31 02:30:55 -0800816 if (new_fl)
817 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 return error;
819}
820
Marc Eshel150b3932007-01-18 16:15:35 -0500821static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822{
823 struct file_lock *fl;
Miklos Szeredi39005d02006-06-23 02:05:10 -0700824 struct file_lock *new_fl = NULL;
825 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 struct file_lock *left = NULL;
827 struct file_lock *right = NULL;
828 struct file_lock **before;
829 int error, added = 0;
830
831 /*
832 * We may need two file_lock structures for this operation,
833 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -0700834 *
835 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 */
Miklos Szeredi39005d02006-06-23 02:05:10 -0700837 if (!(request->fl_flags & FL_ACCESS) &&
838 (request->fl_type != F_UNLCK ||
839 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
840 new_fl = locks_alloc_lock();
841 new_fl2 = locks_alloc_lock();
842 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200844 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 if (request->fl_type != F_UNLCK) {
846 for_each_lock(inode, before) {
J. Bruce Fields526985b2006-11-14 16:54:36 -0500847 fl = *before;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 if (!IS_POSIX(fl))
849 continue;
850 if (!posix_locks_conflict(request, fl))
851 continue;
Andy Adamson5842add2006-03-26 01:37:26 -0800852 if (conflock)
J. Bruce Fields1a747ee2008-04-24 10:08:22 -0400853 __locks_copy_lock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 error = -EAGAIN;
855 if (!(request->fl_flags & FL_SLEEP))
856 goto out;
857 error = -EDEADLK;
858 if (posix_locks_deadlock(request, fl))
859 goto out;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700860 error = FILE_LOCK_DEFERRED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 locks_insert_block(fl, request);
862 goto out;
863 }
864 }
865
866 /* If we're just looking for a conflict, we're done. */
867 error = 0;
868 if (request->fl_flags & FL_ACCESS)
869 goto out;
870
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 * Find the first old lock with the same owner as the new lock.
873 */
874
875 before = &inode->i_flock;
876
877 /* First skip locks owned by other processes. */
878 while ((fl = *before) && (!IS_POSIX(fl) ||
879 !posix_same_owner(request, fl))) {
880 before = &fl->fl_next;
881 }
882
883 /* Process locks with this owner. */
884 while ((fl = *before) && posix_same_owner(request, fl)) {
885 /* Detect adjacent or overlapping regions (if same lock type)
886 */
887 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -0700888 /* In all comparisons of start vs end, use
889 * "start - 1" rather than "end + 1". If end
890 * is OFFSET_MAX, end + 1 will become negative.
891 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 if (fl->fl_end < request->fl_start - 1)
893 goto next_lock;
894 /* If the next lock in the list has entirely bigger
895 * addresses than the new one, insert the lock here.
896 */
Olaf Kirch449231d2005-08-25 16:25:35 -0700897 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 break;
899
900 /* If we come here, the new and old lock are of the
901 * same type and adjacent or overlapping. Make one
902 * lock yielding from the lower start address of both
903 * locks to the higher end address.
904 */
905 if (fl->fl_start > request->fl_start)
906 fl->fl_start = request->fl_start;
907 else
908 request->fl_start = fl->fl_start;
909 if (fl->fl_end < request->fl_end)
910 fl->fl_end = request->fl_end;
911 else
912 request->fl_end = fl->fl_end;
913 if (added) {
914 locks_delete_lock(before);
915 continue;
916 }
917 request = fl;
918 added = 1;
919 }
920 else {
921 /* Processing for different lock types is a bit
922 * more complex.
923 */
924 if (fl->fl_end < request->fl_start)
925 goto next_lock;
926 if (fl->fl_start > request->fl_end)
927 break;
928 if (request->fl_type == F_UNLCK)
929 added = 1;
930 if (fl->fl_start < request->fl_start)
931 left = fl;
932 /* If the next lock in the list has a higher end
933 * address than the new one, insert the new one here.
934 */
935 if (fl->fl_end > request->fl_end) {
936 right = fl;
937 break;
938 }
939 if (fl->fl_start >= request->fl_start) {
940 /* The new lock completely replaces an old
941 * one (This may happen several times).
942 */
943 if (added) {
944 locks_delete_lock(before);
945 continue;
946 }
947 /* Replace the old lock with the new one.
948 * Wake up anybody waiting for the old one,
949 * as the change in lock type might satisfy
950 * their needs.
951 */
952 locks_wake_up_blocks(fl);
953 fl->fl_start = request->fl_start;
954 fl->fl_end = request->fl_end;
955 fl->fl_type = request->fl_type;
Trond Myklebust47831f32006-03-20 13:44:05 -0500956 locks_release_private(fl);
957 locks_copy_private(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 request = fl;
959 added = 1;
960 }
961 }
962 /* Go on to next lock.
963 */
964 next_lock:
965 before = &fl->fl_next;
966 }
967
Miklos Szeredi0d9a4902006-06-23 02:05:09 -0700968 /*
969 * The above code only modifies existing locks in case of
970 * merging or replacing. If new lock(s) need to be inserted
971 * all modifications are done bellow this, so it's safe yet to
972 * bail out.
973 */
974 error = -ENOLCK; /* "no luck" */
975 if (right && left == right && !new_fl2)
976 goto out;
977
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 error = 0;
979 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -0400980 if (request->fl_type == F_UNLCK) {
981 if (request->fl_flags & FL_EXISTS)
982 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400984 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -0700985
986 if (!new_fl) {
987 error = -ENOLCK;
988 goto out;
989 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 locks_copy_lock(new_fl, request);
991 locks_insert_lock(before, new_fl);
992 new_fl = NULL;
993 }
994 if (right) {
995 if (left == right) {
996 /* The new lock breaks the old one in two pieces,
997 * so we have to use the second new lock.
998 */
999 left = new_fl2;
1000 new_fl2 = NULL;
1001 locks_copy_lock(left, right);
1002 locks_insert_lock(before, left);
1003 }
1004 right->fl_start = request->fl_end + 1;
1005 locks_wake_up_blocks(right);
1006 }
1007 if (left) {
1008 left->fl_end = request->fl_start - 1;
1009 locks_wake_up_blocks(left);
1010 }
1011 out:
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001012 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 /*
1014 * Free any unused locks.
1015 */
1016 if (new_fl)
1017 locks_free_lock(new_fl);
1018 if (new_fl2)
1019 locks_free_lock(new_fl2);
1020 return error;
1021}
1022
1023/**
1024 * posix_lock_file - Apply a POSIX-style lock to a file
1025 * @filp: The file to apply the lock to
1026 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001027 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 *
1029 * Add a POSIX style lock to a file.
1030 * We merge adjacent & overlapping locks whenever possible.
1031 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001032 *
1033 * Note that if called with an FL_EXISTS argument, the caller may determine
1034 * whether or not a lock was successfully freed by testing the return
1035 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 */
Marc Eshel150b3932007-01-18 16:15:35 -05001037int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001038 struct file_lock *conflock)
1039{
Marc Eshel150b3932007-01-18 16:15:35 -05001040 return __posix_lock_file(filp->f_path.dentry->d_inode, fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001041}
Marc Eshel150b3932007-01-18 16:15:35 -05001042EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043
1044/**
1045 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1046 * @filp: The file to apply the lock to
1047 * @fl: The lock to be applied
1048 *
1049 * Add a POSIX style lock to a file.
1050 * We merge adjacent & overlapping locks whenever possible.
1051 * POSIX locks are sorted by owner task, then by starting address
1052 */
1053int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1054{
1055 int error;
1056 might_sleep ();
1057 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001058 error = posix_lock_file(filp, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001059 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 break;
1061 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1062 if (!error)
1063 continue;
1064
1065 locks_delete_block(fl);
1066 break;
1067 }
1068 return error;
1069}
1070EXPORT_SYMBOL(posix_lock_file_wait);
1071
1072/**
1073 * locks_mandatory_locked - Check for an active lock
1074 * @inode: the file to check
1075 *
1076 * Searches the inode's list of locks to find any POSIX locks which conflict.
1077 * This function is called from locks_verify_locked() only.
1078 */
1079int locks_mandatory_locked(struct inode *inode)
1080{
1081 fl_owner_t owner = current->files;
1082 struct file_lock *fl;
1083
1084 /*
1085 * Search the lock list for this inode for any POSIX locks.
1086 */
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001087 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1089 if (!IS_POSIX(fl))
1090 continue;
1091 if (fl->fl_owner != owner)
1092 break;
1093 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001094 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 return fl ? -EAGAIN : 0;
1096}
1097
1098/**
1099 * locks_mandatory_area - Check for a conflicting lock
1100 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1101 * for shared
1102 * @inode: the file to check
1103 * @filp: how the file was opened (if it was)
1104 * @offset: start of area to check
1105 * @count: length of area to check
1106 *
1107 * Searches the inode's list of locks to find any POSIX locks which conflict.
1108 * This function is called from rw_verify_area() and
1109 * locks_verify_truncate().
1110 */
1111int locks_mandatory_area(int read_write, struct inode *inode,
1112 struct file *filp, loff_t offset,
1113 size_t count)
1114{
1115 struct file_lock fl;
1116 int error;
1117
1118 locks_init_lock(&fl);
1119 fl.fl_owner = current->files;
1120 fl.fl_pid = current->tgid;
1121 fl.fl_file = filp;
1122 fl.fl_flags = FL_POSIX | FL_ACCESS;
1123 if (filp && !(filp->f_flags & O_NONBLOCK))
1124 fl.fl_flags |= FL_SLEEP;
1125 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1126 fl.fl_start = offset;
1127 fl.fl_end = offset + count - 1;
1128
1129 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001130 error = __posix_lock_file(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001131 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132 break;
1133 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1134 if (!error) {
1135 /*
1136 * If we've been sleeping someone might have
1137 * changed the permissions behind our back.
1138 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001139 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 continue;
1141 }
1142
1143 locks_delete_block(&fl);
1144 break;
1145 }
1146
1147 return error;
1148}
1149
1150EXPORT_SYMBOL(locks_mandatory_area);
1151
1152/* We already had a lease on this file; just change its type */
1153int lease_modify(struct file_lock **before, int arg)
1154{
1155 struct file_lock *fl = *before;
1156 int error = assign_type(fl, arg);
1157
1158 if (error)
1159 return error;
1160 locks_wake_up_blocks(fl);
1161 if (arg == F_UNLCK)
1162 locks_delete_lock(before);
1163 return 0;
1164}
1165
1166EXPORT_SYMBOL(lease_modify);
1167
1168static void time_out_leases(struct inode *inode)
1169{
1170 struct file_lock **before;
1171 struct file_lock *fl;
1172
1173 before = &inode->i_flock;
1174 while ((fl = *before) && IS_LEASE(fl) && (fl->fl_type & F_INPROGRESS)) {
1175 if ((fl->fl_break_time == 0)
1176 || time_before(jiffies, fl->fl_break_time)) {
1177 before = &fl->fl_next;
1178 continue;
1179 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 lease_modify(before, fl->fl_type & ~F_INPROGRESS);
1181 if (fl == *before) /* lease_modify may have freed fl */
1182 before = &fl->fl_next;
1183 }
1184}
1185
1186/**
1187 * __break_lease - revoke all outstanding leases on file
1188 * @inode: the inode of the file to return
1189 * @mode: the open mode (read or write)
1190 *
david m. richter87250dd2007-05-09 16:10:27 -04001191 * break_lease (inlined for speed) has checked there already is at least
1192 * some kind of lock (maybe a lease) on this file. Leases are broken on
1193 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 * specified %O_NONBLOCK to your open().
1195 */
1196int __break_lease(struct inode *inode, unsigned int mode)
1197{
1198 int error = 0, future;
1199 struct file_lock *new_fl, *flock;
1200 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 unsigned long break_time;
1202 int i_have_this_lease = 0;
Al Viro8737c932009-12-24 06:47:55 -05001203 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204
Al Viro8737c932009-12-24 06:47:55 -05001205 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
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
1215 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next)
1216 if (fl->fl_owner == current->files)
1217 i_have_this_lease = 1;
1218
Al Viro8737c932009-12-24 06:47:55 -05001219 if (want_write) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 /* If we want write access, we have to revoke any lease. */
1221 future = F_UNLCK | F_INPROGRESS;
1222 } else if (flock->fl_type & F_INPROGRESS) {
1223 /* If the lease is already being broken, we just leave it */
1224 future = flock->fl_type;
1225 } else if (flock->fl_type & F_WRLCK) {
1226 /* Downgrade the exclusive lease to a read-only lease. */
1227 future = F_RDLCK | F_INPROGRESS;
1228 } else {
1229 /* the existing lease was read-only, so we can read too. */
1230 goto out;
1231 }
1232
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -05001233 if (IS_ERR(new_fl) && !i_have_this_lease
1234 && ((mode & O_NONBLOCK) == 0)) {
1235 error = PTR_ERR(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 goto out;
1237 }
1238
1239 break_time = 0;
1240 if (lease_break_time > 0) {
1241 break_time = jiffies + lease_break_time * HZ;
1242 if (break_time == 0)
1243 break_time++; /* so that 0 means no break time */
1244 }
1245
1246 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1247 if (fl->fl_type != future) {
1248 fl->fl_type = future;
1249 fl->fl_break_time = break_time;
1250 /* lease must have lmops break callback */
1251 fl->fl_lmops->fl_break(fl);
1252 }
1253 }
1254
1255 if (i_have_this_lease || (mode & O_NONBLOCK)) {
1256 error = -EWOULDBLOCK;
1257 goto out;
1258 }
1259
1260restart:
1261 break_time = flock->fl_break_time;
1262 if (break_time != 0) {
1263 break_time -= jiffies;
1264 if (break_time == 0)
1265 break_time++;
1266 }
Matthew Wilcox4321e012008-01-14 21:28:30 -07001267 locks_insert_block(flock, new_fl);
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001268 unlock_flocks();
Matthew Wilcox4321e012008-01-14 21:28:30 -07001269 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1270 !new_fl->fl_next, break_time);
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001271 lock_flocks();
Matthew Wilcox4321e012008-01-14 21:28:30 -07001272 __locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 if (error >= 0) {
1274 if (error == 0)
1275 time_out_leases(inode);
1276 /* Wait for the next lease that has not been broken yet */
1277 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1278 flock = flock->fl_next) {
1279 if (flock->fl_type & F_INPROGRESS)
1280 goto restart;
1281 }
1282 error = 0;
1283 }
1284
1285out:
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001286 unlock_flocks();
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -05001287 if (!IS_ERR(new_fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 locks_free_lock(new_fl);
1289 return error;
1290}
1291
1292EXPORT_SYMBOL(__break_lease);
1293
1294/**
Randy Dunlapa6b91912008-03-19 17:01:00 -07001295 * lease_get_mtime - get the last modified time of an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 * @inode: the inode
1297 * @time: pointer to a timespec which will contain the last modified time
1298 *
1299 * This is to force NFS clients to flush their caches for files with
1300 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001301 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302 */
1303void lease_get_mtime(struct inode *inode, struct timespec *time)
1304{
1305 struct file_lock *flock = inode->i_flock;
1306 if (flock && IS_LEASE(flock) && (flock->fl_type & F_WRLCK))
1307 *time = current_fs_time(inode->i_sb);
1308 else
1309 *time = inode->i_mtime;
1310}
1311
1312EXPORT_SYMBOL(lease_get_mtime);
1313
1314/**
1315 * fcntl_getlease - Enquire what lease is currently active
1316 * @filp: the file
1317 *
1318 * The value returned by this function will be one of
1319 * (if no lease break is pending):
1320 *
1321 * %F_RDLCK to indicate a shared lease is held.
1322 *
1323 * %F_WRLCK to indicate an exclusive lease is held.
1324 *
1325 * %F_UNLCK to indicate no lease is held.
1326 *
1327 * (if a lease break is pending):
1328 *
1329 * %F_RDLCK to indicate an exclusive lease needs to be
1330 * changed to a shared lease (or removed).
1331 *
1332 * %F_UNLCK to indicate the lease needs to be removed.
1333 *
1334 * XXX: sfr & willy disagree over whether F_INPROGRESS
1335 * should be returned to userspace.
1336 */
1337int fcntl_getlease(struct file *filp)
1338{
1339 struct file_lock *fl;
1340 int type = F_UNLCK;
1341
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001342 lock_flocks();
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001343 time_out_leases(filp->f_path.dentry->d_inode);
1344 for (fl = filp->f_path.dentry->d_inode->i_flock; fl && IS_LEASE(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 fl = fl->fl_next) {
1346 if (fl->fl_file == filp) {
1347 type = fl->fl_type & ~F_INPROGRESS;
1348 break;
1349 }
1350 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001351 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 return type;
1353}
1354
1355/**
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001356 * generic_setlease - sets a lease on an open file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 * @filp: file pointer
1358 * @arg: type of lease to obtain
1359 * @flp: input - file_lock to use, output - file_lock inserted
1360 *
1361 * The (input) flp->fl_lmops->fl_break function is required
1362 * by break_lease().
1363 *
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001364 * Called with file_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 */
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001366int generic_setlease(struct file *filp, long arg, struct file_lock **flp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367{
KAMBAROV, ZAUR7eaae282005-07-07 17:57:06 -07001368 struct file_lock *fl, **before, **my_before = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001369 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 struct inode *inode = dentry->d_inode;
1371 int error, rdlease_count = 0, wrlease_count = 0;
1372
David Howellsda9592e2008-11-14 10:39:05 +11001373 if ((current_fsuid() != inode->i_uid) && !capable(CAP_LEASE))
J. Bruce Fields6d5e8b02007-05-31 17:03:46 -04001374 return -EACCES;
1375 if (!S_ISREG(inode->i_mode))
1376 return -EINVAL;
1377 error = security_file_lock(filp, arg);
1378 if (error)
1379 return error;
1380
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 time_out_leases(inode);
1382
J. Bruce Fieldsd2ab0b0c2007-06-30 12:40:32 -04001383 BUG_ON(!(*flp)->fl_lmops->fl_break);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384
KAMBAROV, ZAUR7eaae282005-07-07 17:57:06 -07001385 lease = *flp;
1386
David M. Richter288b2fd2008-04-23 16:29:00 -04001387 if (arg != F_UNLCK) {
1388 error = -EAGAIN;
1389 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1390 goto out;
1391 if ((arg == F_WRLCK)
1392 && ((atomic_read(&dentry->d_count) > 1)
1393 || (atomic_read(&inode->i_count) > 1)))
1394 goto out;
David M. Richter288b2fd2008-04-23 16:29:00 -04001395 }
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001396
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 /*
1398 * At this point, we know that if there is an exclusive
1399 * lease on this file, then we hold it on this filp
1400 * (otherwise our open of this file would have blocked).
1401 * And if we are trying to acquire an exclusive lease,
1402 * then the file is not open by anyone (including us)
1403 * except for this filp.
1404 */
1405 for (before = &inode->i_flock;
1406 ((fl = *before) != NULL) && IS_LEASE(fl);
1407 before = &fl->fl_next) {
1408 if (lease->fl_lmops->fl_mylease(fl, lease))
1409 my_before = before;
1410 else if (fl->fl_type == (F_INPROGRESS | F_UNLCK))
1411 /*
1412 * Someone is in the process of opening this
1413 * file for writing so we may not take an
1414 * exclusive lease on it.
1415 */
1416 wrlease_count++;
1417 else
1418 rdlease_count++;
1419 }
1420
David M. Richter5fcc60c2008-04-23 16:28:59 -04001421 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 if ((arg == F_RDLCK && (wrlease_count > 0)) ||
1423 (arg == F_WRLCK && ((rdlease_count + wrlease_count) > 0)))
1424 goto out;
1425
1426 if (my_before != NULL) {
Trond Myklebust75dff552006-05-07 23:02:42 -04001427 *flp = *my_before;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428 error = lease->fl_lmops->fl_change(my_before, arg);
1429 goto out;
1430 }
1431
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 if (arg == F_UNLCK)
1433 goto out;
1434
1435 error = -EINVAL;
1436 if (!leases_enable)
1437 goto out;
1438
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001439 locks_insert_lock(before, lease);
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001440 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442out:
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001443 locks_free_lock(lease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 return error;
1445}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001446EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001448static int __vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
1449{
1450 if (filp->f_op && filp->f_op->setlease)
1451 return filp->f_op->setlease(filp, arg, lease);
1452 else
1453 return generic_setlease(filp, arg, lease);
1454}
1455
1456/**
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001457 * vfs_setlease - sets a lease on an open file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 * @filp: file pointer
1459 * @arg: type of lease to obtain
1460 * @lease: file_lock to use
1461 *
1462 * Call this to establish a lease on the file.
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001463 * The (*lease)->fl_lmops->fl_break operation must be set; if not,
1464 * break_lease will oops!
1465 *
1466 * This will call the filesystem's setlease file method, if
1467 * defined. Note that there is no getlease method; instead, the
1468 * filesystem setlease method should call back to setlease() to
1469 * add a lease to the inode's lease list, where fcntl_getlease() can
1470 * find it. Since fcntl_getlease() only reports whether the current
1471 * task holds a lease, a cluster filesystem need only do this for
1472 * leases held by processes on this node.
1473 *
1474 * There is also no break_lease method; filesystems that
Adam Buchbinderc9404c92009-12-18 15:40:42 -05001475 * handle their own leases should break leases themselves from the
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001476 * filesystem's open, create, and (on truncate) setattr methods.
1477 *
1478 * Warning: the only current setlease methods exist only to disable
1479 * leases in certain cases. More vfs changes may be required to
1480 * allow a full filesystem lease implementation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481 */
1482
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001483int vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485 int error;
1486
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001487 lock_flocks();
1488 error = __vfs_setlease(filp, arg, lease);
1489 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490
1491 return error;
1492}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001493EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494
1495/**
1496 * fcntl_setlease - sets a lease on an open file
1497 * @fd: open file descriptor
1498 * @filp: file pointer
1499 * @arg: type of lease to obtain
1500 *
1501 * Call this fcntl to establish a lease on the file.
1502 * Note that you also need to call %F_SETSIG to
1503 * receive a signal when the lease is broken.
1504 */
1505int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1506{
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001507 struct file_lock *fl;
David M. Richter9d91cdc2008-04-23 16:29:02 -04001508 struct inode *inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 int error;
1510
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001511 fl = lease_alloc(filp, arg);
1512 if (IS_ERR(fl))
1513 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001515 lock_flocks();
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001516 error = __vfs_setlease(filp, arg, &fl);
J. Bruce Fieldsdc15ae12005-11-10 19:08:00 -05001517 if (error || arg == F_UNLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 goto out_unlock;
1519
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001520 error = fasync_helper(fd, filp, 1, &fl->fl_fasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 if (error < 0) {
J. Bruce Fields6d5e8b02007-05-31 17:03:46 -04001522 /* remove lease just inserted by setlease */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001523 fl->fl_type = F_UNLCK | F_INPROGRESS;
1524 fl->fl_break_time = jiffies - 10;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 time_out_leases(inode);
1526 goto out_unlock;
1527 }
1528
Eric W. Biederman609d7fa2006-10-02 02:17:15 -07001529 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530out_unlock:
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001531 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532 return error;
1533}
1534
1535/**
1536 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1537 * @filp: The file to apply the lock to
1538 * @fl: The lock to be applied
1539 *
1540 * Add a FLOCK style lock to a file.
1541 */
1542int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1543{
1544 int error;
1545 might_sleep();
1546 for (;;) {
1547 error = flock_lock_file(filp, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001548 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 break;
1550 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1551 if (!error)
1552 continue;
1553
1554 locks_delete_block(fl);
1555 break;
1556 }
1557 return error;
1558}
1559
1560EXPORT_SYMBOL(flock_lock_file_wait);
1561
1562/**
1563 * sys_flock: - flock() system call.
1564 * @fd: the file descriptor to lock.
1565 * @cmd: the type of lock to apply.
1566 *
1567 * Apply a %FL_FLOCK style lock to an open file descriptor.
1568 * The @cmd can be one of
1569 *
1570 * %LOCK_SH -- a shared lock.
1571 *
1572 * %LOCK_EX -- an exclusive lock.
1573 *
1574 * %LOCK_UN -- remove an existing lock.
1575 *
1576 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1577 *
1578 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1579 * processes read and write access respectively.
1580 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001581SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582{
1583 struct file *filp;
1584 struct file_lock *lock;
1585 int can_sleep, unlock;
1586 int error;
1587
1588 error = -EBADF;
1589 filp = fget(fd);
1590 if (!filp)
1591 goto out;
1592
1593 can_sleep = !(cmd & LOCK_NB);
1594 cmd &= ~LOCK_NB;
1595 unlock = (cmd == LOCK_UN);
1596
Al Viroaeb5d722008-09-02 15:28:45 -04001597 if (!unlock && !(cmd & LOCK_MAND) &&
1598 !(filp->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 goto out_putf;
1600
1601 error = flock_make_lock(filp, &lock, cmd);
1602 if (error)
1603 goto out_putf;
1604 if (can_sleep)
1605 lock->fl_flags |= FL_SLEEP;
1606
Sten Spans713c0ec2009-07-16 09:41:39 +02001607 error = security_file_lock(filp, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 if (error)
1609 goto out_free;
1610
1611 if (filp->f_op && filp->f_op->flock)
1612 error = filp->f_op->flock(filp,
1613 (can_sleep) ? F_SETLKW : F_SETLK,
1614 lock);
1615 else
1616 error = flock_lock_file_wait(filp, lock);
1617
1618 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08001619 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620
1621 out_putf:
1622 fput(filp);
1623 out:
1624 return error;
1625}
1626
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001627/**
1628 * vfs_test_lock - test file byte range lock
1629 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04001630 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001631 *
1632 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1633 * setting conf->fl_type to something other than F_UNLCK.
1634 */
1635int vfs_test_lock(struct file *filp, struct file_lock *fl)
1636{
1637 if (filp->f_op && filp->f_op->lock)
1638 return filp->f_op->lock(filp, F_GETLK, fl);
1639 posix_test_lock(filp, fl);
1640 return 0;
1641}
1642EXPORT_SYMBOL_GPL(vfs_test_lock);
1643
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001644static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1645{
1646 flock->l_pid = fl->fl_pid;
1647#if BITS_PER_LONG == 32
1648 /*
1649 * Make sure we can represent the posix lock via
1650 * legacy 32bit flock.
1651 */
1652 if (fl->fl_start > OFFT_OFFSET_MAX)
1653 return -EOVERFLOW;
1654 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1655 return -EOVERFLOW;
1656#endif
1657 flock->l_start = fl->fl_start;
1658 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1659 fl->fl_end - fl->fl_start + 1;
1660 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04001661 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001662 return 0;
1663}
1664
1665#if BITS_PER_LONG == 32
1666static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1667{
1668 flock->l_pid = fl->fl_pid;
1669 flock->l_start = fl->fl_start;
1670 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1671 fl->fl_end - fl->fl_start + 1;
1672 flock->l_whence = 0;
1673 flock->l_type = fl->fl_type;
1674}
1675#endif
1676
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677/* Report the first existing lock that would conflict with l.
1678 * This implements the F_GETLK command of fcntl().
1679 */
1680int fcntl_getlk(struct file *filp, struct flock __user *l)
1681{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001682 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683 struct flock flock;
1684 int error;
1685
1686 error = -EFAULT;
1687 if (copy_from_user(&flock, l, sizeof(flock)))
1688 goto out;
1689 error = -EINVAL;
1690 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1691 goto out;
1692
1693 error = flock_to_posix_lock(filp, &file_lock, &flock);
1694 if (error)
1695 goto out;
1696
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001697 error = vfs_test_lock(filp, &file_lock);
1698 if (error)
1699 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001701 flock.l_type = file_lock.fl_type;
1702 if (file_lock.fl_type != F_UNLCK) {
1703 error = posix_lock_to_flock(&flock, &file_lock);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001704 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 }
1707 error = -EFAULT;
1708 if (!copy_to_user(l, &flock, sizeof(flock)))
1709 error = 0;
1710out:
1711 return error;
1712}
1713
Marc Eshel7723ec92007-01-18 15:08:55 -05001714/**
1715 * vfs_lock_file - file byte range lock
1716 * @filp: The file to apply the lock to
1717 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1718 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001719 * @conf: Place to return a copy of the conflicting lock, if found.
1720 *
1721 * A caller that doesn't care about the conflicting lock may pass NULL
1722 * as the final argument.
1723 *
1724 * If the filesystem defines a private ->lock() method, then @conf will
1725 * be left unchanged; so a caller that cares should initialize it to
1726 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05001727 *
1728 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1729 * locks, the ->lock() interface may return asynchronously, before the lock has
1730 * been granted or denied by the underlying filesystem, if (and only if)
1731 * fl_grant is set. Callers expecting ->lock() to return asynchronously
1732 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1733 * the request is for a blocking lock. When ->lock() does return asynchronously,
Miklos Szeredibde74e42008-07-25 01:48:57 -07001734 * it must return FILE_LOCK_DEFERRED, and call ->fl_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05001735 * request completes.
1736 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07001737 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
1738 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05001739 * nonzero return code and the file system should release the lock. The file
1740 * system is also responsible to keep a corresponding posix lock when it
1741 * grants a lock so the VFS can find out which locks are locally held and do
1742 * the correct lock cleanup when required.
1743 * The underlying filesystem must not drop the kernel lock or call
Miklos Szeredibde74e42008-07-25 01:48:57 -07001744 * ->fl_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05001745 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05001746 */
Marc Eshel150b3932007-01-18 16:15:35 -05001747int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05001748{
1749 if (filp->f_op && filp->f_op->lock)
1750 return filp->f_op->lock(filp, cmd, fl);
1751 else
Marc Eshel150b3932007-01-18 16:15:35 -05001752 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05001753}
1754EXPORT_SYMBOL_GPL(vfs_lock_file);
1755
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001756static int do_lock_file_wait(struct file *filp, unsigned int cmd,
1757 struct file_lock *fl)
1758{
1759 int error;
1760
1761 error = security_file_lock(filp, fl->fl_type);
1762 if (error)
1763 return error;
1764
Miklos Szeredi764c76b2008-07-25 01:48:58 -07001765 for (;;) {
1766 error = vfs_lock_file(filp, cmd, fl, NULL);
1767 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001768 break;
Miklos Szeredi764c76b2008-07-25 01:48:58 -07001769 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1770 if (!error)
1771 continue;
1772
1773 locks_delete_block(fl);
1774 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001775 }
1776
1777 return error;
1778}
1779
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780/* Apply the lock described by l to an open file descriptor.
1781 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1782 */
Peter Staubachc2936212005-07-27 11:45:09 -07001783int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
1784 struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785{
1786 struct file_lock *file_lock = locks_alloc_lock();
1787 struct flock flock;
1788 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04001789 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 int error;
1791
1792 if (file_lock == NULL)
1793 return -ENOLCK;
1794
1795 /*
1796 * This might block, so we do it before checking the inode.
1797 */
1798 error = -EFAULT;
1799 if (copy_from_user(&flock, l, sizeof(flock)))
1800 goto out;
1801
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001802 inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803
1804 /* Don't allow mandatory locks on files that may be memory mapped
1805 * and shared.
1806 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001807 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 error = -EAGAIN;
1809 goto out;
1810 }
1811
Peter Staubachc2936212005-07-27 11:45:09 -07001812again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 error = flock_to_posix_lock(filp, file_lock, &flock);
1814 if (error)
1815 goto out;
1816 if (cmd == F_SETLKW) {
1817 file_lock->fl_flags |= FL_SLEEP;
1818 }
1819
1820 error = -EBADF;
1821 switch (flock.l_type) {
1822 case F_RDLCK:
1823 if (!(filp->f_mode & FMODE_READ))
1824 goto out;
1825 break;
1826 case F_WRLCK:
1827 if (!(filp->f_mode & FMODE_WRITE))
1828 goto out;
1829 break;
1830 case F_UNLCK:
1831 break;
1832 default:
1833 error = -EINVAL;
1834 goto out;
1835 }
1836
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001837 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838
Peter Staubachc2936212005-07-27 11:45:09 -07001839 /*
1840 * Attempt to detect a close/fcntl race and recover by
1841 * releasing the lock that was just acquired.
1842 */
Al Viro0b2bac22008-05-06 13:58:34 -04001843 /*
1844 * we need that spin_lock here - it prevents reordering between
1845 * update of inode->i_flock and check for it done in close().
1846 * rcu_read_lock() wouldn't do.
1847 */
1848 spin_lock(&current->files->file_lock);
1849 f = fcheck(fd);
1850 spin_unlock(&current->files->file_lock);
1851 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07001852 flock.l_type = F_UNLCK;
1853 goto again;
1854 }
1855
1856out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 locks_free_lock(file_lock);
1858 return error;
1859}
1860
1861#if BITS_PER_LONG == 32
1862/* Report the first existing lock that would conflict with l.
1863 * This implements the F_GETLK command of fcntl().
1864 */
1865int fcntl_getlk64(struct file *filp, struct flock64 __user *l)
1866{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001867 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 struct flock64 flock;
1869 int error;
1870
1871 error = -EFAULT;
1872 if (copy_from_user(&flock, l, sizeof(flock)))
1873 goto out;
1874 error = -EINVAL;
1875 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1876 goto out;
1877
1878 error = flock64_to_posix_lock(filp, &file_lock, &flock);
1879 if (error)
1880 goto out;
1881
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001882 error = vfs_test_lock(filp, &file_lock);
1883 if (error)
1884 goto out;
1885
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001886 flock.l_type = file_lock.fl_type;
1887 if (file_lock.fl_type != F_UNLCK)
1888 posix_lock_to_flock64(&flock, &file_lock);
1889
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 error = -EFAULT;
1891 if (!copy_to_user(l, &flock, sizeof(flock)))
1892 error = 0;
1893
1894out:
1895 return error;
1896}
1897
1898/* Apply the lock described by l to an open file descriptor.
1899 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1900 */
Peter Staubachc2936212005-07-27 11:45:09 -07001901int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
1902 struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903{
1904 struct file_lock *file_lock = locks_alloc_lock();
1905 struct flock64 flock;
1906 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04001907 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 int error;
1909
1910 if (file_lock == NULL)
1911 return -ENOLCK;
1912
1913 /*
1914 * This might block, so we do it before checking the inode.
1915 */
1916 error = -EFAULT;
1917 if (copy_from_user(&flock, l, sizeof(flock)))
1918 goto out;
1919
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001920 inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921
1922 /* Don't allow mandatory locks on files that may be memory mapped
1923 * and shared.
1924 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001925 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 error = -EAGAIN;
1927 goto out;
1928 }
1929
Peter Staubachc2936212005-07-27 11:45:09 -07001930again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 error = flock64_to_posix_lock(filp, file_lock, &flock);
1932 if (error)
1933 goto out;
1934 if (cmd == F_SETLKW64) {
1935 file_lock->fl_flags |= FL_SLEEP;
1936 }
1937
1938 error = -EBADF;
1939 switch (flock.l_type) {
1940 case F_RDLCK:
1941 if (!(filp->f_mode & FMODE_READ))
1942 goto out;
1943 break;
1944 case F_WRLCK:
1945 if (!(filp->f_mode & FMODE_WRITE))
1946 goto out;
1947 break;
1948 case F_UNLCK:
1949 break;
1950 default:
1951 error = -EINVAL;
1952 goto out;
1953 }
1954
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001955 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956
Peter Staubachc2936212005-07-27 11:45:09 -07001957 /*
1958 * Attempt to detect a close/fcntl race and recover by
1959 * releasing the lock that was just acquired.
1960 */
Al Viro0b2bac22008-05-06 13:58:34 -04001961 spin_lock(&current->files->file_lock);
1962 f = fcheck(fd);
1963 spin_unlock(&current->files->file_lock);
1964 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07001965 flock.l_type = F_UNLCK;
1966 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 }
1968
1969out:
1970 locks_free_lock(file_lock);
1971 return error;
1972}
1973#endif /* BITS_PER_LONG == 32 */
1974
1975/*
1976 * This function is called when the file is being removed
1977 * from the task's fd array. POSIX locks belonging to this task
1978 * are deleted at this time.
1979 */
1980void locks_remove_posix(struct file *filp, fl_owner_t owner)
1981{
Miklos Szerediff7b86b2006-06-23 02:05:11 -07001982 struct file_lock lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983
1984 /*
1985 * If there are no locks held on this file, we don't need to call
1986 * posix_lock_file(). Another process could be setting a lock on this
1987 * file at the same time, but we wouldn't remove that lock anyway.
1988 */
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001989 if (!filp->f_path.dentry->d_inode->i_flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990 return;
1991
1992 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07001993 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994 lock.fl_start = 0;
1995 lock.fl_end = OFFSET_MAX;
1996 lock.fl_owner = owner;
1997 lock.fl_pid = current->tgid;
1998 lock.fl_file = filp;
1999 lock.fl_ops = NULL;
2000 lock.fl_lmops = NULL;
2001
Marc Eshel150b3932007-01-18 16:15:35 -05002002 vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2005 lock.fl_ops->fl_release_private(&lock);
2006}
2007
2008EXPORT_SYMBOL(locks_remove_posix);
2009
2010/*
2011 * This function is called on the last close of an open file.
2012 */
2013void locks_remove_flock(struct file *filp)
2014{
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08002015 struct inode * inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 struct file_lock *fl;
2017 struct file_lock **before;
2018
2019 if (!inode->i_flock)
2020 return;
2021
2022 if (filp->f_op && filp->f_op->flock) {
2023 struct file_lock fl = {
2024 .fl_pid = current->tgid,
2025 .fl_file = filp,
2026 .fl_flags = FL_FLOCK,
2027 .fl_type = F_UNLCK,
2028 .fl_end = OFFSET_MAX,
2029 };
2030 filp->f_op->flock(filp, F_SETLKW, &fl);
Trond Myklebust80fec4c2005-06-22 17:16:31 +00002031 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2032 fl.fl_ops->fl_release_private(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033 }
2034
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002035 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036 before = &inode->i_flock;
2037
2038 while ((fl = *before) != NULL) {
2039 if (fl->fl_file == filp) {
Peter Staubachc2936212005-07-27 11:45:09 -07002040 if (IS_FLOCK(fl)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 locks_delete_lock(before);
2042 continue;
2043 }
2044 if (IS_LEASE(fl)) {
2045 lease_modify(before, F_UNLCK);
2046 continue;
2047 }
2048 /* What? */
2049 BUG();
2050 }
2051 before = &fl->fl_next;
2052 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002053 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054}
2055
2056/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057 * posix_unblock_lock - stop waiting for a file lock
2058 * @filp: how the file was opened
2059 * @waiter: the lock which was waiting
2060 *
2061 * lockd needs to block waiting for locks.
2062 */
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002063int
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064posix_unblock_lock(struct file *filp, struct file_lock *waiter)
2065{
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002066 int status = 0;
2067
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002068 lock_flocks();
J. Bruce Fields5996a292006-01-03 09:55:44 +01002069 if (waiter->fl_next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070 __locks_delete_block(waiter);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002071 else
2072 status = -ENOENT;
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002073 unlock_flocks();
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002074 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075}
2076
2077EXPORT_SYMBOL(posix_unblock_lock);
2078
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002079/**
2080 * vfs_cancel_lock - file byte range unblock lock
2081 * @filp: The file to apply the unblock to
2082 * @fl: The lock to be unblocked
2083 *
2084 * Used by lock managers to cancel blocked requests
2085 */
2086int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2087{
2088 if (filp->f_op && filp->f_op->lock)
2089 return filp->f_op->lock(filp, F_CANCELLK, fl);
2090 return 0;
2091}
2092
2093EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2094
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002095#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002096#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002097#include <linux/seq_file.h>
2098
2099static void lock_get_status(struct seq_file *f, struct file_lock *fl,
2100 int id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101{
2102 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002103 unsigned int fl_pid;
2104
2105 if (fl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -08002106 fl_pid = pid_vnr(fl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002107 else
2108 fl_pid = fl->fl_pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109
2110 if (fl->fl_file != NULL)
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08002111 inode = fl->fl_file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002113 seq_printf(f, "%d:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 if (IS_POSIX(fl)) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002115 seq_printf(f, "%6s %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116 (fl->fl_flags & FL_ACCESS) ? "ACCESS" : "POSIX ",
2117 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002118 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 } else if (IS_FLOCK(fl)) {
2120 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002121 seq_printf(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002123 seq_printf(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124 }
2125 } else if (IS_LEASE(fl)) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002126 seq_printf(f, "LEASE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127 if (fl->fl_type & F_INPROGRESS)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002128 seq_printf(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 else if (fl->fl_file)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002130 seq_printf(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002132 seq_printf(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002134 seq_printf(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 }
2136 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002137 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138 (fl->fl_type & LOCK_READ)
2139 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2140 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2141 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002142 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 (fl->fl_type & F_INPROGRESS)
2144 ? (fl->fl_type & F_UNLCK) ? "UNLCK" : "READ "
2145 : (fl->fl_type & F_WRLCK) ? "WRITE" : "READ ");
2146 }
2147 if (inode) {
2148#ifdef WE_CAN_BREAK_LSLK_NOW
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002149 seq_printf(f, "%d %s:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 inode->i_sb->s_id, inode->i_ino);
2151#else
2152 /* userspace relies on this representation of dev_t ;-( */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002153 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 MAJOR(inode->i_sb->s_dev),
2155 MINOR(inode->i_sb->s_dev), inode->i_ino);
2156#endif
2157 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002158 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159 }
2160 if (IS_POSIX(fl)) {
2161 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002162 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002164 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002166 seq_printf(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167 }
2168}
2169
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002170static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171{
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002172 struct file_lock *fl, *bfl;
2173
2174 fl = list_entry(v, struct file_lock, fl_link);
2175
2176 lock_get_status(f, fl, (long)f->private, "");
2177
2178 list_for_each_entry(bfl, &fl->fl_block, fl_block)
2179 lock_get_status(f, bfl, (long)f->private, " ->");
2180
2181 f->private++;
2182 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183}
2184
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002185static void *locks_start(struct seq_file *f, loff_t *pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186{
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002187 lock_flocks();
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002188 f->private = (void *)1;
2189 return seq_list_start(&file_lock_list, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190}
2191
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002192static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2193{
2194 return seq_list_next(v, &file_lock_list, pos);
2195}
2196
2197static void locks_stop(struct seq_file *f, void *v)
2198{
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002199 unlock_flocks();
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002200}
2201
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002202static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002203 .start = locks_start,
2204 .next = locks_next,
2205 .stop = locks_stop,
2206 .show = locks_show,
2207};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002208
2209static int locks_open(struct inode *inode, struct file *filp)
2210{
2211 return seq_open(filp, &locks_seq_operations);
2212}
2213
2214static const struct file_operations proc_locks_operations = {
2215 .open = locks_open,
2216 .read = seq_read,
2217 .llseek = seq_lseek,
2218 .release = seq_release,
2219};
2220
2221static int __init proc_locks_init(void)
2222{
2223 proc_create("locks", 0, NULL, &proc_locks_operations);
2224 return 0;
2225}
2226module_init(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002227#endif
2228
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229/**
2230 * lock_may_read - checks that the region is free of locks
2231 * @inode: the inode that is being read
2232 * @start: the first byte to read
2233 * @len: the number of bytes to read
2234 *
2235 * Emulates Windows locking requirements. Whole-file
2236 * mandatory locks (share modes) can prohibit a read and
2237 * byte-range POSIX locks can prohibit a read if they overlap.
2238 *
2239 * N.B. this function is only ever called
2240 * from knfsd and ownership of locks is never checked.
2241 */
2242int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2243{
2244 struct file_lock *fl;
2245 int result = 1;
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002246 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2248 if (IS_POSIX(fl)) {
2249 if (fl->fl_type == F_RDLCK)
2250 continue;
2251 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2252 continue;
2253 } else if (IS_FLOCK(fl)) {
2254 if (!(fl->fl_type & LOCK_MAND))
2255 continue;
2256 if (fl->fl_type & LOCK_READ)
2257 continue;
2258 } else
2259 continue;
2260 result = 0;
2261 break;
2262 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002263 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 return result;
2265}
2266
2267EXPORT_SYMBOL(lock_may_read);
2268
2269/**
2270 * lock_may_write - checks that the region is free of locks
2271 * @inode: the inode that is being written
2272 * @start: the first byte to write
2273 * @len: the number of bytes to write
2274 *
2275 * Emulates Windows locking requirements. Whole-file
2276 * mandatory locks (share modes) can prohibit a write and
2277 * byte-range POSIX locks can prohibit a write if they overlap.
2278 *
2279 * N.B. this function is only ever called
2280 * from knfsd and ownership of locks is never checked.
2281 */
2282int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2283{
2284 struct file_lock *fl;
2285 int result = 1;
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002286 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2288 if (IS_POSIX(fl)) {
2289 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2290 continue;
2291 } else if (IS_FLOCK(fl)) {
2292 if (!(fl->fl_type & LOCK_MAND))
2293 continue;
2294 if (fl->fl_type & LOCK_WRITE)
2295 continue;
2296 } else
2297 continue;
2298 result = 0;
2299 break;
2300 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002301 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 return result;
2303}
2304
2305EXPORT_SYMBOL(lock_may_write);
2306
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307static int __init filelock_init(void)
2308{
2309 filelock_cache = kmem_cache_create("file_lock_cache",
2310 sizeof(struct file_lock), 0, SLAB_PANIC,
Paul Mundt20c2df82007-07-20 10:11:58 +09002311 init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 return 0;
2313}
2314
2315core_initcall(filelock_init);