blob: 2c2d3b804d62c0c8e3a059b024efff06d3c7412d [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125#include <linux/syscalls.h>
126#include <linux/time.h>
Dipankar Sarma4fb3a532005-09-16 19:28:13 -0700127#include <linux/rcupdate.h>
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000128#include <linux/pid_namespace.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130#include <asm/uaccess.h>
131
132#define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
133#define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
134#define IS_LEASE(fl) (fl->fl_flags & FL_LEASE)
135
136int leases_enable = 1;
137int lease_break_time = 45;
138
139#define for_each_lock(inode, lockp) \
140 for (lockp = &inode->i_flock; *lockp != NULL; lockp = &(*lockp)->fl_next)
141
Christoph Hellwig26bcbf92006-03-20 13:44:40 -0500142static LIST_HEAD(file_lock_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143static LIST_HEAD(blocked_list);
Arnd Bergmann72f98e72010-10-27 21:39:58 +0200144static DEFINE_SPINLOCK(file_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200146/*
147 * Protects the two list heads above, plus the inode->i_flock list
148 * FIXME: should use a spinlock, once lockd and ceph are ready.
149 */
150void lock_flocks(void)
151{
Arnd Bergmann72f98e72010-10-27 21:39:58 +0200152 spin_lock(&file_lock_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200153}
154EXPORT_SYMBOL_GPL(lock_flocks);
155
156void unlock_flocks(void)
157{
Arnd Bergmann72f98e72010-10-27 21:39:58 +0200158 spin_unlock(&file_lock_lock);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200159}
160EXPORT_SYMBOL_GPL(unlock_flocks);
161
Christoph Lametere18b8902006-12-06 20:33:20 -0800162static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
164/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200165struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166{
Christoph Lametere94b1762006-12-06 20:33:17 -0800167 return kmem_cache_alloc(filelock_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200169EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500171void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500172{
173 if (fl->fl_ops) {
174 if (fl->fl_ops->fl_release_private)
175 fl->fl_ops->fl_release_private(fl);
176 fl->fl_ops = NULL;
177 }
178 if (fl->fl_lmops) {
179 if (fl->fl_lmops->fl_release_private)
180 fl->fl_lmops->fl_release_private(fl);
181 fl->fl_lmops = NULL;
182 }
183
184}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500185EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500186
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187/* Free a lock which is not in use. */
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400188void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189{
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800190 BUG_ON(waitqueue_active(&fl->fl_wait));
191 BUG_ON(!list_empty(&fl->fl_block));
192 BUG_ON(!list_empty(&fl->fl_link));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
Trond Myklebust47831f32006-03-20 13:44:05 -0500194 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 kmem_cache_free(filelock_cache, fl);
196}
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400197EXPORT_SYMBOL(locks_free_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
199void locks_init_lock(struct file_lock *fl)
200{
201 INIT_LIST_HEAD(&fl->fl_link);
202 INIT_LIST_HEAD(&fl->fl_block);
203 init_waitqueue_head(&fl->fl_wait);
204 fl->fl_next = NULL;
205 fl->fl_fasync = NULL;
206 fl->fl_owner = NULL;
207 fl->fl_pid = 0;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000208 fl->fl_nspid = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 fl->fl_file = NULL;
210 fl->fl_flags = 0;
211 fl->fl_type = 0;
212 fl->fl_start = fl->fl_end = 0;
213 fl->fl_ops = NULL;
214 fl->fl_lmops = NULL;
215}
216
217EXPORT_SYMBOL(locks_init_lock);
218
219/*
220 * Initialises the fields of the file lock which are invariant for
221 * free file_locks.
222 */
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700223static void init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224{
225 struct file_lock *lock = (struct file_lock *) foo;
226
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 locks_init_lock(lock);
228}
229
Trond Myklebust47831f32006-03-20 13:44:05 -0500230static void locks_copy_private(struct file_lock *new, struct file_lock *fl)
231{
232 if (fl->fl_ops) {
233 if (fl->fl_ops->fl_copy_lock)
234 fl->fl_ops->fl_copy_lock(new, fl);
235 new->fl_ops = fl->fl_ops;
236 }
Christoph Hellwigbb8430a2010-10-31 08:35:31 -0400237 if (fl->fl_lmops)
Trond Myklebust47831f32006-03-20 13:44:05 -0500238 new->fl_lmops = fl->fl_lmops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500239}
240
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241/*
242 * Initialize a new lock from an existing file_lock structure.
243 */
J. Bruce Fields1a747ee2008-04-24 10:08:22 -0400244void __locks_copy_lock(struct file_lock *new, const struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245{
246 new->fl_owner = fl->fl_owner;
247 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500248 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 new->fl_flags = fl->fl_flags;
250 new->fl_type = fl->fl_type;
251 new->fl_start = fl->fl_start;
252 new->fl_end = fl->fl_end;
Trond Myklebust09969052006-03-20 13:44:38 -0500253 new->fl_ops = NULL;
254 new->fl_lmops = NULL;
255}
Roland Dreier3dd7b712008-04-25 15:32:51 -0700256EXPORT_SYMBOL(__locks_copy_lock);
Trond Myklebust09969052006-03-20 13:44:38 -0500257
258void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
259{
260 locks_release_private(new);
261
262 __locks_copy_lock(new, fl);
263 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 new->fl_ops = fl->fl_ops;
265 new->fl_lmops = fl->fl_lmops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500266
267 locks_copy_private(new, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268}
269
270EXPORT_SYMBOL(locks_copy_lock);
271
272static inline int flock_translate_cmd(int cmd) {
273 if (cmd & LOCK_MAND)
274 return cmd & (LOCK_MAND | LOCK_RW);
275 switch (cmd) {
276 case LOCK_SH:
277 return F_RDLCK;
278 case LOCK_EX:
279 return F_WRLCK;
280 case LOCK_UN:
281 return F_UNLCK;
282 }
283 return -EINVAL;
284}
285
286/* Fill in a file_lock structure with an appropriate FLOCK lock. */
287static int flock_make_lock(struct file *filp, struct file_lock **lock,
288 unsigned int cmd)
289{
290 struct file_lock *fl;
291 int type = flock_translate_cmd(cmd);
292 if (type < 0)
293 return type;
294
295 fl = locks_alloc_lock();
296 if (fl == NULL)
297 return -ENOMEM;
298
299 fl->fl_file = filp;
300 fl->fl_pid = current->tgid;
301 fl->fl_flags = FL_FLOCK;
302 fl->fl_type = type;
303 fl->fl_end = OFFSET_MAX;
304
305 *lock = fl;
306 return 0;
307}
308
309static int assign_type(struct file_lock *fl, int type)
310{
311 switch (type) {
312 case F_RDLCK:
313 case F_WRLCK:
314 case F_UNLCK:
315 fl->fl_type = type;
316 break;
317 default:
318 return -EINVAL;
319 }
320 return 0;
321}
322
323/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
324 * style lock.
325 */
326static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
327 struct flock *l)
328{
329 off_t start, end;
330
331 switch (l->l_whence) {
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700332 case SEEK_SET:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 start = 0;
334 break;
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700335 case SEEK_CUR:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 start = filp->f_pos;
337 break;
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700338 case SEEK_END:
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800339 start = i_size_read(filp->f_path.dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 break;
341 default:
342 return -EINVAL;
343 }
344
345 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
346 POSIX-2001 defines it. */
347 start += l->l_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 if (start < 0)
349 return -EINVAL;
Trond Myklebust4c780a42005-10-18 14:20:21 -0700350 fl->fl_end = OFFSET_MAX;
351 if (l->l_len > 0) {
352 end = start + l->l_len - 1;
353 fl->fl_end = end;
354 } else if (l->l_len < 0) {
355 end = start - 1;
356 fl->fl_end = end;
357 start += l->l_len;
358 if (start < 0)
359 return -EINVAL;
360 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 fl->fl_start = start; /* we record the absolute position */
Trond Myklebust4c780a42005-10-18 14:20:21 -0700362 if (fl->fl_end < fl->fl_start)
363 return -EOVERFLOW;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
365 fl->fl_owner = current->files;
366 fl->fl_pid = current->tgid;
367 fl->fl_file = filp;
368 fl->fl_flags = FL_POSIX;
369 fl->fl_ops = NULL;
370 fl->fl_lmops = NULL;
371
372 return assign_type(fl, l->l_type);
373}
374
375#if BITS_PER_LONG == 32
376static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
377 struct flock64 *l)
378{
379 loff_t start;
380
381 switch (l->l_whence) {
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700382 case SEEK_SET:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 start = 0;
384 break;
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700385 case SEEK_CUR:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 start = filp->f_pos;
387 break;
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700388 case SEEK_END:
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800389 start = i_size_read(filp->f_path.dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 break;
391 default:
392 return -EINVAL;
393 }
394
Trond Myklebust4c780a42005-10-18 14:20:21 -0700395 start += l->l_start;
396 if (start < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 return -EINVAL;
Trond Myklebust4c780a42005-10-18 14:20:21 -0700398 fl->fl_end = OFFSET_MAX;
399 if (l->l_len > 0) {
400 fl->fl_end = start + l->l_len - 1;
401 } else if (l->l_len < 0) {
402 fl->fl_end = start - 1;
403 start += l->l_len;
404 if (start < 0)
405 return -EINVAL;
406 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 fl->fl_start = start; /* we record the absolute position */
Trond Myklebust4c780a42005-10-18 14:20:21 -0700408 if (fl->fl_end < fl->fl_start)
409 return -EOVERFLOW;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
411 fl->fl_owner = current->files;
412 fl->fl_pid = current->tgid;
413 fl->fl_file = filp;
414 fl->fl_flags = FL_POSIX;
415 fl->fl_ops = NULL;
416 fl->fl_lmops = NULL;
417
Namhyung Kimf32cb532011-01-17 15:45:59 +0900418 return assign_type(fl, l->l_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419}
420#endif
421
422/* default lease lock manager operations */
423static void lease_break_callback(struct file_lock *fl)
424{
425 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
426}
427
428static void lease_release_private_callback(struct file_lock *fl)
429{
430 if (!fl->fl_file)
431 return;
432
433 f_delown(fl->fl_file);
434 fl->fl_file->f_owner.signum = 0;
435}
436
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700437static const struct lock_manager_operations lease_manager_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 .fl_break = lease_break_callback,
439 .fl_release_private = lease_release_private_callback,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 .fl_change = lease_modify,
441};
442
443/*
444 * Initialize a lease, use the default lock manager operations
445 */
446static int lease_init(struct file *filp, int type, struct file_lock *fl)
447 {
Trond Myklebust75dff552006-05-07 23:02:42 -0400448 if (assign_type(fl, type) != 0)
449 return -EINVAL;
450
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 fl->fl_owner = current->files;
452 fl->fl_pid = current->tgid;
453
454 fl->fl_file = filp;
455 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 fl->fl_start = 0;
457 fl->fl_end = OFFSET_MAX;
458 fl->fl_ops = NULL;
459 fl->fl_lmops = &lease_manager_ops;
460 return 0;
461}
462
463/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500464static struct file_lock *lease_alloc(struct file *filp, int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465{
466 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400467 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
469 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500470 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
472 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400473 if (error) {
474 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500475 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400476 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500477 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478}
479
480/* Check if two locks overlap each other.
481 */
482static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
483{
484 return ((fl1->fl_end >= fl2->fl_start) &&
485 (fl2->fl_end >= fl1->fl_start));
486}
487
488/*
489 * Check whether two locks have the same owner.
490 */
Matt Mackall33443c42006-01-08 01:05:22 -0800491static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492{
493 if (fl1->fl_lmops && fl1->fl_lmops->fl_compare_owner)
494 return fl2->fl_lmops == fl1->fl_lmops &&
495 fl1->fl_lmops->fl_compare_owner(fl1, fl2);
496 return fl1->fl_owner == fl2->fl_owner;
497}
498
499/* Remove waiter from blocker's block list.
500 * When blocker ends up pointing to itself then the list is empty.
501 */
Matt Mackall33443c42006-01-08 01:05:22 -0800502static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503{
504 list_del_init(&waiter->fl_block);
505 list_del_init(&waiter->fl_link);
506 waiter->fl_next = NULL;
507}
508
509/*
510 */
511static void locks_delete_block(struct file_lock *waiter)
512{
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200513 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 __locks_delete_block(waiter);
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200515 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516}
517
518/* Insert waiter into blocker's block list.
519 * We use a circular list so that processes can be easily woken up in
520 * the order they blocked. The documentation doesn't require this but
521 * it seems like the reasonable thing to do.
522 */
523static void locks_insert_block(struct file_lock *blocker,
524 struct file_lock *waiter)
525{
J. Bruce Fields6dc0fe82006-03-26 01:37:24 -0800526 BUG_ON(!list_empty(&waiter->fl_block));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 list_add_tail(&waiter->fl_block, &blocker->fl_block);
528 waiter->fl_next = blocker;
529 if (IS_POSIX(blocker))
530 list_add(&waiter->fl_link, &blocked_list);
531}
532
533/* Wake up processes blocked waiting for blocker.
534 * If told to wait then schedule the processes until the block list
535 * is empty, otherwise empty the block list ourselves.
536 */
537static void locks_wake_up_blocks(struct file_lock *blocker)
538{
539 while (!list_empty(&blocker->fl_block)) {
Pavel Emelyanovf0c1cd02007-09-19 16:44:07 +0400540 struct file_lock *waiter;
541
542 waiter = list_first_entry(&blocker->fl_block,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 struct file_lock, fl_block);
544 __locks_delete_block(waiter);
545 if (waiter->fl_lmops && waiter->fl_lmops->fl_notify)
546 waiter->fl_lmops->fl_notify(waiter);
547 else
548 wake_up(&waiter->fl_wait);
549 }
550}
551
552/* Insert file lock fl into an inode's lock list at the position indicated
553 * by pos. At the same time add the lock to the global file lock list.
554 */
555static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
556{
557 list_add(&fl->fl_link, &file_lock_list);
558
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000559 fl->fl_nspid = get_pid(task_tgid(current));
560
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 /* insert into file's list */
562 fl->fl_next = *pos;
563 *pos = fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564}
565
566/*
567 * Delete a lock and then free it.
568 * Wake up processes that are blocked waiting for this lock,
569 * notify the FS that the lock has been cleared and
570 * finally free the lock.
571 */
572static void locks_delete_lock(struct file_lock **thisfl_p)
573{
574 struct file_lock *fl = *thisfl_p;
575
576 *thisfl_p = fl->fl_next;
577 fl->fl_next = NULL;
578 list_del_init(&fl->fl_link);
579
580 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
581 if (fl->fl_fasync != NULL) {
582 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
583 fl->fl_fasync = NULL;
584 }
585
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000586 if (fl->fl_nspid) {
587 put_pid(fl->fl_nspid);
588 fl->fl_nspid = NULL;
589 }
590
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 locks_wake_up_blocks(fl);
592 locks_free_lock(fl);
593}
594
595/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
596 * checks for shared/exclusive status of overlapping locks.
597 */
598static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
599{
600 if (sys_fl->fl_type == F_WRLCK)
601 return 1;
602 if (caller_fl->fl_type == F_WRLCK)
603 return 1;
604 return 0;
605}
606
607/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
608 * checking before calling the locks_conflict().
609 */
610static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
611{
612 /* POSIX locks owned by the same process do not conflict with
613 * each other.
614 */
615 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
616 return (0);
617
618 /* Check whether they overlap */
619 if (!locks_overlap(caller_fl, sys_fl))
620 return 0;
621
622 return (locks_conflict(caller_fl, sys_fl));
623}
624
625/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
626 * checking before calling the locks_conflict().
627 */
628static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
629{
630 /* FLOCK locks referring to the same filp do not conflict with
631 * each other.
632 */
633 if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
634 return (0);
635 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
636 return 0;
637
638 return (locks_conflict(caller_fl, sys_fl));
639}
640
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400641void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500642posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643{
644 struct file_lock *cfl;
645
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200646 lock_flocks();
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800647 for (cfl = filp->f_path.dentry->d_inode->i_flock; cfl; cfl = cfl->fl_next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 if (!IS_POSIX(cfl))
649 continue;
J. Bruce Fieldsb842e242007-05-10 19:02:07 -0400650 if (posix_locks_conflict(fl, cfl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 break;
652 }
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000653 if (cfl) {
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500654 __locks_copy_lock(fl, cfl);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000655 if (cfl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -0800656 fl->fl_pid = pid_vnr(cfl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000657 } else
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400658 fl->fl_type = F_UNLCK;
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200659 unlock_flocks();
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400660 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662EXPORT_SYMBOL(posix_test_lock);
663
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400664/*
665 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400667 * We attempt to detect deadlocks that are due purely to posix file
668 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400670 * We assume that a task can be waiting for at most one lock at a time.
671 * So for any acquired lock, the process holding that lock may be
672 * waiting on at most one other lock. That lock in turns may be held by
673 * someone waiting for at most one other lock. Given a requested lock
674 * caller_fl which is about to wait for a conflicting lock block_fl, we
675 * follow this chain of waiters to ensure we are not about to create a
676 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400677 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400678 * Since we do this before we ever put a process to sleep on a lock, we
679 * are ensured that there is never a cycle; that is what guarantees that
680 * the while() loop in posix_locks_deadlock() eventually completes.
681 *
682 * Note: the above assumption may not be true when handling lock
683 * requests from a broken NFS client. It may also fail in the presence
684 * of tasks (such as posix threads) sharing the same open file table.
685 *
686 * To handle those cases, we just bail out after a few iterations.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400688
689#define MAX_DEADLK_ITERATIONS 10
690
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400691/* Find a lock that the owner of the given block_fl is blocking on. */
692static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
693{
694 struct file_lock *fl;
695
696 list_for_each_entry(fl, &blocked_list, fl_link) {
697 if (posix_same_owner(fl, block_fl))
698 return fl->fl_next;
699 }
700 return NULL;
701}
702
Adrian Bunkb0904e12006-06-23 02:05:13 -0700703static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 struct file_lock *block_fl)
705{
J. Bruce Fields97855b42007-10-30 11:20:02 -0400706 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400708 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
709 if (i++ > MAX_DEADLK_ITERATIONS)
710 return 0;
711 if (posix_same_owner(caller_fl, block_fl))
712 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 }
714 return 0;
715}
716
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -0400718 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -0400719 *
720 * Note that if called with an FL_EXISTS argument, the caller may determine
721 * whether or not a lock was successfully freed by testing the return
722 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 */
Trond Myklebust993dfa82006-03-31 02:30:55 -0800724static int flock_lock_file(struct file *filp, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725{
Trond Myklebust993dfa82006-03-31 02:30:55 -0800726 struct file_lock *new_fl = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 struct file_lock **before;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800728 struct inode * inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 int error = 0;
730 int found = 0;
731
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200732 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
733 new_fl = locks_alloc_lock();
734 if (!new_fl)
735 return -ENOMEM;
736 }
737
738 lock_flocks();
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400739 if (request->fl_flags & FL_ACCESS)
740 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +0400741
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 for_each_lock(inode, before) {
743 struct file_lock *fl = *before;
744 if (IS_POSIX(fl))
745 break;
746 if (IS_LEASE(fl))
747 continue;
748 if (filp != fl->fl_file)
749 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800750 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 goto out;
752 found = 1;
753 locks_delete_lock(before);
754 break;
755 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756
Trond Myklebustf475ae92006-06-29 16:38:32 -0400757 if (request->fl_type == F_UNLCK) {
758 if ((request->fl_flags & FL_EXISTS) && !found)
759 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800760 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400761 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
763 /*
764 * If a higher-priority process was blocked on the old file lock,
765 * give it the opportunity to lock the file.
766 */
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200767 if (found) {
768 unlock_flocks();
Frederic Weisbeckerdef01bc2009-07-16 15:44:29 +0200769 cond_resched();
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200770 lock_flocks();
771 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400773find_conflict:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 for_each_lock(inode, before) {
775 struct file_lock *fl = *before;
776 if (IS_POSIX(fl))
777 break;
778 if (IS_LEASE(fl))
779 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800780 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 continue;
782 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700783 if (!(request->fl_flags & FL_SLEEP))
784 goto out;
785 error = FILE_LOCK_DEFERRED;
786 locks_insert_block(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 goto out;
788 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400789 if (request->fl_flags & FL_ACCESS)
790 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800791 locks_copy_lock(new_fl, request);
Pavel Emelyanov0e2f6db2007-09-11 15:24:01 -0700792 locks_insert_lock(before, new_fl);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800793 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +0400794 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795
796out:
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200797 unlock_flocks();
Trond Myklebust993dfa82006-03-31 02:30:55 -0800798 if (new_fl)
799 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 return error;
801}
802
Marc Eshel150b3932007-01-18 16:15:35 -0500803static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804{
805 struct file_lock *fl;
Miklos Szeredi39005d02006-06-23 02:05:10 -0700806 struct file_lock *new_fl = NULL;
807 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 struct file_lock *left = NULL;
809 struct file_lock *right = NULL;
810 struct file_lock **before;
811 int error, added = 0;
812
813 /*
814 * We may need two file_lock structures for this operation,
815 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -0700816 *
817 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 */
Miklos Szeredi39005d02006-06-23 02:05:10 -0700819 if (!(request->fl_flags & FL_ACCESS) &&
820 (request->fl_type != F_UNLCK ||
821 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
822 new_fl = locks_alloc_lock();
823 new_fl2 = locks_alloc_lock();
824 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200826 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 if (request->fl_type != F_UNLCK) {
828 for_each_lock(inode, before) {
J. Bruce Fields526985b2006-11-14 16:54:36 -0500829 fl = *before;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 if (!IS_POSIX(fl))
831 continue;
832 if (!posix_locks_conflict(request, fl))
833 continue;
Andy Adamson5842add2006-03-26 01:37:26 -0800834 if (conflock)
J. Bruce Fields1a747ee2008-04-24 10:08:22 -0400835 __locks_copy_lock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 error = -EAGAIN;
837 if (!(request->fl_flags & FL_SLEEP))
838 goto out;
839 error = -EDEADLK;
840 if (posix_locks_deadlock(request, fl))
841 goto out;
Miklos Szeredibde74e42008-07-25 01:48:57 -0700842 error = FILE_LOCK_DEFERRED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 locks_insert_block(fl, request);
844 goto out;
845 }
846 }
847
848 /* If we're just looking for a conflict, we're done. */
849 error = 0;
850 if (request->fl_flags & FL_ACCESS)
851 goto out;
852
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 * Find the first old lock with the same owner as the new lock.
855 */
856
857 before = &inode->i_flock;
858
859 /* First skip locks owned by other processes. */
860 while ((fl = *before) && (!IS_POSIX(fl) ||
861 !posix_same_owner(request, fl))) {
862 before = &fl->fl_next;
863 }
864
865 /* Process locks with this owner. */
866 while ((fl = *before) && posix_same_owner(request, fl)) {
867 /* Detect adjacent or overlapping regions (if same lock type)
868 */
869 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -0700870 /* In all comparisons of start vs end, use
871 * "start - 1" rather than "end + 1". If end
872 * is OFFSET_MAX, end + 1 will become negative.
873 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 if (fl->fl_end < request->fl_start - 1)
875 goto next_lock;
876 /* If the next lock in the list has entirely bigger
877 * addresses than the new one, insert the lock here.
878 */
Olaf Kirch449231d2005-08-25 16:25:35 -0700879 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 break;
881
882 /* If we come here, the new and old lock are of the
883 * same type and adjacent or overlapping. Make one
884 * lock yielding from the lower start address of both
885 * locks to the higher end address.
886 */
887 if (fl->fl_start > request->fl_start)
888 fl->fl_start = request->fl_start;
889 else
890 request->fl_start = fl->fl_start;
891 if (fl->fl_end < request->fl_end)
892 fl->fl_end = request->fl_end;
893 else
894 request->fl_end = fl->fl_end;
895 if (added) {
896 locks_delete_lock(before);
897 continue;
898 }
899 request = fl;
900 added = 1;
901 }
902 else {
903 /* Processing for different lock types is a bit
904 * more complex.
905 */
906 if (fl->fl_end < request->fl_start)
907 goto next_lock;
908 if (fl->fl_start > request->fl_end)
909 break;
910 if (request->fl_type == F_UNLCK)
911 added = 1;
912 if (fl->fl_start < request->fl_start)
913 left = fl;
914 /* If the next lock in the list has a higher end
915 * address than the new one, insert the new one here.
916 */
917 if (fl->fl_end > request->fl_end) {
918 right = fl;
919 break;
920 }
921 if (fl->fl_start >= request->fl_start) {
922 /* The new lock completely replaces an old
923 * one (This may happen several times).
924 */
925 if (added) {
926 locks_delete_lock(before);
927 continue;
928 }
929 /* Replace the old lock with the new one.
930 * Wake up anybody waiting for the old one,
931 * as the change in lock type might satisfy
932 * their needs.
933 */
934 locks_wake_up_blocks(fl);
935 fl->fl_start = request->fl_start;
936 fl->fl_end = request->fl_end;
937 fl->fl_type = request->fl_type;
Trond Myklebust47831f32006-03-20 13:44:05 -0500938 locks_release_private(fl);
939 locks_copy_private(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 request = fl;
941 added = 1;
942 }
943 }
944 /* Go on to next lock.
945 */
946 next_lock:
947 before = &fl->fl_next;
948 }
949
Miklos Szeredi0d9a4902006-06-23 02:05:09 -0700950 /*
951 * The above code only modifies existing locks in case of
952 * merging or replacing. If new lock(s) need to be inserted
953 * all modifications are done bellow this, so it's safe yet to
954 * bail out.
955 */
956 error = -ENOLCK; /* "no luck" */
957 if (right && left == right && !new_fl2)
958 goto out;
959
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 error = 0;
961 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -0400962 if (request->fl_type == F_UNLCK) {
963 if (request->fl_flags & FL_EXISTS)
964 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400966 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -0700967
968 if (!new_fl) {
969 error = -ENOLCK;
970 goto out;
971 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 locks_copy_lock(new_fl, request);
973 locks_insert_lock(before, new_fl);
974 new_fl = NULL;
975 }
976 if (right) {
977 if (left == right) {
978 /* The new lock breaks the old one in two pieces,
979 * so we have to use the second new lock.
980 */
981 left = new_fl2;
982 new_fl2 = NULL;
983 locks_copy_lock(left, right);
984 locks_insert_lock(before, left);
985 }
986 right->fl_start = request->fl_end + 1;
987 locks_wake_up_blocks(right);
988 }
989 if (left) {
990 left->fl_end = request->fl_start - 1;
991 locks_wake_up_blocks(left);
992 }
993 out:
Arnd Bergmannb89f4322010-09-18 15:09:31 +0200994 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 /*
996 * Free any unused locks.
997 */
998 if (new_fl)
999 locks_free_lock(new_fl);
1000 if (new_fl2)
1001 locks_free_lock(new_fl2);
1002 return error;
1003}
1004
1005/**
1006 * posix_lock_file - Apply a POSIX-style lock to a file
1007 * @filp: The file to apply the lock to
1008 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001009 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 *
1011 * Add a POSIX style lock to a file.
1012 * We merge adjacent & overlapping locks whenever possible.
1013 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001014 *
1015 * Note that if called with an FL_EXISTS argument, the caller may determine
1016 * whether or not a lock was successfully freed by testing the return
1017 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 */
Marc Eshel150b3932007-01-18 16:15:35 -05001019int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001020 struct file_lock *conflock)
1021{
Marc Eshel150b3932007-01-18 16:15:35 -05001022 return __posix_lock_file(filp->f_path.dentry->d_inode, fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001023}
Marc Eshel150b3932007-01-18 16:15:35 -05001024EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025
1026/**
1027 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1028 * @filp: The file to apply the lock to
1029 * @fl: The lock to be applied
1030 *
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
1034 */
1035int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1036{
1037 int error;
1038 might_sleep ();
1039 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001040 error = posix_lock_file(filp, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001041 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 break;
1043 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1044 if (!error)
1045 continue;
1046
1047 locks_delete_block(fl);
1048 break;
1049 }
1050 return error;
1051}
1052EXPORT_SYMBOL(posix_lock_file_wait);
1053
1054/**
1055 * locks_mandatory_locked - Check for an active lock
1056 * @inode: the file to check
1057 *
1058 * Searches the inode's list of locks to find any POSIX locks which conflict.
1059 * This function is called from locks_verify_locked() only.
1060 */
1061int locks_mandatory_locked(struct inode *inode)
1062{
1063 fl_owner_t owner = current->files;
1064 struct file_lock *fl;
1065
1066 /*
1067 * Search the lock list for this inode for any POSIX locks.
1068 */
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001069 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1071 if (!IS_POSIX(fl))
1072 continue;
1073 if (fl->fl_owner != owner)
1074 break;
1075 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001076 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 return fl ? -EAGAIN : 0;
1078}
1079
1080/**
1081 * locks_mandatory_area - Check for a conflicting lock
1082 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1083 * for shared
1084 * @inode: the file to check
1085 * @filp: how the file was opened (if it was)
1086 * @offset: start of area to check
1087 * @count: length of area to check
1088 *
1089 * Searches the inode's list of locks to find any POSIX locks which conflict.
1090 * This function is called from rw_verify_area() and
1091 * locks_verify_truncate().
1092 */
1093int locks_mandatory_area(int read_write, struct inode *inode,
1094 struct file *filp, loff_t offset,
1095 size_t count)
1096{
1097 struct file_lock fl;
1098 int error;
1099
1100 locks_init_lock(&fl);
1101 fl.fl_owner = current->files;
1102 fl.fl_pid = current->tgid;
1103 fl.fl_file = filp;
1104 fl.fl_flags = FL_POSIX | FL_ACCESS;
1105 if (filp && !(filp->f_flags & O_NONBLOCK))
1106 fl.fl_flags |= FL_SLEEP;
1107 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1108 fl.fl_start = offset;
1109 fl.fl_end = offset + count - 1;
1110
1111 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001112 error = __posix_lock_file(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001113 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 break;
1115 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1116 if (!error) {
1117 /*
1118 * If we've been sleeping someone might have
1119 * changed the permissions behind our back.
1120 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001121 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 continue;
1123 }
1124
1125 locks_delete_block(&fl);
1126 break;
1127 }
1128
1129 return error;
1130}
1131
1132EXPORT_SYMBOL(locks_mandatory_area);
1133
1134/* We already had a lease on this file; just change its type */
1135int lease_modify(struct file_lock **before, int arg)
1136{
1137 struct file_lock *fl = *before;
1138 int error = assign_type(fl, arg);
1139
1140 if (error)
1141 return error;
1142 locks_wake_up_blocks(fl);
1143 if (arg == F_UNLCK)
1144 locks_delete_lock(before);
1145 return 0;
1146}
1147
1148EXPORT_SYMBOL(lease_modify);
1149
1150static void time_out_leases(struct inode *inode)
1151{
1152 struct file_lock **before;
1153 struct file_lock *fl;
1154
1155 before = &inode->i_flock;
1156 while ((fl = *before) && IS_LEASE(fl) && (fl->fl_type & F_INPROGRESS)) {
1157 if ((fl->fl_break_time == 0)
1158 || time_before(jiffies, fl->fl_break_time)) {
1159 before = &fl->fl_next;
1160 continue;
1161 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 lease_modify(before, fl->fl_type & ~F_INPROGRESS);
1163 if (fl == *before) /* lease_modify may have freed fl */
1164 before = &fl->fl_next;
1165 }
1166}
1167
1168/**
1169 * __break_lease - revoke all outstanding leases on file
1170 * @inode: the inode of the file to return
1171 * @mode: the open mode (read or write)
1172 *
david m. richter87250dd2007-05-09 16:10:27 -04001173 * break_lease (inlined for speed) has checked there already is at least
1174 * some kind of lock (maybe a lease) on this file. Leases are broken on
1175 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 * specified %O_NONBLOCK to your open().
1177 */
1178int __break_lease(struct inode *inode, unsigned int mode)
1179{
1180 int error = 0, future;
1181 struct file_lock *new_fl, *flock;
1182 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 unsigned long break_time;
1184 int i_have_this_lease = 0;
Al Viro8737c932009-12-24 06:47:55 -05001185 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186
Al Viro8737c932009-12-24 06:47:55 -05001187 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001189 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190
1191 time_out_leases(inode);
1192
1193 flock = inode->i_flock;
1194 if ((flock == NULL) || !IS_LEASE(flock))
1195 goto out;
1196
1197 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next)
1198 if (fl->fl_owner == current->files)
1199 i_have_this_lease = 1;
1200
Al Viro8737c932009-12-24 06:47:55 -05001201 if (want_write) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 /* If we want write access, we have to revoke any lease. */
1203 future = F_UNLCK | F_INPROGRESS;
1204 } else if (flock->fl_type & F_INPROGRESS) {
1205 /* If the lease is already being broken, we just leave it */
1206 future = flock->fl_type;
1207 } else if (flock->fl_type & F_WRLCK) {
1208 /* Downgrade the exclusive lease to a read-only lease. */
1209 future = F_RDLCK | F_INPROGRESS;
1210 } else {
1211 /* the existing lease was read-only, so we can read too. */
1212 goto out;
1213 }
1214
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -05001215 if (IS_ERR(new_fl) && !i_have_this_lease
1216 && ((mode & O_NONBLOCK) == 0)) {
1217 error = PTR_ERR(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 goto out;
1219 }
1220
1221 break_time = 0;
1222 if (lease_break_time > 0) {
1223 break_time = jiffies + lease_break_time * HZ;
1224 if (break_time == 0)
1225 break_time++; /* so that 0 means no break time */
1226 }
1227
1228 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1229 if (fl->fl_type != future) {
1230 fl->fl_type = future;
1231 fl->fl_break_time = break_time;
1232 /* lease must have lmops break callback */
1233 fl->fl_lmops->fl_break(fl);
1234 }
1235 }
1236
1237 if (i_have_this_lease || (mode & O_NONBLOCK)) {
1238 error = -EWOULDBLOCK;
1239 goto out;
1240 }
1241
1242restart:
1243 break_time = flock->fl_break_time;
1244 if (break_time != 0) {
1245 break_time -= jiffies;
1246 if (break_time == 0)
1247 break_time++;
1248 }
Matthew Wilcox4321e012008-01-14 21:28:30 -07001249 locks_insert_block(flock, new_fl);
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001250 unlock_flocks();
Matthew Wilcox4321e012008-01-14 21:28:30 -07001251 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1252 !new_fl->fl_next, break_time);
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001253 lock_flocks();
Matthew Wilcox4321e012008-01-14 21:28:30 -07001254 __locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 if (error >= 0) {
1256 if (error == 0)
1257 time_out_leases(inode);
1258 /* Wait for the next lease that has not been broken yet */
1259 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1260 flock = flock->fl_next) {
1261 if (flock->fl_type & F_INPROGRESS)
1262 goto restart;
1263 }
1264 error = 0;
1265 }
1266
1267out:
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001268 unlock_flocks();
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -05001269 if (!IS_ERR(new_fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 locks_free_lock(new_fl);
1271 return error;
1272}
1273
1274EXPORT_SYMBOL(__break_lease);
1275
1276/**
Randy Dunlapa6b91912008-03-19 17:01:00 -07001277 * lease_get_mtime - get the last modified time of an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 * @inode: the inode
1279 * @time: pointer to a timespec which will contain the last modified time
1280 *
1281 * This is to force NFS clients to flush their caches for files with
1282 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001283 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 */
1285void lease_get_mtime(struct inode *inode, struct timespec *time)
1286{
1287 struct file_lock *flock = inode->i_flock;
1288 if (flock && IS_LEASE(flock) && (flock->fl_type & F_WRLCK))
1289 *time = current_fs_time(inode->i_sb);
1290 else
1291 *time = inode->i_mtime;
1292}
1293
1294EXPORT_SYMBOL(lease_get_mtime);
1295
1296/**
1297 * fcntl_getlease - Enquire what lease is currently active
1298 * @filp: the file
1299 *
1300 * The value returned by this function will be one of
1301 * (if no lease break is pending):
1302 *
1303 * %F_RDLCK to indicate a shared lease is held.
1304 *
1305 * %F_WRLCK to indicate an exclusive lease is held.
1306 *
1307 * %F_UNLCK to indicate no lease is held.
1308 *
1309 * (if a lease break is pending):
1310 *
1311 * %F_RDLCK to indicate an exclusive lease needs to be
1312 * changed to a shared lease (or removed).
1313 *
1314 * %F_UNLCK to indicate the lease needs to be removed.
1315 *
1316 * XXX: sfr & willy disagree over whether F_INPROGRESS
1317 * should be returned to userspace.
1318 */
1319int fcntl_getlease(struct file *filp)
1320{
1321 struct file_lock *fl;
1322 int type = F_UNLCK;
1323
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001324 lock_flocks();
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001325 time_out_leases(filp->f_path.dentry->d_inode);
1326 for (fl = filp->f_path.dentry->d_inode->i_flock; fl && IS_LEASE(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 fl = fl->fl_next) {
1328 if (fl->fl_file == filp) {
1329 type = fl->fl_type & ~F_INPROGRESS;
1330 break;
1331 }
1332 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001333 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334 return type;
1335}
1336
1337/**
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001338 * generic_setlease - sets a lease on an open file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 * @filp: file pointer
1340 * @arg: type of lease to obtain
1341 * @flp: input - file_lock to use, output - file_lock inserted
1342 *
1343 * The (input) flp->fl_lmops->fl_break function is required
1344 * by break_lease().
1345 *
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001346 * Called with file_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 */
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001348int generic_setlease(struct file *filp, long arg, struct file_lock **flp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349{
KAMBAROV, ZAUR7eaae282005-07-07 17:57:06 -07001350 struct file_lock *fl, **before, **my_before = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001351 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 struct inode *inode = dentry->d_inode;
1353 int error, rdlease_count = 0, wrlease_count = 0;
1354
J. Bruce Fields096657b2010-10-30 17:31:14 -04001355 lease = *flp;
1356
1357 error = -EACCES;
David Howellsda9592e2008-11-14 10:39:05 +11001358 if ((current_fsuid() != inode->i_uid) && !capable(CAP_LEASE))
J. Bruce Fields096657b2010-10-30 17:31:14 -04001359 goto out;
1360 error = -EINVAL;
J. Bruce Fields6d5e8b02007-05-31 17:03:46 -04001361 if (!S_ISREG(inode->i_mode))
J. Bruce Fields096657b2010-10-30 17:31:14 -04001362 goto out;
J. Bruce Fields6d5e8b02007-05-31 17:03:46 -04001363 error = security_file_lock(filp, arg);
1364 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001365 goto out;
J. Bruce Fields6d5e8b02007-05-31 17:03:46 -04001366
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 time_out_leases(inode);
1368
J. Bruce Fieldsd2ab0b0c2007-06-30 12:40:32 -04001369 BUG_ON(!(*flp)->fl_lmops->fl_break);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370
David M. Richter288b2fd2008-04-23 16:29:00 -04001371 if (arg != F_UNLCK) {
1372 error = -EAGAIN;
1373 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1374 goto out;
1375 if ((arg == F_WRLCK)
Nick Pigginb7ab39f2011-01-07 17:49:32 +11001376 && ((dentry->d_count > 1)
David M. Richter288b2fd2008-04-23 16:29:00 -04001377 || (atomic_read(&inode->i_count) > 1)))
1378 goto out;
David M. Richter288b2fd2008-04-23 16:29:00 -04001379 }
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001380
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 /*
1382 * At this point, we know that if there is an exclusive
1383 * lease on this file, then we hold it on this filp
1384 * (otherwise our open of this file would have blocked).
1385 * And if we are trying to acquire an exclusive lease,
1386 * then the file is not open by anyone (including us)
1387 * except for this filp.
1388 */
1389 for (before = &inode->i_flock;
1390 ((fl = *before) != NULL) && IS_LEASE(fl);
1391 before = &fl->fl_next) {
J. Bruce Fields255c7cf2010-10-31 12:35:48 -04001392 if (fl->fl_file == filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 my_before = before;
1394 else if (fl->fl_type == (F_INPROGRESS | F_UNLCK))
1395 /*
1396 * Someone is in the process of opening this
1397 * file for writing so we may not take an
1398 * exclusive lease on it.
1399 */
1400 wrlease_count++;
1401 else
1402 rdlease_count++;
1403 }
1404
David M. Richter5fcc60c2008-04-23 16:28:59 -04001405 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406 if ((arg == F_RDLCK && (wrlease_count > 0)) ||
1407 (arg == F_WRLCK && ((rdlease_count + wrlease_count) > 0)))
1408 goto out;
1409
1410 if (my_before != NULL) {
1411 error = lease->fl_lmops->fl_change(my_before, arg);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001412 if (!error)
1413 *flp = *my_before;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 goto out;
1415 }
1416
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 if (arg == F_UNLCK)
1418 goto out;
1419
1420 error = -EINVAL;
1421 if (!leases_enable)
1422 goto out;
1423
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001424 locks_insert_lock(before, lease);
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001425 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427out:
1428 return error;
1429}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001430EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001432static int __vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
1433{
1434 if (filp->f_op && filp->f_op->setlease)
1435 return filp->f_op->setlease(filp, arg, lease);
1436 else
1437 return generic_setlease(filp, arg, lease);
1438}
1439
1440/**
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001441 * vfs_setlease - sets a lease on an open file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 * @filp: file pointer
1443 * @arg: type of lease to obtain
1444 * @lease: file_lock to use
1445 *
1446 * Call this to establish a lease on the file.
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001447 * The (*lease)->fl_lmops->fl_break operation must be set; if not,
1448 * break_lease will oops!
1449 *
1450 * This will call the filesystem's setlease file method, if
1451 * defined. Note that there is no getlease method; instead, the
1452 * filesystem setlease method should call back to setlease() to
1453 * add a lease to the inode's lease list, where fcntl_getlease() can
1454 * find it. Since fcntl_getlease() only reports whether the current
1455 * task holds a lease, a cluster filesystem need only do this for
1456 * leases held by processes on this node.
1457 *
1458 * There is also no break_lease method; filesystems that
Adam Buchbinderc9404c92009-12-18 15:40:42 -05001459 * handle their own leases should break leases themselves from the
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001460 * filesystem's open, create, and (on truncate) setattr methods.
1461 *
1462 * Warning: the only current setlease methods exist only to disable
1463 * leases in certain cases. More vfs changes may be required to
1464 * allow a full filesystem lease implementation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 */
1466
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001467int vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 int error;
1470
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001471 lock_flocks();
1472 error = __vfs_setlease(filp, arg, lease);
1473 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474
1475 return error;
1476}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001477EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001479static int do_fcntl_delete_lease(struct file *filp)
1480{
1481 struct file_lock fl, *flp = &fl;
1482
1483 lease_init(filp, F_UNLCK, flp);
1484
1485 return vfs_setlease(filp, F_UNLCK, &flp);
1486}
1487
1488static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489{
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001490 struct file_lock *fl, *ret;
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001491 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 int error;
1493
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001494 fl = lease_alloc(filp, arg);
1495 if (IS_ERR(fl))
1496 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001498 new = fasync_alloc();
1499 if (!new) {
1500 locks_free_lock(fl);
1501 return -ENOMEM;
1502 }
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001503 ret = fl;
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001504 lock_flocks();
J. Bruce Fields8896b932010-11-03 18:09:18 -04001505 error = __vfs_setlease(filp, arg, &ret);
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001506 if (error) {
1507 unlock_flocks();
1508 locks_free_lock(fl);
1509 goto out_free_fasync;
1510 }
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001511 if (ret != fl)
1512 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001514 /*
1515 * fasync_insert_entry() returns the old entry if any.
1516 * If there was no old entry, then it used 'new' and
1517 * inserted it into the fasync list. Clear new so that
1518 * we don't release it here.
1519 */
J. Bruce Fields3df057a2010-11-03 16:49:44 -04001520 if (!fasync_insert_entry(fd, filp, &ret->fl_fasync, new))
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001521 new = NULL;
1522
J. Bruce Fields8896b932010-11-03 18:09:18 -04001523 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001524 unlock_flocks();
Christoph Hellwig51ee4b82010-10-31 08:35:10 -04001525
1526out_free_fasync:
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001527 if (new)
1528 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 return error;
1530}
1531
1532/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04001533 * fcntl_setlease - sets a lease on an open file
1534 * @fd: open file descriptor
1535 * @filp: file pointer
1536 * @arg: type of lease to obtain
1537 *
1538 * Call this fcntl to establish a lease on the file.
1539 * Note that you also need to call %F_SETSIG to
1540 * receive a signal when the lease is broken.
1541 */
1542int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1543{
1544 if (arg == F_UNLCK)
1545 return do_fcntl_delete_lease(filp);
1546 return do_fcntl_add_lease(fd, filp, arg);
1547}
1548
1549/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1551 * @filp: The file to apply the lock to
1552 * @fl: The lock to be applied
1553 *
1554 * Add a FLOCK style lock to a file.
1555 */
1556int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1557{
1558 int error;
1559 might_sleep();
1560 for (;;) {
1561 error = flock_lock_file(filp, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001562 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 break;
1564 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1565 if (!error)
1566 continue;
1567
1568 locks_delete_block(fl);
1569 break;
1570 }
1571 return error;
1572}
1573
1574EXPORT_SYMBOL(flock_lock_file_wait);
1575
1576/**
1577 * sys_flock: - flock() system call.
1578 * @fd: the file descriptor to lock.
1579 * @cmd: the type of lock to apply.
1580 *
1581 * Apply a %FL_FLOCK style lock to an open file descriptor.
1582 * The @cmd can be one of
1583 *
1584 * %LOCK_SH -- a shared lock.
1585 *
1586 * %LOCK_EX -- an exclusive lock.
1587 *
1588 * %LOCK_UN -- remove an existing lock.
1589 *
1590 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1591 *
1592 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1593 * processes read and write access respectively.
1594 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001595SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596{
1597 struct file *filp;
1598 struct file_lock *lock;
1599 int can_sleep, unlock;
1600 int error;
1601
1602 error = -EBADF;
1603 filp = fget(fd);
1604 if (!filp)
1605 goto out;
1606
1607 can_sleep = !(cmd & LOCK_NB);
1608 cmd &= ~LOCK_NB;
1609 unlock = (cmd == LOCK_UN);
1610
Al Viroaeb5d722008-09-02 15:28:45 -04001611 if (!unlock && !(cmd & LOCK_MAND) &&
1612 !(filp->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 goto out_putf;
1614
1615 error = flock_make_lock(filp, &lock, cmd);
1616 if (error)
1617 goto out_putf;
1618 if (can_sleep)
1619 lock->fl_flags |= FL_SLEEP;
1620
Sten Spans713c0ec2009-07-16 09:41:39 +02001621 error = security_file_lock(filp, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 if (error)
1623 goto out_free;
1624
1625 if (filp->f_op && filp->f_op->flock)
1626 error = filp->f_op->flock(filp,
1627 (can_sleep) ? F_SETLKW : F_SETLK,
1628 lock);
1629 else
1630 error = flock_lock_file_wait(filp, lock);
1631
1632 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08001633 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634
1635 out_putf:
1636 fput(filp);
1637 out:
1638 return error;
1639}
1640
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001641/**
1642 * vfs_test_lock - test file byte range lock
1643 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04001644 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001645 *
1646 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1647 * setting conf->fl_type to something other than F_UNLCK.
1648 */
1649int vfs_test_lock(struct file *filp, struct file_lock *fl)
1650{
1651 if (filp->f_op && filp->f_op->lock)
1652 return filp->f_op->lock(filp, F_GETLK, fl);
1653 posix_test_lock(filp, fl);
1654 return 0;
1655}
1656EXPORT_SYMBOL_GPL(vfs_test_lock);
1657
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001658static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1659{
1660 flock->l_pid = fl->fl_pid;
1661#if BITS_PER_LONG == 32
1662 /*
1663 * Make sure we can represent the posix lock via
1664 * legacy 32bit flock.
1665 */
1666 if (fl->fl_start > OFFT_OFFSET_MAX)
1667 return -EOVERFLOW;
1668 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1669 return -EOVERFLOW;
1670#endif
1671 flock->l_start = fl->fl_start;
1672 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1673 fl->fl_end - fl->fl_start + 1;
1674 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04001675 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001676 return 0;
1677}
1678
1679#if BITS_PER_LONG == 32
1680static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1681{
1682 flock->l_pid = fl->fl_pid;
1683 flock->l_start = fl->fl_start;
1684 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1685 fl->fl_end - fl->fl_start + 1;
1686 flock->l_whence = 0;
1687 flock->l_type = fl->fl_type;
1688}
1689#endif
1690
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691/* Report the first existing lock that would conflict with l.
1692 * This implements the F_GETLK command of fcntl().
1693 */
1694int fcntl_getlk(struct file *filp, struct flock __user *l)
1695{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001696 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 struct flock flock;
1698 int error;
1699
1700 error = -EFAULT;
1701 if (copy_from_user(&flock, l, sizeof(flock)))
1702 goto out;
1703 error = -EINVAL;
1704 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1705 goto out;
1706
1707 error = flock_to_posix_lock(filp, &file_lock, &flock);
1708 if (error)
1709 goto out;
1710
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001711 error = vfs_test_lock(filp, &file_lock);
1712 if (error)
1713 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001715 flock.l_type = file_lock.fl_type;
1716 if (file_lock.fl_type != F_UNLCK) {
1717 error = posix_lock_to_flock(&flock, &file_lock);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001718 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720 }
1721 error = -EFAULT;
1722 if (!copy_to_user(l, &flock, sizeof(flock)))
1723 error = 0;
1724out:
1725 return error;
1726}
1727
Marc Eshel7723ec92007-01-18 15:08:55 -05001728/**
1729 * vfs_lock_file - file byte range lock
1730 * @filp: The file to apply the lock to
1731 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1732 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001733 * @conf: Place to return a copy of the conflicting lock, if found.
1734 *
1735 * A caller that doesn't care about the conflicting lock may pass NULL
1736 * as the final argument.
1737 *
1738 * If the filesystem defines a private ->lock() method, then @conf will
1739 * be left unchanged; so a caller that cares should initialize it to
1740 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05001741 *
1742 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1743 * locks, the ->lock() interface may return asynchronously, before the lock has
1744 * been granted or denied by the underlying filesystem, if (and only if)
1745 * fl_grant is set. Callers expecting ->lock() to return asynchronously
1746 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1747 * the request is for a blocking lock. When ->lock() does return asynchronously,
Miklos Szeredibde74e42008-07-25 01:48:57 -07001748 * it must return FILE_LOCK_DEFERRED, and call ->fl_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05001749 * request completes.
1750 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07001751 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
1752 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05001753 * nonzero return code and the file system should release the lock. The file
1754 * system is also responsible to keep a corresponding posix lock when it
1755 * grants a lock so the VFS can find out which locks are locally held and do
1756 * the correct lock cleanup when required.
1757 * The underlying filesystem must not drop the kernel lock or call
Miklos Szeredibde74e42008-07-25 01:48:57 -07001758 * ->fl_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05001759 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05001760 */
Marc Eshel150b3932007-01-18 16:15:35 -05001761int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05001762{
1763 if (filp->f_op && filp->f_op->lock)
1764 return filp->f_op->lock(filp, cmd, fl);
1765 else
Marc Eshel150b3932007-01-18 16:15:35 -05001766 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05001767}
1768EXPORT_SYMBOL_GPL(vfs_lock_file);
1769
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001770static int do_lock_file_wait(struct file *filp, unsigned int cmd,
1771 struct file_lock *fl)
1772{
1773 int error;
1774
1775 error = security_file_lock(filp, fl->fl_type);
1776 if (error)
1777 return error;
1778
Miklos Szeredi764c76b2008-07-25 01:48:58 -07001779 for (;;) {
1780 error = vfs_lock_file(filp, cmd, fl, NULL);
1781 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001782 break;
Miklos Szeredi764c76b2008-07-25 01:48:58 -07001783 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1784 if (!error)
1785 continue;
1786
1787 locks_delete_block(fl);
1788 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001789 }
1790
1791 return error;
1792}
1793
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794/* Apply the lock described by l to an open file descriptor.
1795 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1796 */
Peter Staubachc2936212005-07-27 11:45:09 -07001797int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
1798 struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799{
1800 struct file_lock *file_lock = locks_alloc_lock();
1801 struct flock flock;
1802 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04001803 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 int error;
1805
1806 if (file_lock == NULL)
1807 return -ENOLCK;
1808
1809 /*
1810 * This might block, so we do it before checking the inode.
1811 */
1812 error = -EFAULT;
1813 if (copy_from_user(&flock, l, sizeof(flock)))
1814 goto out;
1815
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001816 inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817
1818 /* Don't allow mandatory locks on files that may be memory mapped
1819 * and shared.
1820 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001821 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 error = -EAGAIN;
1823 goto out;
1824 }
1825
Peter Staubachc2936212005-07-27 11:45:09 -07001826again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827 error = flock_to_posix_lock(filp, file_lock, &flock);
1828 if (error)
1829 goto out;
1830 if (cmd == F_SETLKW) {
1831 file_lock->fl_flags |= FL_SLEEP;
1832 }
1833
1834 error = -EBADF;
1835 switch (flock.l_type) {
1836 case F_RDLCK:
1837 if (!(filp->f_mode & FMODE_READ))
1838 goto out;
1839 break;
1840 case F_WRLCK:
1841 if (!(filp->f_mode & FMODE_WRITE))
1842 goto out;
1843 break;
1844 case F_UNLCK:
1845 break;
1846 default:
1847 error = -EINVAL;
1848 goto out;
1849 }
1850
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001851 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852
Peter Staubachc2936212005-07-27 11:45:09 -07001853 /*
1854 * Attempt to detect a close/fcntl race and recover by
1855 * releasing the lock that was just acquired.
1856 */
Al Viro0b2bac22008-05-06 13:58:34 -04001857 /*
1858 * we need that spin_lock here - it prevents reordering between
1859 * update of inode->i_flock and check for it done in close().
1860 * rcu_read_lock() wouldn't do.
1861 */
1862 spin_lock(&current->files->file_lock);
1863 f = fcheck(fd);
1864 spin_unlock(&current->files->file_lock);
1865 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07001866 flock.l_type = F_UNLCK;
1867 goto again;
1868 }
1869
1870out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871 locks_free_lock(file_lock);
1872 return error;
1873}
1874
1875#if BITS_PER_LONG == 32
1876/* Report the first existing lock that would conflict with l.
1877 * This implements the F_GETLK command of fcntl().
1878 */
1879int fcntl_getlk64(struct file *filp, struct flock64 __user *l)
1880{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001881 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882 struct flock64 flock;
1883 int error;
1884
1885 error = -EFAULT;
1886 if (copy_from_user(&flock, l, sizeof(flock)))
1887 goto out;
1888 error = -EINVAL;
1889 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1890 goto out;
1891
1892 error = flock64_to_posix_lock(filp, &file_lock, &flock);
1893 if (error)
1894 goto out;
1895
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001896 error = vfs_test_lock(filp, &file_lock);
1897 if (error)
1898 goto out;
1899
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001900 flock.l_type = file_lock.fl_type;
1901 if (file_lock.fl_type != F_UNLCK)
1902 posix_lock_to_flock64(&flock, &file_lock);
1903
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 error = -EFAULT;
1905 if (!copy_to_user(l, &flock, sizeof(flock)))
1906 error = 0;
1907
1908out:
1909 return error;
1910}
1911
1912/* Apply the lock described by l to an open file descriptor.
1913 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1914 */
Peter Staubachc2936212005-07-27 11:45:09 -07001915int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
1916 struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917{
1918 struct file_lock *file_lock = locks_alloc_lock();
1919 struct flock64 flock;
1920 struct inode *inode;
Al Viro0b2bac22008-05-06 13:58:34 -04001921 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922 int error;
1923
1924 if (file_lock == NULL)
1925 return -ENOLCK;
1926
1927 /*
1928 * This might block, so we do it before checking the inode.
1929 */
1930 error = -EFAULT;
1931 if (copy_from_user(&flock, l, sizeof(flock)))
1932 goto out;
1933
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001934 inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935
1936 /* Don't allow mandatory locks on files that may be memory mapped
1937 * and shared.
1938 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001939 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 error = -EAGAIN;
1941 goto out;
1942 }
1943
Peter Staubachc2936212005-07-27 11:45:09 -07001944again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945 error = flock64_to_posix_lock(filp, file_lock, &flock);
1946 if (error)
1947 goto out;
1948 if (cmd == F_SETLKW64) {
1949 file_lock->fl_flags |= FL_SLEEP;
1950 }
1951
1952 error = -EBADF;
1953 switch (flock.l_type) {
1954 case F_RDLCK:
1955 if (!(filp->f_mode & FMODE_READ))
1956 goto out;
1957 break;
1958 case F_WRLCK:
1959 if (!(filp->f_mode & FMODE_WRITE))
1960 goto out;
1961 break;
1962 case F_UNLCK:
1963 break;
1964 default:
1965 error = -EINVAL;
1966 goto out;
1967 }
1968
Miklos Szeredib648a6d2008-07-25 01:48:57 -07001969 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970
Peter Staubachc2936212005-07-27 11:45:09 -07001971 /*
1972 * Attempt to detect a close/fcntl race and recover by
1973 * releasing the lock that was just acquired.
1974 */
Al Viro0b2bac22008-05-06 13:58:34 -04001975 spin_lock(&current->files->file_lock);
1976 f = fcheck(fd);
1977 spin_unlock(&current->files->file_lock);
1978 if (!error && f != filp && flock.l_type != F_UNLCK) {
Peter Staubachc2936212005-07-27 11:45:09 -07001979 flock.l_type = F_UNLCK;
1980 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981 }
1982
1983out:
1984 locks_free_lock(file_lock);
1985 return error;
1986}
1987#endif /* BITS_PER_LONG == 32 */
1988
1989/*
1990 * This function is called when the file is being removed
1991 * from the task's fd array. POSIX locks belonging to this task
1992 * are deleted at this time.
1993 */
1994void locks_remove_posix(struct file *filp, fl_owner_t owner)
1995{
Miklos Szerediff7b86b2006-06-23 02:05:11 -07001996 struct file_lock lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997
1998 /*
1999 * If there are no locks held on this file, we don't need to call
2000 * posix_lock_file(). Another process could be setting a lock on this
2001 * file at the same time, but we wouldn't remove that lock anyway.
2002 */
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08002003 if (!filp->f_path.dentry->d_inode->i_flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004 return;
2005
2006 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002007 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 lock.fl_start = 0;
2009 lock.fl_end = OFFSET_MAX;
2010 lock.fl_owner = owner;
2011 lock.fl_pid = current->tgid;
2012 lock.fl_file = filp;
2013 lock.fl_ops = NULL;
2014 lock.fl_lmops = NULL;
2015
Marc Eshel150b3932007-01-18 16:15:35 -05002016 vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2019 lock.fl_ops->fl_release_private(&lock);
2020}
2021
2022EXPORT_SYMBOL(locks_remove_posix);
2023
2024/*
2025 * This function is called on the last close of an open file.
2026 */
2027void locks_remove_flock(struct file *filp)
2028{
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08002029 struct inode * inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 struct file_lock *fl;
2031 struct file_lock **before;
2032
2033 if (!inode->i_flock)
2034 return;
2035
2036 if (filp->f_op && filp->f_op->flock) {
2037 struct file_lock fl = {
2038 .fl_pid = current->tgid,
2039 .fl_file = filp,
2040 .fl_flags = FL_FLOCK,
2041 .fl_type = F_UNLCK,
2042 .fl_end = OFFSET_MAX,
2043 };
2044 filp->f_op->flock(filp, F_SETLKW, &fl);
Trond Myklebust80fec4c2005-06-22 17:16:31 +00002045 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2046 fl.fl_ops->fl_release_private(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047 }
2048
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002049 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050 before = &inode->i_flock;
2051
2052 while ((fl = *before) != NULL) {
2053 if (fl->fl_file == filp) {
Peter Staubachc2936212005-07-27 11:45:09 -07002054 if (IS_FLOCK(fl)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055 locks_delete_lock(before);
2056 continue;
2057 }
2058 if (IS_LEASE(fl)) {
2059 lease_modify(before, F_UNLCK);
2060 continue;
2061 }
2062 /* What? */
2063 BUG();
2064 }
2065 before = &fl->fl_next;
2066 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002067 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068}
2069
2070/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 * posix_unblock_lock - stop waiting for a file lock
2072 * @filp: how the file was opened
2073 * @waiter: the lock which was waiting
2074 *
2075 * lockd needs to block waiting for locks.
2076 */
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002077int
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078posix_unblock_lock(struct file *filp, struct file_lock *waiter)
2079{
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002080 int status = 0;
2081
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002082 lock_flocks();
J. Bruce Fields5996a292006-01-03 09:55:44 +01002083 if (waiter->fl_next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 __locks_delete_block(waiter);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002085 else
2086 status = -ENOENT;
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002087 unlock_flocks();
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002088 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089}
2090
2091EXPORT_SYMBOL(posix_unblock_lock);
2092
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002093/**
2094 * vfs_cancel_lock - file byte range unblock lock
2095 * @filp: The file to apply the unblock to
2096 * @fl: The lock to be unblocked
2097 *
2098 * Used by lock managers to cancel blocked requests
2099 */
2100int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2101{
2102 if (filp->f_op && filp->f_op->lock)
2103 return filp->f_op->lock(filp, F_CANCELLK, fl);
2104 return 0;
2105}
2106
2107EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2108
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002109#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002110#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002111#include <linux/seq_file.h>
2112
2113static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002114 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115{
2116 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002117 unsigned int fl_pid;
2118
2119 if (fl->fl_nspid)
Pavel Emelyanov6c5f3e72008-02-08 04:19:20 -08002120 fl_pid = pid_vnr(fl->fl_nspid);
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002121 else
2122 fl_pid = fl->fl_pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123
2124 if (fl->fl_file != NULL)
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08002125 inode = fl->fl_file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126
Jerome Marchand99dc8292010-10-26 14:22:33 -07002127 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128 if (IS_POSIX(fl)) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002129 seq_printf(f, "%6s %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 (fl->fl_flags & FL_ACCESS) ? "ACCESS" : "POSIX ",
2131 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002132 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 } else if (IS_FLOCK(fl)) {
2134 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002135 seq_printf(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002137 seq_printf(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138 }
2139 } else if (IS_LEASE(fl)) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002140 seq_printf(f, "LEASE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 if (fl->fl_type & F_INPROGRESS)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002142 seq_printf(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 else if (fl->fl_file)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002144 seq_printf(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002146 seq_printf(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002148 seq_printf(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 }
2150 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002151 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 (fl->fl_type & LOCK_READ)
2153 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2154 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2155 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002156 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 (fl->fl_type & F_INPROGRESS)
2158 ? (fl->fl_type & F_UNLCK) ? "UNLCK" : "READ "
2159 : (fl->fl_type & F_WRLCK) ? "WRITE" : "READ ");
2160 }
2161 if (inode) {
2162#ifdef WE_CAN_BREAK_LSLK_NOW
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002163 seq_printf(f, "%d %s:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 inode->i_sb->s_id, inode->i_ino);
2165#else
2166 /* userspace relies on this representation of dev_t ;-( */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002167 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 MAJOR(inode->i_sb->s_dev),
2169 MINOR(inode->i_sb->s_dev), inode->i_ino);
2170#endif
2171 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002172 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 }
2174 if (IS_POSIX(fl)) {
2175 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002176 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002178 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002180 seq_printf(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 }
2182}
2183
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002184static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185{
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002186 struct file_lock *fl, *bfl;
2187
2188 fl = list_entry(v, struct file_lock, fl_link);
2189
Jerome Marchand99dc8292010-10-26 14:22:33 -07002190 lock_get_status(f, fl, *((loff_t *)f->private), "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002191
2192 list_for_each_entry(bfl, &fl->fl_block, fl_block)
Jerome Marchand99dc8292010-10-26 14:22:33 -07002193 lock_get_status(f, bfl, *((loff_t *)f->private), " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002194
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002195 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196}
2197
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002198static void *locks_start(struct seq_file *f, loff_t *pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199{
Jerome Marchand99dc8292010-10-26 14:22:33 -07002200 loff_t *p = f->private;
2201
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002202 lock_flocks();
Jerome Marchand99dc8292010-10-26 14:22:33 -07002203 *p = (*pos + 1);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002204 return seq_list_start(&file_lock_list, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205}
2206
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002207static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2208{
Jerome Marchand99dc8292010-10-26 14:22:33 -07002209 loff_t *p = f->private;
2210 ++*p;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002211 return seq_list_next(v, &file_lock_list, pos);
2212}
2213
2214static void locks_stop(struct seq_file *f, void *v)
2215{
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002216 unlock_flocks();
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002217}
2218
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002219static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002220 .start = locks_start,
2221 .next = locks_next,
2222 .stop = locks_stop,
2223 .show = locks_show,
2224};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002225
2226static int locks_open(struct inode *inode, struct file *filp)
2227{
Jerome Marchand99dc8292010-10-26 14:22:33 -07002228 return seq_open_private(filp, &locks_seq_operations, sizeof(loff_t));
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002229}
2230
2231static const struct file_operations proc_locks_operations = {
2232 .open = locks_open,
2233 .read = seq_read,
2234 .llseek = seq_lseek,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002235 .release = seq_release_private,
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002236};
2237
2238static int __init proc_locks_init(void)
2239{
2240 proc_create("locks", 0, NULL, &proc_locks_operations);
2241 return 0;
2242}
2243module_init(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002244#endif
2245
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246/**
2247 * lock_may_read - checks that the region is free of locks
2248 * @inode: the inode that is being read
2249 * @start: the first byte to read
2250 * @len: the number of bytes to read
2251 *
2252 * Emulates Windows locking requirements. Whole-file
2253 * mandatory locks (share modes) can prohibit a read and
2254 * byte-range POSIX locks can prohibit a read if they overlap.
2255 *
2256 * N.B. this function is only ever called
2257 * from knfsd and ownership of locks is never checked.
2258 */
2259int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2260{
2261 struct file_lock *fl;
2262 int result = 1;
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002263 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2265 if (IS_POSIX(fl)) {
2266 if (fl->fl_type == F_RDLCK)
2267 continue;
2268 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2269 continue;
2270 } else if (IS_FLOCK(fl)) {
2271 if (!(fl->fl_type & LOCK_MAND))
2272 continue;
2273 if (fl->fl_type & LOCK_READ)
2274 continue;
2275 } else
2276 continue;
2277 result = 0;
2278 break;
2279 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002280 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281 return result;
2282}
2283
2284EXPORT_SYMBOL(lock_may_read);
2285
2286/**
2287 * lock_may_write - checks that the region is free of locks
2288 * @inode: the inode that is being written
2289 * @start: the first byte to write
2290 * @len: the number of bytes to write
2291 *
2292 * Emulates Windows locking requirements. Whole-file
2293 * mandatory locks (share modes) can prohibit a write and
2294 * byte-range POSIX locks can prohibit a write if they overlap.
2295 *
2296 * N.B. this function is only ever called
2297 * from knfsd and ownership of locks is never checked.
2298 */
2299int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2300{
2301 struct file_lock *fl;
2302 int result = 1;
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002303 lock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2305 if (IS_POSIX(fl)) {
2306 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2307 continue;
2308 } else if (IS_FLOCK(fl)) {
2309 if (!(fl->fl_type & LOCK_MAND))
2310 continue;
2311 if (fl->fl_type & LOCK_WRITE)
2312 continue;
2313 } else
2314 continue;
2315 result = 0;
2316 break;
2317 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +02002318 unlock_flocks();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319 return result;
2320}
2321
2322EXPORT_SYMBOL(lock_may_write);
2323
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324static int __init filelock_init(void)
2325{
2326 filelock_cache = kmem_cache_create("file_lock_cache",
2327 sizeof(struct file_lock), 0, SLAB_PANIC,
Paul Mundt20c2df82007-07-20 10:11:58 +09002328 init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 return 0;
2330}
2331
2332core_initcall(filelock_init);