blob: a2ab790471b5d773862941ef18f850cd9728e600 [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);
Arnd Bergmann72f98e72010-10-27 21:39:58 +0200145static DEFINE_SPINLOCK(file_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200147/*
148 * Protects the two list heads above, plus the inode->i_flock list
149 * FIXME: should use a spinlock, once lockd and ceph are ready.
150 */
151void lock_flocks(void)
152{
Arnd Bergmann72f98e72010-10-27 21:39:58 +0200153 spin_lock(&file_lock_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200154}
155EXPORT_SYMBOL_GPL(lock_flocks);
156
157void unlock_flocks(void)
158{
Arnd Bergmann72f98e72010-10-27 21:39:58 +0200159 spin_unlock(&file_lock_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200160}
161EXPORT_SYMBOL_GPL(unlock_flocks);
162
Christoph Lametere18b8902006-12-06 20:33:20 -0800163static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
165/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200166struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167{
Christoph Lametere94b1762006-12-06 20:33:17 -0800168 return kmem_cache_alloc(filelock_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200170EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500172void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500173{
174 if (fl->fl_ops) {
175 if (fl->fl_ops->fl_release_private)
176 fl->fl_ops->fl_release_private(fl);
177 fl->fl_ops = NULL;
178 }
179 if (fl->fl_lmops) {
180 if (fl->fl_lmops->fl_release_private)
181 fl->fl_lmops->fl_release_private(fl);
182 fl->fl_lmops = NULL;
183 }
184
185}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500186EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500187
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188/* Free a lock which is not in use. */
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400189void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190{
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800191 BUG_ON(waitqueue_active(&fl->fl_wait));
192 BUG_ON(!list_empty(&fl->fl_block));
193 BUG_ON(!list_empty(&fl->fl_link));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Trond Myklebust47831f32006-03-20 13:44:05 -0500195 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 kmem_cache_free(filelock_cache, fl);
197}
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400198EXPORT_SYMBOL(locks_free_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
200void locks_init_lock(struct file_lock *fl)
201{
202 INIT_LIST_HEAD(&fl->fl_link);
203 INIT_LIST_HEAD(&fl->fl_block);
204 init_waitqueue_head(&fl->fl_wait);
205 fl->fl_next = NULL;
206 fl->fl_fasync = NULL;
207 fl->fl_owner = NULL;
208 fl->fl_pid = 0;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000209 fl->fl_nspid = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 fl->fl_file = NULL;
211 fl->fl_flags = 0;
212 fl->fl_type = 0;
213 fl->fl_start = fl->fl_end = 0;
214 fl->fl_ops = NULL;
215 fl->fl_lmops = NULL;
216}
217
218EXPORT_SYMBOL(locks_init_lock);
219
220/*
221 * Initialises the fields of the file lock which are invariant for
222 * free file_locks.
223 */
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700224static void init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225{
226 struct file_lock *lock = (struct file_lock *) foo;
227
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 locks_init_lock(lock);
229}
230
Trond Myklebust47831f32006-03-20 13:44:05 -0500231static void locks_copy_private(struct file_lock *new, struct file_lock *fl)
232{
233 if (fl->fl_ops) {
234 if (fl->fl_ops->fl_copy_lock)
235 fl->fl_ops->fl_copy_lock(new, fl);
236 new->fl_ops = fl->fl_ops;
237 }
238 if (fl->fl_lmops) {
239 if (fl->fl_lmops->fl_copy_lock)
240 fl->fl_lmops->fl_copy_lock(new, fl);
241 new->fl_lmops = fl->fl_lmops;
242 }
243}
244
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245/*
246 * Initialize a new lock from an existing file_lock structure.
247 */
J. Bruce Fields1a747ee2008-04-24 10:08:22 -0400248void __locks_copy_lock(struct file_lock *new, const struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249{
250 new->fl_owner = fl->fl_owner;
251 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500252 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 new->fl_flags = fl->fl_flags;
254 new->fl_type = fl->fl_type;
255 new->fl_start = fl->fl_start;
256 new->fl_end = fl->fl_end;
Trond Myklebust09969052006-03-20 13:44:38 -0500257 new->fl_ops = NULL;
258 new->fl_lmops = NULL;
259}
Roland Dreier3dd7b712008-04-25 15:32:51 -0700260EXPORT_SYMBOL(__locks_copy_lock);
Trond Myklebust09969052006-03-20 13:44:38 -0500261
262void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
263{
264 locks_release_private(new);
265
266 __locks_copy_lock(new, fl);
267 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 new->fl_ops = fl->fl_ops;
269 new->fl_lmops = fl->fl_lmops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500270
271 locks_copy_private(new, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272}
273
274EXPORT_SYMBOL(locks_copy_lock);
275
276static inline int flock_translate_cmd(int cmd) {
277 if (cmd & LOCK_MAND)
278 return cmd & (LOCK_MAND | LOCK_RW);
279 switch (cmd) {
280 case LOCK_SH:
281 return F_RDLCK;
282 case LOCK_EX:
283 return F_WRLCK;
284 case LOCK_UN:
285 return F_UNLCK;
286 }
287 return -EINVAL;
288}
289
290/* Fill in a file_lock structure with an appropriate FLOCK lock. */
291static int flock_make_lock(struct file *filp, struct file_lock **lock,
292 unsigned int cmd)
293{
294 struct file_lock *fl;
295 int type = flock_translate_cmd(cmd);
296 if (type < 0)
297 return type;
298
299 fl = locks_alloc_lock();
300 if (fl == NULL)
301 return -ENOMEM;
302
303 fl->fl_file = filp;
304 fl->fl_pid = current->tgid;
305 fl->fl_flags = FL_FLOCK;
306 fl->fl_type = type;
307 fl->fl_end = OFFSET_MAX;
308
309 *lock = fl;
310 return 0;
311}
312
313static int assign_type(struct file_lock *fl, int type)
314{
315 switch (type) {
316 case F_RDLCK:
317 case F_WRLCK:
318 case F_UNLCK:
319 fl->fl_type = type;
320 break;
321 default:
322 return -EINVAL;
323 }
324 return 0;
325}
326
327/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
328 * style lock.
329 */
330static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
331 struct flock *l)
332{
333 off_t start, end;
334
335 switch (l->l_whence) {
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700336 case SEEK_SET:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 start = 0;
338 break;
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700339 case SEEK_CUR:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 start = filp->f_pos;
341 break;
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700342 case SEEK_END:
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800343 start = i_size_read(filp->f_path.dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 break;
345 default:
346 return -EINVAL;
347 }
348
349 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
350 POSIX-2001 defines it. */
351 start += l->l_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 if (start < 0)
353 return -EINVAL;
Trond Myklebust4c780a42005-10-18 14:20:21 -0700354 fl->fl_end = OFFSET_MAX;
355 if (l->l_len > 0) {
356 end = start + l->l_len - 1;
357 fl->fl_end = end;
358 } else if (l->l_len < 0) {
359 end = start - 1;
360 fl->fl_end = end;
361 start += l->l_len;
362 if (start < 0)
363 return -EINVAL;
364 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 fl->fl_start = start; /* we record the absolute position */
Trond Myklebust4c780a42005-10-18 14:20:21 -0700366 if (fl->fl_end < fl->fl_start)
367 return -EOVERFLOW;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
369 fl->fl_owner = current->files;
370 fl->fl_pid = current->tgid;
371 fl->fl_file = filp;
372 fl->fl_flags = FL_POSIX;
373 fl->fl_ops = NULL;
374 fl->fl_lmops = NULL;
375
376 return assign_type(fl, l->l_type);
377}
378
379#if BITS_PER_LONG == 32
380static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
381 struct flock64 *l)
382{
383 loff_t start;
384
385 switch (l->l_whence) {
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700386 case SEEK_SET:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 start = 0;
388 break;
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700389 case SEEK_CUR:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 start = filp->f_pos;
391 break;
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700392 case SEEK_END:
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800393 start = i_size_read(filp->f_path.dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 break;
395 default:
396 return -EINVAL;
397 }
398
Trond Myklebust4c780a42005-10-18 14:20:21 -0700399 start += l->l_start;
400 if (start < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 return -EINVAL;
Trond Myklebust4c780a42005-10-18 14:20:21 -0700402 fl->fl_end = OFFSET_MAX;
403 if (l->l_len > 0) {
404 fl->fl_end = start + l->l_len - 1;
405 } else if (l->l_len < 0) {
406 fl->fl_end = start - 1;
407 start += l->l_len;
408 if (start < 0)
409 return -EINVAL;
410 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 fl->fl_start = start; /* we record the absolute position */
Trond Myklebust4c780a42005-10-18 14:20:21 -0700412 if (fl->fl_end < fl->fl_start)
413 return -EOVERFLOW;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414
415 fl->fl_owner = current->files;
416 fl->fl_pid = current->tgid;
417 fl->fl_file = filp;
418 fl->fl_flags = FL_POSIX;
419 fl->fl_ops = NULL;
420 fl->fl_lmops = NULL;
421
422 switch (l->l_type) {
423 case F_RDLCK:
424 case F_WRLCK:
425 case F_UNLCK:
426 fl->fl_type = l->l_type;
427 break;
428 default:
429 return -EINVAL;
430 }
431
432 return (0);
433}
434#endif
435
436/* default lease lock manager operations */
437static void lease_break_callback(struct file_lock *fl)
438{
439 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
440}
441
442static void lease_release_private_callback(struct file_lock *fl)
443{
444 if (!fl->fl_file)
445 return;
446
447 f_delown(fl->fl_file);
448 fl->fl_file->f_owner.signum = 0;
449}
450
Adrian Bunk75c96f82005-05-05 16:16:09 -0700451static int lease_mylease_callback(struct file_lock *fl, struct file_lock *try)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452{
453 return fl->fl_file == try->fl_file;
454}
455
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700456static const struct lock_manager_operations lease_manager_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 .fl_break = lease_break_callback,
458 .fl_release_private = lease_release_private_callback,
459 .fl_mylease = lease_mylease_callback,
460 .fl_change = lease_modify,
461};
462
463/*
464 * Initialize a lease, use the default lock manager operations
465 */
466static int lease_init(struct file *filp, int type, struct file_lock *fl)
467 {
Trond Myklebust75dff552006-05-07 23:02:42 -0400468 if (assign_type(fl, type) != 0)
469 return -EINVAL;
470
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 fl->fl_owner = current->files;
472 fl->fl_pid = current->tgid;
473
474 fl->fl_file = filp;
475 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 fl->fl_start = 0;
477 fl->fl_end = OFFSET_MAX;
478 fl->fl_ops = NULL;
479 fl->fl_lmops = &lease_manager_ops;
480 return 0;
481}
482
483/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500484static struct file_lock *lease_alloc(struct file *filp, int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485{
486 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400487 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488
489 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500490 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491
492 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400493 if (error) {
494 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500495 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400496 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500497 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498}
499
500/* Check if two locks overlap each other.
501 */
502static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
503{
504 return ((fl1->fl_end >= fl2->fl_start) &&
505 (fl2->fl_end >= fl1->fl_start));
506}
507
508/*
509 * Check whether two locks have the same owner.
510 */
Matt Mackall33443c42006-01-08 01:05:22 -0800511static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512{
513 if (fl1->fl_lmops && fl1->fl_lmops->fl_compare_owner)
514 return fl2->fl_lmops == fl1->fl_lmops &&
515 fl1->fl_lmops->fl_compare_owner(fl1, fl2);
516 return fl1->fl_owner == fl2->fl_owner;
517}
518
519/* Remove waiter from blocker's block list.
520 * When blocker ends up pointing to itself then the list is empty.
521 */
Matt Mackall33443c42006-01-08 01:05:22 -0800522static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523{
524 list_del_init(&waiter->fl_block);
525 list_del_init(&waiter->fl_link);
526 waiter->fl_next = NULL;
527}
528
529/*
530 */
531static void locks_delete_block(struct file_lock *waiter)
532{
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200533 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 __locks_delete_block(waiter);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200535 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536}
537
538/* Insert waiter into blocker's block list.
539 * We use a circular list so that processes can be easily woken up in
540 * the order they blocked. The documentation doesn't require this but
541 * it seems like the reasonable thing to do.
542 */
543static void locks_insert_block(struct file_lock *blocker,
544 struct file_lock *waiter)
545{
J. Bruce Fields6dc0fe82006-03-26 01:37:24 -0800546 BUG_ON(!list_empty(&waiter->fl_block));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 list_add_tail(&waiter->fl_block, &blocker->fl_block);
548 waiter->fl_next = blocker;
549 if (IS_POSIX(blocker))
550 list_add(&waiter->fl_link, &blocked_list);
551}
552
553/* Wake up processes blocked waiting for blocker.
554 * If told to wait then schedule the processes until the block list
555 * is empty, otherwise empty the block list ourselves.
556 */
557static void locks_wake_up_blocks(struct file_lock *blocker)
558{
559 while (!list_empty(&blocker->fl_block)) {
Pavel Emelyanovf0c1cd02007-09-19 16:44:07 +0400560 struct file_lock *waiter;
561
562 waiter = list_first_entry(&blocker->fl_block,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 struct file_lock, fl_block);
564 __locks_delete_block(waiter);
565 if (waiter->fl_lmops && waiter->fl_lmops->fl_notify)
566 waiter->fl_lmops->fl_notify(waiter);
567 else
568 wake_up(&waiter->fl_wait);
569 }
570}
571
572/* Insert file lock fl into an inode's lock list at the position indicated
573 * by pos. At the same time add the lock to the global file lock list.
574 */
575static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
576{
577 list_add(&fl->fl_link, &file_lock_list);
578
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000579 fl->fl_nspid = get_pid(task_tgid(current));
580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 /* insert into file's list */
582 fl->fl_next = *pos;
583 *pos = fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584}
585
586/*
587 * Delete a lock and then free it.
588 * Wake up processes that are blocked waiting for this lock,
589 * notify the FS that the lock has been cleared and
590 * finally free the lock.
591 */
592static void locks_delete_lock(struct file_lock **thisfl_p)
593{
594 struct file_lock *fl = *thisfl_p;
595
596 *thisfl_p = fl->fl_next;
597 fl->fl_next = NULL;
598 list_del_init(&fl->fl_link);
599
600 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
601 if (fl->fl_fasync != NULL) {
602 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
603 fl->fl_fasync = NULL;
604 }
605
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000606 if (fl->fl_nspid) {
607 put_pid(fl->fl_nspid);
608 fl->fl_nspid = NULL;
609 }
610
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 locks_wake_up_blocks(fl);
612 locks_free_lock(fl);
613}
614
615/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
616 * checks for shared/exclusive status of overlapping locks.
617 */
618static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
619{
620 if (sys_fl->fl_type == F_WRLCK)
621 return 1;
622 if (caller_fl->fl_type == F_WRLCK)
623 return 1;
624 return 0;
625}
626
627/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
628 * checking before calling the locks_conflict().
629 */
630static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
631{
632 /* POSIX locks owned by the same process do not conflict with
633 * each other.
634 */
635 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
636 return (0);
637
638 /* Check whether they overlap */
639 if (!locks_overlap(caller_fl, sys_fl))
640 return 0;
641
642 return (locks_conflict(caller_fl, sys_fl));
643}
644
645/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
646 * checking before calling the locks_conflict().
647 */
648static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
649{
650 /* FLOCK locks referring to the same filp do not conflict with
651 * each other.
652 */
653 if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
654 return (0);
655 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
656 return 0;
657
658 return (locks_conflict(caller_fl, sys_fl));
659}
660
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400661void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500662posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663{
664 struct file_lock *cfl;
665
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200666 lock_flocks();
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800667 for (cfl = filp->f_path.dentry->d_inode->i_flock; cfl; cfl = cfl->fl_next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 if (!IS_POSIX(cfl))
669 continue;
J. Bruce Fieldsb842e242007-05-10 19:02:07 -0400670 if (posix_locks_conflict(fl, cfl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 break;
672 }
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000673 if (cfl) {
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500674 __locks_copy_lock(fl, cfl);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000675 if (cfl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -0800676 fl->fl_pid = pid_vnr(cfl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000677 } else
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400678 fl->fl_type = F_UNLCK;
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200679 unlock_flocks();
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400680 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682EXPORT_SYMBOL(posix_test_lock);
683
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400684/*
685 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400687 * We attempt to detect deadlocks that are due purely to posix file
688 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400690 * We assume that a task can be waiting for at most one lock at a time.
691 * So for any acquired lock, the process holding that lock may be
692 * waiting on at most one other lock. That lock in turns may be held by
693 * someone waiting for at most one other lock. Given a requested lock
694 * caller_fl which is about to wait for a conflicting lock block_fl, we
695 * follow this chain of waiters to ensure we are not about to create a
696 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400697 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400698 * Since we do this before we ever put a process to sleep on a lock, we
699 * are ensured that there is never a cycle; that is what guarantees that
700 * the while() loop in posix_locks_deadlock() eventually completes.
701 *
702 * Note: the above assumption may not be true when handling lock
703 * requests from a broken NFS client. It may also fail in the presence
704 * of tasks (such as posix threads) sharing the same open file table.
705 *
706 * To handle those cases, we just bail out after a few iterations.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400708
709#define MAX_DEADLK_ITERATIONS 10
710
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400711/* Find a lock that the owner of the given block_fl is blocking on. */
712static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
713{
714 struct file_lock *fl;
715
716 list_for_each_entry(fl, &blocked_list, fl_link) {
717 if (posix_same_owner(fl, block_fl))
718 return fl->fl_next;
719 }
720 return NULL;
721}
722
Adrian Bunkb0904e12006-06-23 02:05:13 -0700723static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 struct file_lock *block_fl)
725{
J. Bruce Fields97855b42007-10-30 11:20:02 -0400726 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400728 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
729 if (i++ > MAX_DEADLK_ITERATIONS)
730 return 0;
731 if (posix_same_owner(caller_fl, block_fl))
732 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 }
734 return 0;
735}
736
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -0400738 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -0400739 *
740 * Note that if called with an FL_EXISTS argument, the caller may determine
741 * whether or not a lock was successfully freed by testing the return
742 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 */
Trond Myklebust993dfa82006-03-31 02:30:55 -0800744static int flock_lock_file(struct file *filp, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745{
Trond Myklebust993dfa82006-03-31 02:30:55 -0800746 struct file_lock *new_fl = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 struct file_lock **before;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800748 struct inode * inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 int error = 0;
750 int found = 0;
751
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200752 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
753 new_fl = locks_alloc_lock();
754 if (!new_fl)
755 return -ENOMEM;
756 }
757
758 lock_flocks();
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400759 if (request->fl_flags & FL_ACCESS)
760 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +0400761
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 for_each_lock(inode, before) {
763 struct file_lock *fl = *before;
764 if (IS_POSIX(fl))
765 break;
766 if (IS_LEASE(fl))
767 continue;
768 if (filp != fl->fl_file)
769 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800770 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 goto out;
772 found = 1;
773 locks_delete_lock(before);
774 break;
775 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776
Trond Myklebustf475ae92006-06-29 16:38:32 -0400777 if (request->fl_type == F_UNLCK) {
778 if ((request->fl_flags & FL_EXISTS) && !found)
779 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800780 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400781 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
783 /*
784 * If a higher-priority process was blocked on the old file lock,
785 * give it the opportunity to lock the file.
786 */
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200787 if (found) {
788 unlock_flocks();
Frederic Weisbeckerdef01bc2009-07-16 15:44:29 +0200789 cond_resched();
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200790 lock_flocks();
791 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400793find_conflict:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 for_each_lock(inode, before) {
795 struct file_lock *fl = *before;
796 if (IS_POSIX(fl))
797 break;
798 if (IS_LEASE(fl))
799 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800800 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 continue;
802 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700803 if (!(request->fl_flags & FL_SLEEP))
804 goto out;
805 error = FILE_LOCK_DEFERRED;
806 locks_insert_block(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 goto out;
808 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400809 if (request->fl_flags & FL_ACCESS)
810 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800811 locks_copy_lock(new_fl, request);
Pavel Emelyanov0e2f6db2007-09-11 15:24:01 -0700812 locks_insert_lock(before, new_fl);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800813 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +0400814 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815
816out:
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200817 unlock_flocks();
Trond Myklebust993dfa82006-03-31 02:30:55 -0800818 if (new_fl)
819 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 return error;
821}
822
Marc Eshel150b3932007-01-18 16:15:35 -0500823static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824{
825 struct file_lock *fl;
Miklos Szeredi39005d02006-06-23 02:05:10 -0700826 struct file_lock *new_fl = NULL;
827 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 struct file_lock *left = NULL;
829 struct file_lock *right = NULL;
830 struct file_lock **before;
831 int error, added = 0;
832
833 /*
834 * We may need two file_lock structures for this operation,
835 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -0700836 *
837 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 */
Miklos Szeredi39005d02006-06-23 02:05:10 -0700839 if (!(request->fl_flags & FL_ACCESS) &&
840 (request->fl_type != F_UNLCK ||
841 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
842 new_fl = locks_alloc_lock();
843 new_fl2 = locks_alloc_lock();
844 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200846 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 if (request->fl_type != F_UNLCK) {
848 for_each_lock(inode, before) {
J. Bruce Fields526985b2006-11-14 16:54:36 -0500849 fl = *before;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 if (!IS_POSIX(fl))
851 continue;
852 if (!posix_locks_conflict(request, fl))
853 continue;
Andy Adamson5842add2006-03-26 01:37:26 -0800854 if (conflock)
J. Bruce Fields1a747ee2008-04-24 10:08:22 -0400855 __locks_copy_lock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 error = -EAGAIN;
857 if (!(request->fl_flags & FL_SLEEP))
858 goto out;
859 error = -EDEADLK;
860 if (posix_locks_deadlock(request, fl))
861 goto out;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700862 error = FILE_LOCK_DEFERRED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 locks_insert_block(fl, request);
864 goto out;
865 }
866 }
867
868 /* If we're just looking for a conflict, we're done. */
869 error = 0;
870 if (request->fl_flags & FL_ACCESS)
871 goto out;
872
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 * Find the first old lock with the same owner as the new lock.
875 */
876
877 before = &inode->i_flock;
878
879 /* First skip locks owned by other processes. */
880 while ((fl = *before) && (!IS_POSIX(fl) ||
881 !posix_same_owner(request, fl))) {
882 before = &fl->fl_next;
883 }
884
885 /* Process locks with this owner. */
886 while ((fl = *before) && posix_same_owner(request, fl)) {
887 /* Detect adjacent or overlapping regions (if same lock type)
888 */
889 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -0700890 /* In all comparisons of start vs end, use
891 * "start - 1" rather than "end + 1". If end
892 * is OFFSET_MAX, end + 1 will become negative.
893 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 if (fl->fl_end < request->fl_start - 1)
895 goto next_lock;
896 /* If the next lock in the list has entirely bigger
897 * addresses than the new one, insert the lock here.
898 */
Olaf Kirch449231d2005-08-25 16:25:35 -0700899 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 break;
901
902 /* If we come here, the new and old lock are of the
903 * same type and adjacent or overlapping. Make one
904 * lock yielding from the lower start address of both
905 * locks to the higher end address.
906 */
907 if (fl->fl_start > request->fl_start)
908 fl->fl_start = request->fl_start;
909 else
910 request->fl_start = fl->fl_start;
911 if (fl->fl_end < request->fl_end)
912 fl->fl_end = request->fl_end;
913 else
914 request->fl_end = fl->fl_end;
915 if (added) {
916 locks_delete_lock(before);
917 continue;
918 }
919 request = fl;
920 added = 1;
921 }
922 else {
923 /* Processing for different lock types is a bit
924 * more complex.
925 */
926 if (fl->fl_end < request->fl_start)
927 goto next_lock;
928 if (fl->fl_start > request->fl_end)
929 break;
930 if (request->fl_type == F_UNLCK)
931 added = 1;
932 if (fl->fl_start < request->fl_start)
933 left = fl;
934 /* If the next lock in the list has a higher end
935 * address than the new one, insert the new one here.
936 */
937 if (fl->fl_end > request->fl_end) {
938 right = fl;
939 break;
940 }
941 if (fl->fl_start >= request->fl_start) {
942 /* The new lock completely replaces an old
943 * one (This may happen several times).
944 */
945 if (added) {
946 locks_delete_lock(before);
947 continue;
948 }
949 /* Replace the old lock with the new one.
950 * Wake up anybody waiting for the old one,
951 * as the change in lock type might satisfy
952 * their needs.
953 */
954 locks_wake_up_blocks(fl);
955 fl->fl_start = request->fl_start;
956 fl->fl_end = request->fl_end;
957 fl->fl_type = request->fl_type;
Trond Myklebust47831f32006-03-20 13:44:05 -0500958 locks_release_private(fl);
959 locks_copy_private(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 request = fl;
961 added = 1;
962 }
963 }
964 /* Go on to next lock.
965 */
966 next_lock:
967 before = &fl->fl_next;
968 }
969
Miklos Szeredi0d9a4902006-06-23 02:05:09 -0700970 /*
971 * The above code only modifies existing locks in case of
972 * merging or replacing. If new lock(s) need to be inserted
973 * all modifications are done bellow this, so it's safe yet to
974 * bail out.
975 */
976 error = -ENOLCK; /* "no luck" */
977 if (right && left == right && !new_fl2)
978 goto out;
979
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 error = 0;
981 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -0400982 if (request->fl_type == F_UNLCK) {
983 if (request->fl_flags & FL_EXISTS)
984 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400986 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -0700987
988 if (!new_fl) {
989 error = -ENOLCK;
990 goto out;
991 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 locks_copy_lock(new_fl, request);
993 locks_insert_lock(before, new_fl);
994 new_fl = NULL;
995 }
996 if (right) {
997 if (left == right) {
998 /* The new lock breaks the old one in two pieces,
999 * so we have to use the second new lock.
1000 */
1001 left = new_fl2;
1002 new_fl2 = NULL;
1003 locks_copy_lock(left, right);
1004 locks_insert_lock(before, left);
1005 }
1006 right->fl_start = request->fl_end + 1;
1007 locks_wake_up_blocks(right);
1008 }
1009 if (left) {
1010 left->fl_end = request->fl_start - 1;
1011 locks_wake_up_blocks(left);
1012 }
1013 out:
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001014 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 /*
1016 * Free any unused locks.
1017 */
1018 if (new_fl)
1019 locks_free_lock(new_fl);
1020 if (new_fl2)
1021 locks_free_lock(new_fl2);
1022 return error;
1023}
1024
1025/**
1026 * posix_lock_file - Apply a POSIX-style lock to a file
1027 * @filp: The file to apply the lock to
1028 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001029 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 *
1031 * Add a POSIX style lock to a file.
1032 * We merge adjacent & overlapping locks whenever possible.
1033 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001034 *
1035 * Note that if called with an FL_EXISTS argument, the caller may determine
1036 * whether or not a lock was successfully freed by testing the return
1037 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 */
Marc Eshel150b3932007-01-18 16:15:35 -05001039int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001040 struct file_lock *conflock)
1041{
Marc Eshel150b3932007-01-18 16:15:35 -05001042 return __posix_lock_file(filp->f_path.dentry->d_inode, fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001043}
Marc Eshel150b3932007-01-18 16:15:35 -05001044EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045
1046/**
1047 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1048 * @filp: The file to apply the lock to
1049 * @fl: The lock to be applied
1050 *
1051 * Add a POSIX style lock to a file.
1052 * We merge adjacent & overlapping locks whenever possible.
1053 * POSIX locks are sorted by owner task, then by starting address
1054 */
1055int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1056{
1057 int error;
1058 might_sleep ();
1059 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001060 error = posix_lock_file(filp, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001061 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 break;
1063 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1064 if (!error)
1065 continue;
1066
1067 locks_delete_block(fl);
1068 break;
1069 }
1070 return error;
1071}
1072EXPORT_SYMBOL(posix_lock_file_wait);
1073
1074/**
1075 * locks_mandatory_locked - Check for an active lock
1076 * @inode: the file to check
1077 *
1078 * Searches the inode's list of locks to find any POSIX locks which conflict.
1079 * This function is called from locks_verify_locked() only.
1080 */
1081int locks_mandatory_locked(struct inode *inode)
1082{
1083 fl_owner_t owner = current->files;
1084 struct file_lock *fl;
1085
1086 /*
1087 * Search the lock list for this inode for any POSIX locks.
1088 */
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001089 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1091 if (!IS_POSIX(fl))
1092 continue;
1093 if (fl->fl_owner != owner)
1094 break;
1095 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001096 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 return fl ? -EAGAIN : 0;
1098}
1099
1100/**
1101 * locks_mandatory_area - Check for a conflicting lock
1102 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1103 * for shared
1104 * @inode: the file to check
1105 * @filp: how the file was opened (if it was)
1106 * @offset: start of area to check
1107 * @count: length of area to check
1108 *
1109 * Searches the inode's list of locks to find any POSIX locks which conflict.
1110 * This function is called from rw_verify_area() and
1111 * locks_verify_truncate().
1112 */
1113int locks_mandatory_area(int read_write, struct inode *inode,
1114 struct file *filp, loff_t offset,
1115 size_t count)
1116{
1117 struct file_lock fl;
1118 int error;
1119
1120 locks_init_lock(&fl);
1121 fl.fl_owner = current->files;
1122 fl.fl_pid = current->tgid;
1123 fl.fl_file = filp;
1124 fl.fl_flags = FL_POSIX | FL_ACCESS;
1125 if (filp && !(filp->f_flags & O_NONBLOCK))
1126 fl.fl_flags |= FL_SLEEP;
1127 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1128 fl.fl_start = offset;
1129 fl.fl_end = offset + count - 1;
1130
1131 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001132 error = __posix_lock_file(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001133 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 break;
1135 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1136 if (!error) {
1137 /*
1138 * If we've been sleeping someone might have
1139 * changed the permissions behind our back.
1140 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001141 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 continue;
1143 }
1144
1145 locks_delete_block(&fl);
1146 break;
1147 }
1148
1149 return error;
1150}
1151
1152EXPORT_SYMBOL(locks_mandatory_area);
1153
1154/* We already had a lease on this file; just change its type */
1155int lease_modify(struct file_lock **before, int arg)
1156{
1157 struct file_lock *fl = *before;
1158 int error = assign_type(fl, arg);
1159
1160 if (error)
1161 return error;
1162 locks_wake_up_blocks(fl);
1163 if (arg == F_UNLCK)
1164 locks_delete_lock(before);
1165 return 0;
1166}
1167
1168EXPORT_SYMBOL(lease_modify);
1169
1170static void time_out_leases(struct inode *inode)
1171{
1172 struct file_lock **before;
1173 struct file_lock *fl;
1174
1175 before = &inode->i_flock;
1176 while ((fl = *before) && IS_LEASE(fl) && (fl->fl_type & F_INPROGRESS)) {
1177 if ((fl->fl_break_time == 0)
1178 || time_before(jiffies, fl->fl_break_time)) {
1179 before = &fl->fl_next;
1180 continue;
1181 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 lease_modify(before, fl->fl_type & ~F_INPROGRESS);
1183 if (fl == *before) /* lease_modify may have freed fl */
1184 before = &fl->fl_next;
1185 }
1186}
1187
1188/**
1189 * __break_lease - revoke all outstanding leases on file
1190 * @inode: the inode of the file to return
1191 * @mode: the open mode (read or write)
1192 *
david m. richter87250dd2007-05-09 16:10:27 -04001193 * break_lease (inlined for speed) has checked there already is at least
1194 * some kind of lock (maybe a lease) on this file. Leases are broken on
1195 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 * specified %O_NONBLOCK to your open().
1197 */
1198int __break_lease(struct inode *inode, unsigned int mode)
1199{
1200 int error = 0, future;
1201 struct file_lock *new_fl, *flock;
1202 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 unsigned long break_time;
1204 int i_have_this_lease = 0;
Al Viro8737c932009-12-24 06:47:55 -05001205 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206
Al Viro8737c932009-12-24 06:47:55 -05001207 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001209 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210
1211 time_out_leases(inode);
1212
1213 flock = inode->i_flock;
1214 if ((flock == NULL) || !IS_LEASE(flock))
1215 goto out;
1216
1217 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next)
1218 if (fl->fl_owner == current->files)
1219 i_have_this_lease = 1;
1220
Al Viro8737c932009-12-24 06:47:55 -05001221 if (want_write) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 /* If we want write access, we have to revoke any lease. */
1223 future = F_UNLCK | F_INPROGRESS;
1224 } else if (flock->fl_type & F_INPROGRESS) {
1225 /* If the lease is already being broken, we just leave it */
1226 future = flock->fl_type;
1227 } else if (flock->fl_type & F_WRLCK) {
1228 /* Downgrade the exclusive lease to a read-only lease. */
1229 future = F_RDLCK | F_INPROGRESS;
1230 } else {
1231 /* the existing lease was read-only, so we can read too. */
1232 goto out;
1233 }
1234
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -05001235 if (IS_ERR(new_fl) && !i_have_this_lease
1236 && ((mode & O_NONBLOCK) == 0)) {
1237 error = PTR_ERR(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 goto out;
1239 }
1240
1241 break_time = 0;
1242 if (lease_break_time > 0) {
1243 break_time = jiffies + lease_break_time * HZ;
1244 if (break_time == 0)
1245 break_time++; /* so that 0 means no break time */
1246 }
1247
1248 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1249 if (fl->fl_type != future) {
1250 fl->fl_type = future;
1251 fl->fl_break_time = break_time;
1252 /* lease must have lmops break callback */
1253 fl->fl_lmops->fl_break(fl);
1254 }
1255 }
1256
1257 if (i_have_this_lease || (mode & O_NONBLOCK)) {
1258 error = -EWOULDBLOCK;
1259 goto out;
1260 }
1261
1262restart:
1263 break_time = flock->fl_break_time;
1264 if (break_time != 0) {
1265 break_time -= jiffies;
1266 if (break_time == 0)
1267 break_time++;
1268 }
Matthew Wilcox4321e012008-01-14 21:28:30 -07001269 locks_insert_block(flock, new_fl);
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001270 unlock_flocks();
Matthew Wilcox4321e012008-01-14 21:28:30 -07001271 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1272 !new_fl->fl_next, break_time);
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001273 lock_flocks();
Matthew Wilcox4321e012008-01-14 21:28:30 -07001274 __locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275 if (error >= 0) {
1276 if (error == 0)
1277 time_out_leases(inode);
1278 /* Wait for the next lease that has not been broken yet */
1279 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1280 flock = flock->fl_next) {
1281 if (flock->fl_type & F_INPROGRESS)
1282 goto restart;
1283 }
1284 error = 0;
1285 }
1286
1287out:
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001288 unlock_flocks();
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -05001289 if (!IS_ERR(new_fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290 locks_free_lock(new_fl);
1291 return error;
1292}
1293
1294EXPORT_SYMBOL(__break_lease);
1295
1296/**
Randy Dunlapa6b91912008-03-19 17:01:00 -07001297 * lease_get_mtime - get the last modified time of an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298 * @inode: the inode
1299 * @time: pointer to a timespec which will contain the last modified time
1300 *
1301 * This is to force NFS clients to flush their caches for files with
1302 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001303 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 */
1305void lease_get_mtime(struct inode *inode, struct timespec *time)
1306{
1307 struct file_lock *flock = inode->i_flock;
1308 if (flock && IS_LEASE(flock) && (flock->fl_type & F_WRLCK))
1309 *time = current_fs_time(inode->i_sb);
1310 else
1311 *time = inode->i_mtime;
1312}
1313
1314EXPORT_SYMBOL(lease_get_mtime);
1315
1316/**
1317 * fcntl_getlease - Enquire what lease is currently active
1318 * @filp: the file
1319 *
1320 * The value returned by this function will be one of
1321 * (if no lease break is pending):
1322 *
1323 * %F_RDLCK to indicate a shared lease is held.
1324 *
1325 * %F_WRLCK to indicate an exclusive lease is held.
1326 *
1327 * %F_UNLCK to indicate no lease is held.
1328 *
1329 * (if a lease break is pending):
1330 *
1331 * %F_RDLCK to indicate an exclusive lease needs to be
1332 * changed to a shared lease (or removed).
1333 *
1334 * %F_UNLCK to indicate the lease needs to be removed.
1335 *
1336 * XXX: sfr & willy disagree over whether F_INPROGRESS
1337 * should be returned to userspace.
1338 */
1339int fcntl_getlease(struct file *filp)
1340{
1341 struct file_lock *fl;
1342 int type = F_UNLCK;
1343
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001344 lock_flocks();
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001345 time_out_leases(filp->f_path.dentry->d_inode);
1346 for (fl = filp->f_path.dentry->d_inode->i_flock; fl && IS_LEASE(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 fl = fl->fl_next) {
1348 if (fl->fl_file == filp) {
1349 type = fl->fl_type & ~F_INPROGRESS;
1350 break;
1351 }
1352 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001353 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 return type;
1355}
1356
1357/**
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001358 * generic_setlease - sets a lease on an open file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 * @filp: file pointer
1360 * @arg: type of lease to obtain
1361 * @flp: input - file_lock to use, output - file_lock inserted
1362 *
1363 * The (input) flp->fl_lmops->fl_break function is required
1364 * by break_lease().
1365 *
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001366 * Called with file_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 */
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001368int generic_setlease(struct file *filp, long arg, struct file_lock **flp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369{
KAMBAROV, ZAUR7eaae282005-07-07 17:57:06 -07001370 struct file_lock *fl, **before, **my_before = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001371 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372 struct inode *inode = dentry->d_inode;
1373 int error, rdlease_count = 0, wrlease_count = 0;
1374
J. Bruce Fields096657b2010-10-30 17:31:14 -04001375 lease = *flp;
1376
1377 error = -EACCES;
David Howellsda9592e2008-11-14 10:39:05 +11001378 if ((current_fsuid() != inode->i_uid) && !capable(CAP_LEASE))
J. Bruce Fields096657b2010-10-30 17:31:14 -04001379 goto out;
1380 error = -EINVAL;
J. Bruce Fields6d5e8b02007-05-31 17:03:46 -04001381 if (!S_ISREG(inode->i_mode))
J. Bruce Fields096657b2010-10-30 17:31:14 -04001382 goto out;
J. Bruce Fields6d5e8b02007-05-31 17:03:46 -04001383 error = security_file_lock(filp, arg);
1384 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001385 goto out;
J. Bruce Fields6d5e8b02007-05-31 17:03:46 -04001386
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 time_out_leases(inode);
1388
J. Bruce Fieldsd2ab0b0c2007-06-30 12:40:32 -04001389 BUG_ON(!(*flp)->fl_lmops->fl_break);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390
David M. Richter288b2fd2008-04-23 16:29:00 -04001391 if (arg != F_UNLCK) {
1392 error = -EAGAIN;
1393 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1394 goto out;
1395 if ((arg == F_WRLCK)
1396 && ((atomic_read(&dentry->d_count) > 1)
1397 || (atomic_read(&inode->i_count) > 1)))
1398 goto out;
David M. Richter288b2fd2008-04-23 16:29:00 -04001399 }
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001400
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 /*
1402 * At this point, we know that if there is an exclusive
1403 * lease on this file, then we hold it on this filp
1404 * (otherwise our open of this file would have blocked).
1405 * And if we are trying to acquire an exclusive lease,
1406 * then the file is not open by anyone (including us)
1407 * except for this filp.
1408 */
1409 for (before = &inode->i_flock;
1410 ((fl = *before) != NULL) && IS_LEASE(fl);
1411 before = &fl->fl_next) {
1412 if (lease->fl_lmops->fl_mylease(fl, lease))
1413 my_before = before;
1414 else if (fl->fl_type == (F_INPROGRESS | F_UNLCK))
1415 /*
1416 * Someone is in the process of opening this
1417 * file for writing so we may not take an
1418 * exclusive lease on it.
1419 */
1420 wrlease_count++;
1421 else
1422 rdlease_count++;
1423 }
1424
David M. Richter5fcc60c2008-04-23 16:28:59 -04001425 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 if ((arg == F_RDLCK && (wrlease_count > 0)) ||
1427 (arg == F_WRLCK && ((rdlease_count + wrlease_count) > 0)))
1428 goto out;
1429
1430 if (my_before != NULL) {
1431 error = lease->fl_lmops->fl_change(my_before, arg);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001432 if (!error)
1433 *flp = *my_before;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 goto out;
1435 }
1436
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 if (arg == F_UNLCK)
1438 goto out;
1439
1440 error = -EINVAL;
1441 if (!leases_enable)
1442 goto out;
1443
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001444 locks_insert_lock(before, lease);
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001445 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447out:
1448 return error;
1449}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001450EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001452static int __vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
1453{
1454 if (filp->f_op && filp->f_op->setlease)
1455 return filp->f_op->setlease(filp, arg, lease);
1456 else
1457 return generic_setlease(filp, arg, lease);
1458}
1459
1460/**
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001461 * vfs_setlease - sets a lease on an open file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 * @filp: file pointer
1463 * @arg: type of lease to obtain
1464 * @lease: file_lock to use
1465 *
1466 * Call this to establish a lease on the file.
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001467 * The (*lease)->fl_lmops->fl_break operation must be set; if not,
1468 * break_lease will oops!
1469 *
1470 * This will call the filesystem's setlease file method, if
1471 * defined. Note that there is no getlease method; instead, the
1472 * filesystem setlease method should call back to setlease() to
1473 * add a lease to the inode's lease list, where fcntl_getlease() can
1474 * find it. Since fcntl_getlease() only reports whether the current
1475 * task holds a lease, a cluster filesystem need only do this for
1476 * leases held by processes on this node.
1477 *
1478 * There is also no break_lease method; filesystems that
Adam Buchbinderc9404c92009-12-18 15:40:42 -05001479 * handle their own leases should break leases themselves from the
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001480 * filesystem's open, create, and (on truncate) setattr methods.
1481 *
1482 * Warning: the only current setlease methods exist only to disable
1483 * leases in certain cases. More vfs changes may be required to
1484 * allow a full filesystem lease implementation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485 */
1486
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001487int vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 int error;
1490
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001491 lock_flocks();
1492 error = __vfs_setlease(filp, arg, lease);
1493 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494
1495 return error;
1496}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001497EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001499static int do_fcntl_delete_lease(struct file *filp)
1500{
1501 struct file_lock fl, *flp = &fl;
1502
1503 lease_init(filp, F_UNLCK, flp);
1504
1505 return vfs_setlease(filp, F_UNLCK, &flp);
1506}
1507
1508static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509{
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001510 struct file_lock *fl;
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001511 struct fasync_struct *new;
David M. Richter9d91cdc2008-04-23 16:29:02 -04001512 struct inode *inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 int error;
1514
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001515 fl = lease_alloc(filp, arg);
1516 if (IS_ERR(fl))
1517 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001519 new = fasync_alloc();
1520 if (!new) {
1521 locks_free_lock(fl);
1522 return -ENOMEM;
1523 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001524 lock_flocks();
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001525 error = __vfs_setlease(filp, arg, &fl);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001526 if (error) {
1527 unlock_flocks();
1528 locks_free_lock(fl);
1529 goto out_free_fasync;
1530 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001532 /*
1533 * fasync_insert_entry() returns the old entry if any.
1534 * If there was no old entry, then it used 'new' and
1535 * inserted it into the fasync list. Clear new so that
1536 * we don't release it here.
1537 */
1538 if (!fasync_insert_entry(fd, filp, &fl->fl_fasync, new))
1539 new = NULL;
1540
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 if (error < 0) {
J. Bruce Fields6d5e8b02007-05-31 17:03:46 -04001542 /* remove lease just inserted by setlease */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001543 fl->fl_type = F_UNLCK | F_INPROGRESS;
1544 fl->fl_break_time = jiffies - 10;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 time_out_leases(inode);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001546 } else {
1547 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001549 unlock_flocks();
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001550
1551out_free_fasync:
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001552 if (new)
1553 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 return error;
1555}
1556
1557/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001558 * fcntl_setlease - sets a lease on an open file
1559 * @fd: open file descriptor
1560 * @filp: file pointer
1561 * @arg: type of lease to obtain
1562 *
1563 * Call this fcntl to establish a lease on the file.
1564 * Note that you also need to call %F_SETSIG to
1565 * receive a signal when the lease is broken.
1566 */
1567int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1568{
1569 if (arg == F_UNLCK)
1570 return do_fcntl_delete_lease(filp);
1571 return do_fcntl_add_lease(fd, filp, arg);
1572}
1573
1574/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1576 * @filp: The file to apply the lock to
1577 * @fl: The lock to be applied
1578 *
1579 * Add a FLOCK style lock to a file.
1580 */
1581int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1582{
1583 int error;
1584 might_sleep();
1585 for (;;) {
1586 error = flock_lock_file(filp, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001587 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 break;
1589 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1590 if (!error)
1591 continue;
1592
1593 locks_delete_block(fl);
1594 break;
1595 }
1596 return error;
1597}
1598
1599EXPORT_SYMBOL(flock_lock_file_wait);
1600
1601/**
1602 * sys_flock: - flock() system call.
1603 * @fd: the file descriptor to lock.
1604 * @cmd: the type of lock to apply.
1605 *
1606 * Apply a %FL_FLOCK style lock to an open file descriptor.
1607 * The @cmd can be one of
1608 *
1609 * %LOCK_SH -- a shared lock.
1610 *
1611 * %LOCK_EX -- an exclusive lock.
1612 *
1613 * %LOCK_UN -- remove an existing lock.
1614 *
1615 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1616 *
1617 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1618 * processes read and write access respectively.
1619 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001620SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621{
1622 struct file *filp;
1623 struct file_lock *lock;
1624 int can_sleep, unlock;
1625 int error;
1626
1627 error = -EBADF;
1628 filp = fget(fd);
1629 if (!filp)
1630 goto out;
1631
1632 can_sleep = !(cmd & LOCK_NB);
1633 cmd &= ~LOCK_NB;
1634 unlock = (cmd == LOCK_UN);
1635
Al Viroaeb5d722008-09-02 15:28:45 -04001636 if (!unlock && !(cmd & LOCK_MAND) &&
1637 !(filp->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 goto out_putf;
1639
1640 error = flock_make_lock(filp, &lock, cmd);
1641 if (error)
1642 goto out_putf;
1643 if (can_sleep)
1644 lock->fl_flags |= FL_SLEEP;
1645
Sten Spans713c0ec2009-07-16 09:41:39 +02001646 error = security_file_lock(filp, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 if (error)
1648 goto out_free;
1649
1650 if (filp->f_op && filp->f_op->flock)
1651 error = filp->f_op->flock(filp,
1652 (can_sleep) ? F_SETLKW : F_SETLK,
1653 lock);
1654 else
1655 error = flock_lock_file_wait(filp, lock);
1656
1657 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08001658 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659
1660 out_putf:
1661 fput(filp);
1662 out:
1663 return error;
1664}
1665
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001666/**
1667 * vfs_test_lock - test file byte range lock
1668 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04001669 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001670 *
1671 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1672 * setting conf->fl_type to something other than F_UNLCK.
1673 */
1674int vfs_test_lock(struct file *filp, struct file_lock *fl)
1675{
1676 if (filp->f_op && filp->f_op->lock)
1677 return filp->f_op->lock(filp, F_GETLK, fl);
1678 posix_test_lock(filp, fl);
1679 return 0;
1680}
1681EXPORT_SYMBOL_GPL(vfs_test_lock);
1682
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001683static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1684{
1685 flock->l_pid = fl->fl_pid;
1686#if BITS_PER_LONG == 32
1687 /*
1688 * Make sure we can represent the posix lock via
1689 * legacy 32bit flock.
1690 */
1691 if (fl->fl_start > OFFT_OFFSET_MAX)
1692 return -EOVERFLOW;
1693 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1694 return -EOVERFLOW;
1695#endif
1696 flock->l_start = fl->fl_start;
1697 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1698 fl->fl_end - fl->fl_start + 1;
1699 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04001700 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001701 return 0;
1702}
1703
1704#if BITS_PER_LONG == 32
1705static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1706{
1707 flock->l_pid = fl->fl_pid;
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;
1712 flock->l_type = fl->fl_type;
1713}
1714#endif
1715
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716/* Report the first existing lock that would conflict with l.
1717 * This implements the F_GETLK command of fcntl().
1718 */
1719int fcntl_getlk(struct file *filp, struct flock __user *l)
1720{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001721 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722 struct flock flock;
1723 int error;
1724
1725 error = -EFAULT;
1726 if (copy_from_user(&flock, l, sizeof(flock)))
1727 goto out;
1728 error = -EINVAL;
1729 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1730 goto out;
1731
1732 error = flock_to_posix_lock(filp, &file_lock, &flock);
1733 if (error)
1734 goto out;
1735
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001736 error = vfs_test_lock(filp, &file_lock);
1737 if (error)
1738 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001740 flock.l_type = file_lock.fl_type;
1741 if (file_lock.fl_type != F_UNLCK) {
1742 error = posix_lock_to_flock(&flock, &file_lock);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001743 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 }
1746 error = -EFAULT;
1747 if (!copy_to_user(l, &flock, sizeof(flock)))
1748 error = 0;
1749out:
1750 return error;
1751}
1752
Marc Eshel7723ec92007-01-18 15:08:55 -05001753/**
1754 * vfs_lock_file - file byte range lock
1755 * @filp: The file to apply the lock to
1756 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1757 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001758 * @conf: Place to return a copy of the conflicting lock, if found.
1759 *
1760 * A caller that doesn't care about the conflicting lock may pass NULL
1761 * as the final argument.
1762 *
1763 * If the filesystem defines a private ->lock() method, then @conf will
1764 * be left unchanged; so a caller that cares should initialize it to
1765 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05001766 *
1767 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1768 * locks, the ->lock() interface may return asynchronously, before the lock has
1769 * been granted or denied by the underlying filesystem, if (and only if)
1770 * fl_grant is set. Callers expecting ->lock() to return asynchronously
1771 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1772 * the request is for a blocking lock. When ->lock() does return asynchronously,
Miklos Szeredibde74e42008-07-25 01:48:57 -07001773 * it must return FILE_LOCK_DEFERRED, and call ->fl_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05001774 * request completes.
1775 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07001776 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
1777 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05001778 * nonzero return code and the file system should release the lock. The file
1779 * system is also responsible to keep a corresponding posix lock when it
1780 * grants a lock so the VFS can find out which locks are locally held and do
1781 * the correct lock cleanup when required.
1782 * The underlying filesystem must not drop the kernel lock or call
Miklos Szeredibde74e42008-07-25 01:48:57 -07001783 * ->fl_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05001784 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05001785 */
Marc Eshel150b3932007-01-18 16:15:35 -05001786int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05001787{
1788 if (filp->f_op && filp->f_op->lock)
1789 return filp->f_op->lock(filp, cmd, fl);
1790 else
Marc Eshel150b3932007-01-18 16:15:35 -05001791 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05001792}
1793EXPORT_SYMBOL_GPL(vfs_lock_file);
1794
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001795static int do_lock_file_wait(struct file *filp, unsigned int cmd,
1796 struct file_lock *fl)
1797{
1798 int error;
1799
1800 error = security_file_lock(filp, fl->fl_type);
1801 if (error)
1802 return error;
1803
Miklos Szeredi764c76b2008-07-25 01:48:58 -07001804 for (;;) {
1805 error = vfs_lock_file(filp, cmd, fl, NULL);
1806 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001807 break;
Miklos Szeredi764c76b2008-07-25 01:48:58 -07001808 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1809 if (!error)
1810 continue;
1811
1812 locks_delete_block(fl);
1813 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001814 }
1815
1816 return error;
1817}
1818
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819/* Apply the lock described by l to an open file descriptor.
1820 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1821 */
Peter Staubachc2936212005-07-27 11:45:09 -07001822int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
1823 struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824{
1825 struct file_lock *file_lock = locks_alloc_lock();
1826 struct flock flock;
1827 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04001828 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 int error;
1830
1831 if (file_lock == NULL)
1832 return -ENOLCK;
1833
1834 /*
1835 * This might block, so we do it before checking the inode.
1836 */
1837 error = -EFAULT;
1838 if (copy_from_user(&flock, l, sizeof(flock)))
1839 goto out;
1840
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001841 inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842
1843 /* Don't allow mandatory locks on files that may be memory mapped
1844 * and shared.
1845 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001846 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847 error = -EAGAIN;
1848 goto out;
1849 }
1850
Peter Staubachc2936212005-07-27 11:45:09 -07001851again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852 error = flock_to_posix_lock(filp, file_lock, &flock);
1853 if (error)
1854 goto out;
1855 if (cmd == F_SETLKW) {
1856 file_lock->fl_flags |= FL_SLEEP;
1857 }
1858
1859 error = -EBADF;
1860 switch (flock.l_type) {
1861 case F_RDLCK:
1862 if (!(filp->f_mode & FMODE_READ))
1863 goto out;
1864 break;
1865 case F_WRLCK:
1866 if (!(filp->f_mode & FMODE_WRITE))
1867 goto out;
1868 break;
1869 case F_UNLCK:
1870 break;
1871 default:
1872 error = -EINVAL;
1873 goto out;
1874 }
1875
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001876 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877
Peter Staubachc2936212005-07-27 11:45:09 -07001878 /*
1879 * Attempt to detect a close/fcntl race and recover by
1880 * releasing the lock that was just acquired.
1881 */
Al Viro0b2bac22008-05-06 13:58:34 -04001882 /*
1883 * we need that spin_lock here - it prevents reordering between
1884 * update of inode->i_flock and check for it done in close().
1885 * rcu_read_lock() wouldn't do.
1886 */
1887 spin_lock(&current->files->file_lock);
1888 f = fcheck(fd);
1889 spin_unlock(&current->files->file_lock);
1890 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07001891 flock.l_type = F_UNLCK;
1892 goto again;
1893 }
1894
1895out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 locks_free_lock(file_lock);
1897 return error;
1898}
1899
1900#if BITS_PER_LONG == 32
1901/* Report the first existing lock that would conflict with l.
1902 * This implements the F_GETLK command of fcntl().
1903 */
1904int fcntl_getlk64(struct file *filp, struct flock64 __user *l)
1905{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001906 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 struct flock64 flock;
1908 int error;
1909
1910 error = -EFAULT;
1911 if (copy_from_user(&flock, l, sizeof(flock)))
1912 goto out;
1913 error = -EINVAL;
1914 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1915 goto out;
1916
1917 error = flock64_to_posix_lock(filp, &file_lock, &flock);
1918 if (error)
1919 goto out;
1920
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001921 error = vfs_test_lock(filp, &file_lock);
1922 if (error)
1923 goto out;
1924
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001925 flock.l_type = file_lock.fl_type;
1926 if (file_lock.fl_type != F_UNLCK)
1927 posix_lock_to_flock64(&flock, &file_lock);
1928
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 error = -EFAULT;
1930 if (!copy_to_user(l, &flock, sizeof(flock)))
1931 error = 0;
1932
1933out:
1934 return error;
1935}
1936
1937/* Apply the lock described by l to an open file descriptor.
1938 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1939 */
Peter Staubachc2936212005-07-27 11:45:09 -07001940int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
1941 struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942{
1943 struct file_lock *file_lock = locks_alloc_lock();
1944 struct flock64 flock;
1945 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04001946 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 int error;
1948
1949 if (file_lock == NULL)
1950 return -ENOLCK;
1951
1952 /*
1953 * This might block, so we do it before checking the inode.
1954 */
1955 error = -EFAULT;
1956 if (copy_from_user(&flock, l, sizeof(flock)))
1957 goto out;
1958
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001959 inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960
1961 /* Don't allow mandatory locks on files that may be memory mapped
1962 * and shared.
1963 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001964 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 error = -EAGAIN;
1966 goto out;
1967 }
1968
Peter Staubachc2936212005-07-27 11:45:09 -07001969again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970 error = flock64_to_posix_lock(filp, file_lock, &flock);
1971 if (error)
1972 goto out;
1973 if (cmd == F_SETLKW64) {
1974 file_lock->fl_flags |= FL_SLEEP;
1975 }
1976
1977 error = -EBADF;
1978 switch (flock.l_type) {
1979 case F_RDLCK:
1980 if (!(filp->f_mode & FMODE_READ))
1981 goto out;
1982 break;
1983 case F_WRLCK:
1984 if (!(filp->f_mode & FMODE_WRITE))
1985 goto out;
1986 break;
1987 case F_UNLCK:
1988 break;
1989 default:
1990 error = -EINVAL;
1991 goto out;
1992 }
1993
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001994 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995
Peter Staubachc2936212005-07-27 11:45:09 -07001996 /*
1997 * Attempt to detect a close/fcntl race and recover by
1998 * releasing the lock that was just acquired.
1999 */
Al Viro0b2bac22008-05-06 13:58:34 -04002000 spin_lock(&current->files->file_lock);
2001 f = fcheck(fd);
2002 spin_unlock(&current->files->file_lock);
2003 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07002004 flock.l_type = F_UNLCK;
2005 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006 }
2007
2008out:
2009 locks_free_lock(file_lock);
2010 return error;
2011}
2012#endif /* BITS_PER_LONG == 32 */
2013
2014/*
2015 * This function is called when the file is being removed
2016 * from the task's fd array. POSIX locks belonging to this task
2017 * are deleted at this time.
2018 */
2019void locks_remove_posix(struct file *filp, fl_owner_t owner)
2020{
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002021 struct file_lock lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022
2023 /*
2024 * If there are no locks held on this file, we don't need to call
2025 * posix_lock_file(). Another process could be setting a lock on this
2026 * file at the same time, but we wouldn't remove that lock anyway.
2027 */
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08002028 if (!filp->f_path.dentry->d_inode->i_flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 return;
2030
2031 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002032 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033 lock.fl_start = 0;
2034 lock.fl_end = OFFSET_MAX;
2035 lock.fl_owner = owner;
2036 lock.fl_pid = current->tgid;
2037 lock.fl_file = filp;
2038 lock.fl_ops = NULL;
2039 lock.fl_lmops = NULL;
2040
Marc Eshel150b3932007-01-18 16:15:35 -05002041 vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2044 lock.fl_ops->fl_release_private(&lock);
2045}
2046
2047EXPORT_SYMBOL(locks_remove_posix);
2048
2049/*
2050 * This function is called on the last close of an open file.
2051 */
2052void locks_remove_flock(struct file *filp)
2053{
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08002054 struct inode * inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055 struct file_lock *fl;
2056 struct file_lock **before;
2057
2058 if (!inode->i_flock)
2059 return;
2060
2061 if (filp->f_op && filp->f_op->flock) {
2062 struct file_lock fl = {
2063 .fl_pid = current->tgid,
2064 .fl_file = filp,
2065 .fl_flags = FL_FLOCK,
2066 .fl_type = F_UNLCK,
2067 .fl_end = OFFSET_MAX,
2068 };
2069 filp->f_op->flock(filp, F_SETLKW, &fl);
Trond Myklebust80fec4c2005-06-22 17:16:31 +00002070 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2071 fl.fl_ops->fl_release_private(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072 }
2073
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002074 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 before = &inode->i_flock;
2076
2077 while ((fl = *before) != NULL) {
2078 if (fl->fl_file == filp) {
Peter Staubachc2936212005-07-27 11:45:09 -07002079 if (IS_FLOCK(fl)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 locks_delete_lock(before);
2081 continue;
2082 }
2083 if (IS_LEASE(fl)) {
2084 lease_modify(before, F_UNLCK);
2085 continue;
2086 }
2087 /* What? */
2088 BUG();
2089 }
2090 before = &fl->fl_next;
2091 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002092 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093}
2094
2095/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096 * posix_unblock_lock - stop waiting for a file lock
2097 * @filp: how the file was opened
2098 * @waiter: the lock which was waiting
2099 *
2100 * lockd needs to block waiting for locks.
2101 */
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002102int
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103posix_unblock_lock(struct file *filp, struct file_lock *waiter)
2104{
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002105 int status = 0;
2106
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002107 lock_flocks();
J. Bruce Fields5996a292006-01-03 09:55:44 +01002108 if (waiter->fl_next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 __locks_delete_block(waiter);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002110 else
2111 status = -ENOENT;
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002112 unlock_flocks();
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002113 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114}
2115
2116EXPORT_SYMBOL(posix_unblock_lock);
2117
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002118/**
2119 * vfs_cancel_lock - file byte range unblock lock
2120 * @filp: The file to apply the unblock to
2121 * @fl: The lock to be unblocked
2122 *
2123 * Used by lock managers to cancel blocked requests
2124 */
2125int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2126{
2127 if (filp->f_op && filp->f_op->lock)
2128 return filp->f_op->lock(filp, F_CANCELLK, fl);
2129 return 0;
2130}
2131
2132EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2133
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002134#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002135#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002136#include <linux/seq_file.h>
2137
2138static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002139 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140{
2141 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002142 unsigned int fl_pid;
2143
2144 if (fl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -08002145 fl_pid = pid_vnr(fl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002146 else
2147 fl_pid = fl->fl_pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148
2149 if (fl->fl_file != NULL)
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08002150 inode = fl->fl_file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151
Jerome Marchand99dc8292010-10-26 14:22:33 -07002152 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 if (IS_POSIX(fl)) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002154 seq_printf(f, "%6s %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155 (fl->fl_flags & FL_ACCESS) ? "ACCESS" : "POSIX ",
2156 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002157 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 } else if (IS_FLOCK(fl)) {
2159 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002160 seq_printf(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002162 seq_printf(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163 }
2164 } else if (IS_LEASE(fl)) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002165 seq_printf(f, "LEASE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 if (fl->fl_type & F_INPROGRESS)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002167 seq_printf(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 else if (fl->fl_file)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002169 seq_printf(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002171 seq_printf(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002173 seq_printf(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 }
2175 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002176 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 (fl->fl_type & LOCK_READ)
2178 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2179 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2180 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002181 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 (fl->fl_type & F_INPROGRESS)
2183 ? (fl->fl_type & F_UNLCK) ? "UNLCK" : "READ "
2184 : (fl->fl_type & F_WRLCK) ? "WRITE" : "READ ");
2185 }
2186 if (inode) {
2187#ifdef WE_CAN_BREAK_LSLK_NOW
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002188 seq_printf(f, "%d %s:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 inode->i_sb->s_id, inode->i_ino);
2190#else
2191 /* userspace relies on this representation of dev_t ;-( */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002192 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193 MAJOR(inode->i_sb->s_dev),
2194 MINOR(inode->i_sb->s_dev), inode->i_ino);
2195#endif
2196 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002197 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 }
2199 if (IS_POSIX(fl)) {
2200 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002201 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002203 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002205 seq_printf(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206 }
2207}
2208
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002209static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210{
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002211 struct file_lock *fl, *bfl;
2212
2213 fl = list_entry(v, struct file_lock, fl_link);
2214
Jerome Marchand99dc8292010-10-26 14:22:33 -07002215 lock_get_status(f, fl, *((loff_t *)f->private), "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002216
2217 list_for_each_entry(bfl, &fl->fl_block, fl_block)
Jerome Marchand99dc8292010-10-26 14:22:33 -07002218 lock_get_status(f, bfl, *((loff_t *)f->private), " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002219
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002220 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221}
2222
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002223static void *locks_start(struct seq_file *f, loff_t *pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224{
Jerome Marchand99dc8292010-10-26 14:22:33 -07002225 loff_t *p = f->private;
2226
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002227 lock_flocks();
Jerome Marchand99dc8292010-10-26 14:22:33 -07002228 *p = (*pos + 1);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002229 return seq_list_start(&file_lock_list, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230}
2231
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002232static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2233{
Jerome Marchand99dc8292010-10-26 14:22:33 -07002234 loff_t *p = f->private;
2235 ++*p;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002236 return seq_list_next(v, &file_lock_list, pos);
2237}
2238
2239static void locks_stop(struct seq_file *f, void *v)
2240{
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002241 unlock_flocks();
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002242}
2243
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002244static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002245 .start = locks_start,
2246 .next = locks_next,
2247 .stop = locks_stop,
2248 .show = locks_show,
2249};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002250
2251static int locks_open(struct inode *inode, struct file *filp)
2252{
Jerome Marchand99dc8292010-10-26 14:22:33 -07002253 return seq_open_private(filp, &locks_seq_operations, sizeof(loff_t));
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002254}
2255
2256static const struct file_operations proc_locks_operations = {
2257 .open = locks_open,
2258 .read = seq_read,
2259 .llseek = seq_lseek,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002260 .release = seq_release_private,
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002261};
2262
2263static int __init proc_locks_init(void)
2264{
2265 proc_create("locks", 0, NULL, &proc_locks_operations);
2266 return 0;
2267}
2268module_init(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002269#endif
2270
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271/**
2272 * lock_may_read - checks that the region is free of locks
2273 * @inode: the inode that is being read
2274 * @start: the first byte to read
2275 * @len: the number of bytes to read
2276 *
2277 * Emulates Windows locking requirements. Whole-file
2278 * mandatory locks (share modes) can prohibit a read and
2279 * byte-range POSIX locks can prohibit a read if they overlap.
2280 *
2281 * N.B. this function is only ever called
2282 * from knfsd and ownership of locks is never checked.
2283 */
2284int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2285{
2286 struct file_lock *fl;
2287 int result = 1;
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002288 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2290 if (IS_POSIX(fl)) {
2291 if (fl->fl_type == F_RDLCK)
2292 continue;
2293 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2294 continue;
2295 } else if (IS_FLOCK(fl)) {
2296 if (!(fl->fl_type & LOCK_MAND))
2297 continue;
2298 if (fl->fl_type & LOCK_READ)
2299 continue;
2300 } else
2301 continue;
2302 result = 0;
2303 break;
2304 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002305 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 return result;
2307}
2308
2309EXPORT_SYMBOL(lock_may_read);
2310
2311/**
2312 * lock_may_write - checks that the region is free of locks
2313 * @inode: the inode that is being written
2314 * @start: the first byte to write
2315 * @len: the number of bytes to write
2316 *
2317 * Emulates Windows locking requirements. Whole-file
2318 * mandatory locks (share modes) can prohibit a write and
2319 * byte-range POSIX locks can prohibit a write if they overlap.
2320 *
2321 * N.B. this function is only ever called
2322 * from knfsd and ownership of locks is never checked.
2323 */
2324int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2325{
2326 struct file_lock *fl;
2327 int result = 1;
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002328 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2330 if (IS_POSIX(fl)) {
2331 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2332 continue;
2333 } else if (IS_FLOCK(fl)) {
2334 if (!(fl->fl_type & LOCK_MAND))
2335 continue;
2336 if (fl->fl_type & LOCK_WRITE)
2337 continue;
2338 } else
2339 continue;
2340 result = 0;
2341 break;
2342 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002343 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344 return result;
2345}
2346
2347EXPORT_SYMBOL(lock_may_write);
2348
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349static int __init filelock_init(void)
2350{
2351 filelock_cache = kmem_cache_create("file_lock_cache",
2352 sizeof(struct file_lock), 0, SLAB_PANIC,
Paul Mundt20c2df82007-07-20 10:11:58 +09002353 init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354 return 0;
2355}
2356
2357core_initcall(filelock_init);