blob: a65d85c1fdc26be98030644346d2a566d2cb2ec8 [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>
119#include <linux/fs.h>
120#include <linux/init.h>
121#include <linux/module.h>
122#include <linux/security.h>
123#include <linux/slab.h>
124#include <linux/smp_lock.h>
125#include <linux/syscalls.h>
126#include <linux/time.h>
Dipankar Sarma4fb3a532005-09-16 19:28:13 -0700127#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129#include <asm/semaphore.h>
130#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);
144
Christoph Lametere18b8902006-12-06 20:33:20 -0800145static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
147/* Allocate an empty lock structure. */
148static struct file_lock *locks_alloc_lock(void)
149{
Christoph Lametere94b1762006-12-06 20:33:17 -0800150 return kmem_cache_alloc(filelock_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151}
152
Trond Myklebust47831f32006-03-20 13:44:05 -0500153static void locks_release_private(struct file_lock *fl)
154{
155 if (fl->fl_ops) {
156 if (fl->fl_ops->fl_release_private)
157 fl->fl_ops->fl_release_private(fl);
158 fl->fl_ops = NULL;
159 }
160 if (fl->fl_lmops) {
161 if (fl->fl_lmops->fl_release_private)
162 fl->fl_lmops->fl_release_private(fl);
163 fl->fl_lmops = NULL;
164 }
165
166}
167
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168/* Free a lock which is not in use. */
Matt Mackall33443c42006-01-08 01:05:22 -0800169static void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170{
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800171 BUG_ON(waitqueue_active(&fl->fl_wait));
172 BUG_ON(!list_empty(&fl->fl_block));
173 BUG_ON(!list_empty(&fl->fl_link));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Trond Myklebust47831f32006-03-20 13:44:05 -0500175 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 kmem_cache_free(filelock_cache, fl);
177}
178
179void locks_init_lock(struct file_lock *fl)
180{
181 INIT_LIST_HEAD(&fl->fl_link);
182 INIT_LIST_HEAD(&fl->fl_block);
183 init_waitqueue_head(&fl->fl_wait);
184 fl->fl_next = NULL;
185 fl->fl_fasync = NULL;
186 fl->fl_owner = NULL;
187 fl->fl_pid = 0;
188 fl->fl_file = NULL;
189 fl->fl_flags = 0;
190 fl->fl_type = 0;
191 fl->fl_start = fl->fl_end = 0;
192 fl->fl_ops = NULL;
193 fl->fl_lmops = NULL;
194}
195
196EXPORT_SYMBOL(locks_init_lock);
197
198/*
199 * Initialises the fields of the file lock which are invariant for
200 * free file_locks.
201 */
Christoph Lametere18b8902006-12-06 20:33:20 -0800202static void init_once(void *foo, struct kmem_cache *cache, unsigned long flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203{
204 struct file_lock *lock = (struct file_lock *) foo;
205
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 locks_init_lock(lock);
207}
208
Trond Myklebust47831f32006-03-20 13:44:05 -0500209static void locks_copy_private(struct file_lock *new, struct file_lock *fl)
210{
211 if (fl->fl_ops) {
212 if (fl->fl_ops->fl_copy_lock)
213 fl->fl_ops->fl_copy_lock(new, fl);
214 new->fl_ops = fl->fl_ops;
215 }
216 if (fl->fl_lmops) {
217 if (fl->fl_lmops->fl_copy_lock)
218 fl->fl_lmops->fl_copy_lock(new, fl);
219 new->fl_lmops = fl->fl_lmops;
220 }
221}
222
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223/*
224 * Initialize a new lock from an existing file_lock structure.
225 */
Trond Myklebust09969052006-03-20 13:44:38 -0500226static void __locks_copy_lock(struct file_lock *new, const struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227{
228 new->fl_owner = fl->fl_owner;
229 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500230 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 new->fl_flags = fl->fl_flags;
232 new->fl_type = fl->fl_type;
233 new->fl_start = fl->fl_start;
234 new->fl_end = fl->fl_end;
Trond Myklebust09969052006-03-20 13:44:38 -0500235 new->fl_ops = NULL;
236 new->fl_lmops = NULL;
237}
238
239void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
240{
241 locks_release_private(new);
242
243 __locks_copy_lock(new, fl);
244 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 new->fl_ops = fl->fl_ops;
246 new->fl_lmops = fl->fl_lmops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500247
248 locks_copy_private(new, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249}
250
251EXPORT_SYMBOL(locks_copy_lock);
252
253static inline int flock_translate_cmd(int cmd) {
254 if (cmd & LOCK_MAND)
255 return cmd & (LOCK_MAND | LOCK_RW);
256 switch (cmd) {
257 case LOCK_SH:
258 return F_RDLCK;
259 case LOCK_EX:
260 return F_WRLCK;
261 case LOCK_UN:
262 return F_UNLCK;
263 }
264 return -EINVAL;
265}
266
267/* Fill in a file_lock structure with an appropriate FLOCK lock. */
268static int flock_make_lock(struct file *filp, struct file_lock **lock,
269 unsigned int cmd)
270{
271 struct file_lock *fl;
272 int type = flock_translate_cmd(cmd);
273 if (type < 0)
274 return type;
275
276 fl = locks_alloc_lock();
277 if (fl == NULL)
278 return -ENOMEM;
279
280 fl->fl_file = filp;
281 fl->fl_pid = current->tgid;
282 fl->fl_flags = FL_FLOCK;
283 fl->fl_type = type;
284 fl->fl_end = OFFSET_MAX;
285
286 *lock = fl;
287 return 0;
288}
289
290static int assign_type(struct file_lock *fl, int type)
291{
292 switch (type) {
293 case F_RDLCK:
294 case F_WRLCK:
295 case F_UNLCK:
296 fl->fl_type = type;
297 break;
298 default:
299 return -EINVAL;
300 }
301 return 0;
302}
303
304/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
305 * style lock.
306 */
307static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
308 struct flock *l)
309{
310 off_t start, end;
311
312 switch (l->l_whence) {
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700313 case SEEK_SET:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 start = 0;
315 break;
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700316 case SEEK_CUR:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 start = filp->f_pos;
318 break;
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700319 case SEEK_END:
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800320 start = i_size_read(filp->f_path.dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 break;
322 default:
323 return -EINVAL;
324 }
325
326 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
327 POSIX-2001 defines it. */
328 start += l->l_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 if (start < 0)
330 return -EINVAL;
Trond Myklebust4c780a42005-10-18 14:20:21 -0700331 fl->fl_end = OFFSET_MAX;
332 if (l->l_len > 0) {
333 end = start + l->l_len - 1;
334 fl->fl_end = end;
335 } else if (l->l_len < 0) {
336 end = start - 1;
337 fl->fl_end = end;
338 start += l->l_len;
339 if (start < 0)
340 return -EINVAL;
341 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 fl->fl_start = start; /* we record the absolute position */
Trond Myklebust4c780a42005-10-18 14:20:21 -0700343 if (fl->fl_end < fl->fl_start)
344 return -EOVERFLOW;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
346 fl->fl_owner = current->files;
347 fl->fl_pid = current->tgid;
348 fl->fl_file = filp;
349 fl->fl_flags = FL_POSIX;
350 fl->fl_ops = NULL;
351 fl->fl_lmops = NULL;
352
353 return assign_type(fl, l->l_type);
354}
355
356#if BITS_PER_LONG == 32
357static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
358 struct flock64 *l)
359{
360 loff_t start;
361
362 switch (l->l_whence) {
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700363 case SEEK_SET:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 start = 0;
365 break;
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700366 case SEEK_CUR:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 start = filp->f_pos;
368 break;
Josef 'Jeff' Sipekf5579f82006-09-30 23:27:35 -0700369 case SEEK_END:
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800370 start = i_size_read(filp->f_path.dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 break;
372 default:
373 return -EINVAL;
374 }
375
Trond Myklebust4c780a42005-10-18 14:20:21 -0700376 start += l->l_start;
377 if (start < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 return -EINVAL;
Trond Myklebust4c780a42005-10-18 14:20:21 -0700379 fl->fl_end = OFFSET_MAX;
380 if (l->l_len > 0) {
381 fl->fl_end = start + l->l_len - 1;
382 } else if (l->l_len < 0) {
383 fl->fl_end = start - 1;
384 start += l->l_len;
385 if (start < 0)
386 return -EINVAL;
387 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 fl->fl_start = start; /* we record the absolute position */
Trond Myklebust4c780a42005-10-18 14:20:21 -0700389 if (fl->fl_end < fl->fl_start)
390 return -EOVERFLOW;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
392 fl->fl_owner = current->files;
393 fl->fl_pid = current->tgid;
394 fl->fl_file = filp;
395 fl->fl_flags = FL_POSIX;
396 fl->fl_ops = NULL;
397 fl->fl_lmops = NULL;
398
399 switch (l->l_type) {
400 case F_RDLCK:
401 case F_WRLCK:
402 case F_UNLCK:
403 fl->fl_type = l->l_type;
404 break;
405 default:
406 return -EINVAL;
407 }
408
409 return (0);
410}
411#endif
412
413/* default lease lock manager operations */
414static void lease_break_callback(struct file_lock *fl)
415{
416 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
417}
418
419static void lease_release_private_callback(struct file_lock *fl)
420{
421 if (!fl->fl_file)
422 return;
423
424 f_delown(fl->fl_file);
425 fl->fl_file->f_owner.signum = 0;
426}
427
Adrian Bunk75c96f82005-05-05 16:16:09 -0700428static int lease_mylease_callback(struct file_lock *fl, struct file_lock *try)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429{
430 return fl->fl_file == try->fl_file;
431}
432
Adrian Bunk75c96f82005-05-05 16:16:09 -0700433static struct lock_manager_operations lease_manager_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 .fl_break = lease_break_callback,
435 .fl_release_private = lease_release_private_callback,
436 .fl_mylease = lease_mylease_callback,
437 .fl_change = lease_modify,
438};
439
440/*
441 * Initialize a lease, use the default lock manager operations
442 */
443static int lease_init(struct file *filp, int type, struct file_lock *fl)
444 {
Trond Myklebust75dff552006-05-07 23:02:42 -0400445 if (assign_type(fl, type) != 0)
446 return -EINVAL;
447
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 fl->fl_owner = current->files;
449 fl->fl_pid = current->tgid;
450
451 fl->fl_file = filp;
452 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 fl->fl_start = 0;
454 fl->fl_end = OFFSET_MAX;
455 fl->fl_ops = NULL;
456 fl->fl_lmops = &lease_manager_ops;
457 return 0;
458}
459
460/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500461static struct file_lock *lease_alloc(struct file *filp, int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462{
463 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400464 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
466 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500467 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
469 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400470 if (error) {
471 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500472 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400473 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500474 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475}
476
477/* Check if two locks overlap each other.
478 */
479static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
480{
481 return ((fl1->fl_end >= fl2->fl_start) &&
482 (fl2->fl_end >= fl1->fl_start));
483}
484
485/*
486 * Check whether two locks have the same owner.
487 */
Matt Mackall33443c42006-01-08 01:05:22 -0800488static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489{
490 if (fl1->fl_lmops && fl1->fl_lmops->fl_compare_owner)
491 return fl2->fl_lmops == fl1->fl_lmops &&
492 fl1->fl_lmops->fl_compare_owner(fl1, fl2);
493 return fl1->fl_owner == fl2->fl_owner;
494}
495
496/* Remove waiter from blocker's block list.
497 * When blocker ends up pointing to itself then the list is empty.
498 */
Matt Mackall33443c42006-01-08 01:05:22 -0800499static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500{
501 list_del_init(&waiter->fl_block);
502 list_del_init(&waiter->fl_link);
503 waiter->fl_next = NULL;
504}
505
506/*
507 */
508static void locks_delete_block(struct file_lock *waiter)
509{
510 lock_kernel();
511 __locks_delete_block(waiter);
512 unlock_kernel();
513}
514
515/* Insert waiter into blocker's block list.
516 * We use a circular list so that processes can be easily woken up in
517 * the order they blocked. The documentation doesn't require this but
518 * it seems like the reasonable thing to do.
519 */
520static void locks_insert_block(struct file_lock *blocker,
521 struct file_lock *waiter)
522{
J. Bruce Fields6dc0fe82006-03-26 01:37:24 -0800523 BUG_ON(!list_empty(&waiter->fl_block));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 list_add_tail(&waiter->fl_block, &blocker->fl_block);
525 waiter->fl_next = blocker;
526 if (IS_POSIX(blocker))
527 list_add(&waiter->fl_link, &blocked_list);
528}
529
530/* Wake up processes blocked waiting for blocker.
531 * If told to wait then schedule the processes until the block list
532 * is empty, otherwise empty the block list ourselves.
533 */
534static void locks_wake_up_blocks(struct file_lock *blocker)
535{
536 while (!list_empty(&blocker->fl_block)) {
537 struct file_lock *waiter = list_entry(blocker->fl_block.next,
538 struct file_lock, fl_block);
539 __locks_delete_block(waiter);
540 if (waiter->fl_lmops && waiter->fl_lmops->fl_notify)
541 waiter->fl_lmops->fl_notify(waiter);
542 else
543 wake_up(&waiter->fl_wait);
544 }
545}
546
547/* Insert file lock fl into an inode's lock list at the position indicated
548 * by pos. At the same time add the lock to the global file lock list.
549 */
550static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
551{
552 list_add(&fl->fl_link, &file_lock_list);
553
554 /* insert into file's list */
555 fl->fl_next = *pos;
556 *pos = fl;
557
558 if (fl->fl_ops && fl->fl_ops->fl_insert)
559 fl->fl_ops->fl_insert(fl);
560}
561
562/*
563 * Delete a lock and then free it.
564 * Wake up processes that are blocked waiting for this lock,
565 * notify the FS that the lock has been cleared and
566 * finally free the lock.
567 */
568static void locks_delete_lock(struct file_lock **thisfl_p)
569{
570 struct file_lock *fl = *thisfl_p;
571
572 *thisfl_p = fl->fl_next;
573 fl->fl_next = NULL;
574 list_del_init(&fl->fl_link);
575
576 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
577 if (fl->fl_fasync != NULL) {
578 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
579 fl->fl_fasync = NULL;
580 }
581
582 if (fl->fl_ops && fl->fl_ops->fl_remove)
583 fl->fl_ops->fl_remove(fl);
584
585 locks_wake_up_blocks(fl);
586 locks_free_lock(fl);
587}
588
589/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
590 * checks for shared/exclusive status of overlapping locks.
591 */
592static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
593{
594 if (sys_fl->fl_type == F_WRLCK)
595 return 1;
596 if (caller_fl->fl_type == F_WRLCK)
597 return 1;
598 return 0;
599}
600
601/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
602 * checking before calling the locks_conflict().
603 */
604static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
605{
606 /* POSIX locks owned by the same process do not conflict with
607 * each other.
608 */
609 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
610 return (0);
611
612 /* Check whether they overlap */
613 if (!locks_overlap(caller_fl, sys_fl))
614 return 0;
615
616 return (locks_conflict(caller_fl, sys_fl));
617}
618
619/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
620 * checking before calling the locks_conflict().
621 */
622static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
623{
624 /* FLOCK locks referring to the same filp do not conflict with
625 * each other.
626 */
627 if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
628 return (0);
629 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
630 return 0;
631
632 return (locks_conflict(caller_fl, sys_fl));
633}
634
635static int interruptible_sleep_on_locked(wait_queue_head_t *fl_wait, int timeout)
636{
637 int result = 0;
638 DECLARE_WAITQUEUE(wait, current);
639
640 __set_current_state(TASK_INTERRUPTIBLE);
641 add_wait_queue(fl_wait, &wait);
642 if (timeout == 0)
643 schedule();
644 else
645 result = schedule_timeout(timeout);
646 if (signal_pending(current))
647 result = -ERESTARTSYS;
648 remove_wait_queue(fl_wait, &wait);
649 __set_current_state(TASK_RUNNING);
650 return result;
651}
652
653static int locks_block_on_timeout(struct file_lock *blocker, struct file_lock *waiter, int time)
654{
655 int result;
656 locks_insert_block(blocker, waiter);
657 result = interruptible_sleep_on_locked(&waiter->fl_wait, time);
658 __locks_delete_block(waiter);
659 return result;
660}
661
Andy Adamson8dc7c312006-03-20 13:44:26 -0500662int
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500663posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664{
665 struct file_lock *cfl;
666
667 lock_kernel();
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800668 for (cfl = filp->f_path.dentry->d_inode->i_flock; cfl; cfl = cfl->fl_next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 if (!IS_POSIX(cfl))
670 continue;
671 if (posix_locks_conflict(cfl, fl))
672 break;
673 }
Andy Adamson8dc7c312006-03-20 13:44:26 -0500674 if (cfl) {
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500675 __locks_copy_lock(fl, cfl);
Andy Adamson8dc7c312006-03-20 13:44:26 -0500676 unlock_kernel();
677 return 1;
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400678 } else
679 fl->fl_type = F_UNLCK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 unlock_kernel();
Andy Adamson8dc7c312006-03-20 13:44:26 -0500681 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682}
683
684EXPORT_SYMBOL(posix_test_lock);
685
686/* This function tests for deadlock condition before putting a process to
687 * sleep. The detection scheme is no longer recursive. Recursive was neat,
688 * but dangerous - we risked stack corruption if the lock data was bad, or
689 * if the recursion was too deep for any other reason.
690 *
691 * We rely on the fact that a task can only be on one lock's wait queue
692 * at a time. When we find blocked_task on a wait queue we can re-search
693 * with blocked_task equal to that queue's owner, until either blocked_task
694 * isn't found, or blocked_task is found on a queue owned by my_task.
695 *
696 * Note: the above assumption may not be true when handling lock requests
697 * from a broken NFS client. But broken NFS clients have a lot more to
698 * worry about than proper deadlock detection anyway... --okir
699 */
Adrian Bunkb0904e12006-06-23 02:05:13 -0700700static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 struct file_lock *block_fl)
702{
703 struct list_head *tmp;
704
705next_task:
706 if (posix_same_owner(caller_fl, block_fl))
707 return 1;
708 list_for_each(tmp, &blocked_list) {
709 struct file_lock *fl = list_entry(tmp, struct file_lock, fl_link);
710 if (posix_same_owner(fl, block_fl)) {
711 fl = fl->fl_next;
712 block_fl = fl;
713 goto next_task;
714 }
715 }
716 return 0;
717}
718
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
720 * at the head of the list, but that's secret knowledge known only to
721 * flock_lock_file and posix_lock_file.
Trond Myklebustf475ae92006-06-29 16:38:32 -0400722 *
723 * Note that if called with an FL_EXISTS argument, the caller may determine
724 * whether or not a lock was successfully freed by testing the return
725 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 */
Trond Myklebust993dfa82006-03-31 02:30:55 -0800727static int flock_lock_file(struct file *filp, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728{
Trond Myklebust993dfa82006-03-31 02:30:55 -0800729 struct file_lock *new_fl = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 struct file_lock **before;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800731 struct inode * inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 int error = 0;
733 int found = 0;
734
735 lock_kernel();
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400736 if (request->fl_flags & FL_ACCESS)
737 goto find_conflict;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 for_each_lock(inode, before) {
739 struct file_lock *fl = *before;
740 if (IS_POSIX(fl))
741 break;
742 if (IS_LEASE(fl))
743 continue;
744 if (filp != fl->fl_file)
745 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800746 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 goto out;
748 found = 1;
749 locks_delete_lock(before);
750 break;
751 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752
Trond Myklebustf475ae92006-06-29 16:38:32 -0400753 if (request->fl_type == F_UNLCK) {
754 if ((request->fl_flags & FL_EXISTS) && !found)
755 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800756 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400757 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758
Kirill Korotaev9cedc192006-06-14 17:59:35 +0400759 error = -ENOMEM;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800760 new_fl = locks_alloc_lock();
761 if (new_fl == NULL)
762 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 /*
764 * If a higher-priority process was blocked on the old file lock,
765 * give it the opportunity to lock the file.
766 */
767 if (found)
768 cond_resched();
769
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400770find_conflict:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 for_each_lock(inode, before) {
772 struct file_lock *fl = *before;
773 if (IS_POSIX(fl))
774 break;
775 if (IS_LEASE(fl))
776 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800777 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 continue;
779 error = -EAGAIN;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800780 if (request->fl_flags & FL_SLEEP)
781 locks_insert_block(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 goto out;
783 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -0400784 if (request->fl_flags & FL_ACCESS)
785 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -0800786 locks_copy_lock(new_fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 locks_insert_lock(&inode->i_flock, new_fl);
Trond Myklebust993dfa82006-03-31 02:30:55 -0800788 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +0400789 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790
791out:
792 unlock_kernel();
Trond Myklebust993dfa82006-03-31 02:30:55 -0800793 if (new_fl)
794 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 return error;
796}
797
Marc Eshel150b3932007-01-18 16:15:35 -0500798static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799{
800 struct file_lock *fl;
Miklos Szeredi39005d02006-06-23 02:05:10 -0700801 struct file_lock *new_fl = NULL;
802 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 struct file_lock *left = NULL;
804 struct file_lock *right = NULL;
805 struct file_lock **before;
806 int error, added = 0;
807
808 /*
809 * We may need two file_lock structures for this operation,
810 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -0700811 *
812 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 */
Miklos Szeredi39005d02006-06-23 02:05:10 -0700814 if (!(request->fl_flags & FL_ACCESS) &&
815 (request->fl_type != F_UNLCK ||
816 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
817 new_fl = locks_alloc_lock();
818 new_fl2 = locks_alloc_lock();
819 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
821 lock_kernel();
822 if (request->fl_type != F_UNLCK) {
823 for_each_lock(inode, before) {
824 struct file_lock *fl = *before;
825 if (!IS_POSIX(fl))
826 continue;
827 if (!posix_locks_conflict(request, fl))
828 continue;
Andy Adamson5842add2006-03-26 01:37:26 -0800829 if (conflock)
830 locks_copy_lock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 error = -EAGAIN;
832 if (!(request->fl_flags & FL_SLEEP))
833 goto out;
834 error = -EDEADLK;
835 if (posix_locks_deadlock(request, fl))
836 goto out;
837 error = -EAGAIN;
838 locks_insert_block(fl, request);
839 goto out;
840 }
841 }
842
843 /* If we're just looking for a conflict, we're done. */
844 error = 0;
845 if (request->fl_flags & FL_ACCESS)
846 goto out;
847
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 * Find the first old lock with the same owner as the new lock.
850 */
851
852 before = &inode->i_flock;
853
854 /* First skip locks owned by other processes. */
855 while ((fl = *before) && (!IS_POSIX(fl) ||
856 !posix_same_owner(request, fl))) {
857 before = &fl->fl_next;
858 }
859
860 /* Process locks with this owner. */
861 while ((fl = *before) && posix_same_owner(request, fl)) {
862 /* Detect adjacent or overlapping regions (if same lock type)
863 */
864 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -0700865 /* In all comparisons of start vs end, use
866 * "start - 1" rather than "end + 1". If end
867 * is OFFSET_MAX, end + 1 will become negative.
868 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 if (fl->fl_end < request->fl_start - 1)
870 goto next_lock;
871 /* If the next lock in the list has entirely bigger
872 * addresses than the new one, insert the lock here.
873 */
Olaf Kirch449231d2005-08-25 16:25:35 -0700874 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875 break;
876
877 /* If we come here, the new and old lock are of the
878 * same type and adjacent or overlapping. Make one
879 * lock yielding from the lower start address of both
880 * locks to the higher end address.
881 */
882 if (fl->fl_start > request->fl_start)
883 fl->fl_start = request->fl_start;
884 else
885 request->fl_start = fl->fl_start;
886 if (fl->fl_end < request->fl_end)
887 fl->fl_end = request->fl_end;
888 else
889 request->fl_end = fl->fl_end;
890 if (added) {
891 locks_delete_lock(before);
892 continue;
893 }
894 request = fl;
895 added = 1;
896 }
897 else {
898 /* Processing for different lock types is a bit
899 * more complex.
900 */
901 if (fl->fl_end < request->fl_start)
902 goto next_lock;
903 if (fl->fl_start > request->fl_end)
904 break;
905 if (request->fl_type == F_UNLCK)
906 added = 1;
907 if (fl->fl_start < request->fl_start)
908 left = fl;
909 /* If the next lock in the list has a higher end
910 * address than the new one, insert the new one here.
911 */
912 if (fl->fl_end > request->fl_end) {
913 right = fl;
914 break;
915 }
916 if (fl->fl_start >= request->fl_start) {
917 /* The new lock completely replaces an old
918 * one (This may happen several times).
919 */
920 if (added) {
921 locks_delete_lock(before);
922 continue;
923 }
924 /* Replace the old lock with the new one.
925 * Wake up anybody waiting for the old one,
926 * as the change in lock type might satisfy
927 * their needs.
928 */
929 locks_wake_up_blocks(fl);
930 fl->fl_start = request->fl_start;
931 fl->fl_end = request->fl_end;
932 fl->fl_type = request->fl_type;
Trond Myklebust47831f32006-03-20 13:44:05 -0500933 locks_release_private(fl);
934 locks_copy_private(fl, request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 request = fl;
936 added = 1;
937 }
938 }
939 /* Go on to next lock.
940 */
941 next_lock:
942 before = &fl->fl_next;
943 }
944
Miklos Szeredi0d9a4902006-06-23 02:05:09 -0700945 /*
946 * The above code only modifies existing locks in case of
947 * merging or replacing. If new lock(s) need to be inserted
948 * all modifications are done bellow this, so it's safe yet to
949 * bail out.
950 */
951 error = -ENOLCK; /* "no luck" */
952 if (right && left == right && !new_fl2)
953 goto out;
954
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 error = 0;
956 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -0400957 if (request->fl_type == F_UNLCK) {
958 if (request->fl_flags & FL_EXISTS)
959 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -0400961 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -0700962
963 if (!new_fl) {
964 error = -ENOLCK;
965 goto out;
966 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 locks_copy_lock(new_fl, request);
968 locks_insert_lock(before, new_fl);
969 new_fl = NULL;
970 }
971 if (right) {
972 if (left == right) {
973 /* The new lock breaks the old one in two pieces,
974 * so we have to use the second new lock.
975 */
976 left = new_fl2;
977 new_fl2 = NULL;
978 locks_copy_lock(left, right);
979 locks_insert_lock(before, left);
980 }
981 right->fl_start = request->fl_end + 1;
982 locks_wake_up_blocks(right);
983 }
984 if (left) {
985 left->fl_end = request->fl_start - 1;
986 locks_wake_up_blocks(left);
987 }
988 out:
989 unlock_kernel();
990 /*
991 * Free any unused locks.
992 */
993 if (new_fl)
994 locks_free_lock(new_fl);
995 if (new_fl2)
996 locks_free_lock(new_fl2);
997 return error;
998}
999
1000/**
1001 * posix_lock_file - Apply a POSIX-style lock to a file
1002 * @filp: The file to apply the lock to
1003 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001004 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 *
1006 * Add a POSIX style lock to a file.
1007 * We merge adjacent & overlapping locks whenever possible.
1008 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001009 *
1010 * Note that if called with an FL_EXISTS argument, the caller may determine
1011 * whether or not a lock was successfully freed by testing the return
1012 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 */
Marc Eshel150b3932007-01-18 16:15:35 -05001014int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001015 struct file_lock *conflock)
1016{
Marc Eshel150b3932007-01-18 16:15:35 -05001017 return __posix_lock_file(filp->f_path.dentry->d_inode, fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001018}
Marc Eshel150b3932007-01-18 16:15:35 -05001019EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
1021/**
1022 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1023 * @filp: The file to apply the lock to
1024 * @fl: The lock to be applied
1025 *
1026 * Add a POSIX style lock to a file.
1027 * We merge adjacent & overlapping locks whenever possible.
1028 * POSIX locks are sorted by owner task, then by starting address
1029 */
1030int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1031{
1032 int error;
1033 might_sleep ();
1034 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001035 error = posix_lock_file(filp, fl, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 if ((error != -EAGAIN) || !(fl->fl_flags & FL_SLEEP))
1037 break;
1038 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1039 if (!error)
1040 continue;
1041
1042 locks_delete_block(fl);
1043 break;
1044 }
1045 return error;
1046}
1047EXPORT_SYMBOL(posix_lock_file_wait);
1048
1049/**
1050 * locks_mandatory_locked - Check for an active lock
1051 * @inode: the file to check
1052 *
1053 * Searches the inode's list of locks to find any POSIX locks which conflict.
1054 * This function is called from locks_verify_locked() only.
1055 */
1056int locks_mandatory_locked(struct inode *inode)
1057{
1058 fl_owner_t owner = current->files;
1059 struct file_lock *fl;
1060
1061 /*
1062 * Search the lock list for this inode for any POSIX locks.
1063 */
1064 lock_kernel();
1065 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1066 if (!IS_POSIX(fl))
1067 continue;
1068 if (fl->fl_owner != owner)
1069 break;
1070 }
1071 unlock_kernel();
1072 return fl ? -EAGAIN : 0;
1073}
1074
1075/**
1076 * locks_mandatory_area - Check for a conflicting lock
1077 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1078 * for shared
1079 * @inode: the file to check
1080 * @filp: how the file was opened (if it was)
1081 * @offset: start of area to check
1082 * @count: length of area to check
1083 *
1084 * Searches the inode's list of locks to find any POSIX locks which conflict.
1085 * This function is called from rw_verify_area() and
1086 * locks_verify_truncate().
1087 */
1088int locks_mandatory_area(int read_write, struct inode *inode,
1089 struct file *filp, loff_t offset,
1090 size_t count)
1091{
1092 struct file_lock fl;
1093 int error;
1094
1095 locks_init_lock(&fl);
1096 fl.fl_owner = current->files;
1097 fl.fl_pid = current->tgid;
1098 fl.fl_file = filp;
1099 fl.fl_flags = FL_POSIX | FL_ACCESS;
1100 if (filp && !(filp->f_flags & O_NONBLOCK))
1101 fl.fl_flags |= FL_SLEEP;
1102 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1103 fl.fl_start = offset;
1104 fl.fl_end = offset + count - 1;
1105
1106 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001107 error = __posix_lock_file(inode, &fl, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 if (error != -EAGAIN)
1109 break;
1110 if (!(fl.fl_flags & FL_SLEEP))
1111 break;
1112 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1113 if (!error) {
1114 /*
1115 * If we've been sleeping someone might have
1116 * changed the permissions behind our back.
1117 */
1118 if ((inode->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID)
1119 continue;
1120 }
1121
1122 locks_delete_block(&fl);
1123 break;
1124 }
1125
1126 return error;
1127}
1128
1129EXPORT_SYMBOL(locks_mandatory_area);
1130
1131/* We already had a lease on this file; just change its type */
1132int lease_modify(struct file_lock **before, int arg)
1133{
1134 struct file_lock *fl = *before;
1135 int error = assign_type(fl, arg);
1136
1137 if (error)
1138 return error;
1139 locks_wake_up_blocks(fl);
1140 if (arg == F_UNLCK)
1141 locks_delete_lock(before);
1142 return 0;
1143}
1144
1145EXPORT_SYMBOL(lease_modify);
1146
1147static void time_out_leases(struct inode *inode)
1148{
1149 struct file_lock **before;
1150 struct file_lock *fl;
1151
1152 before = &inode->i_flock;
1153 while ((fl = *before) && IS_LEASE(fl) && (fl->fl_type & F_INPROGRESS)) {
1154 if ((fl->fl_break_time == 0)
1155 || time_before(jiffies, fl->fl_break_time)) {
1156 before = &fl->fl_next;
1157 continue;
1158 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 lease_modify(before, fl->fl_type & ~F_INPROGRESS);
1160 if (fl == *before) /* lease_modify may have freed fl */
1161 before = &fl->fl_next;
1162 }
1163}
1164
1165/**
1166 * __break_lease - revoke all outstanding leases on file
1167 * @inode: the inode of the file to return
1168 * @mode: the open mode (read or write)
1169 *
david m. richter87250dd2007-05-09 16:10:27 -04001170 * break_lease (inlined for speed) has checked there already is at least
1171 * some kind of lock (maybe a lease) on this file. Leases are broken on
1172 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 * specified %O_NONBLOCK to your open().
1174 */
1175int __break_lease(struct inode *inode, unsigned int mode)
1176{
1177 int error = 0, future;
1178 struct file_lock *new_fl, *flock;
1179 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 unsigned long break_time;
1181 int i_have_this_lease = 0;
1182
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -05001183 new_fl = lease_alloc(NULL, mode & FMODE_WRITE ? F_WRLCK : F_RDLCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184
1185 lock_kernel();
1186
1187 time_out_leases(inode);
1188
1189 flock = inode->i_flock;
1190 if ((flock == NULL) || !IS_LEASE(flock))
1191 goto out;
1192
1193 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next)
1194 if (fl->fl_owner == current->files)
1195 i_have_this_lease = 1;
1196
1197 if (mode & FMODE_WRITE) {
1198 /* If we want write access, we have to revoke any lease. */
1199 future = F_UNLCK | F_INPROGRESS;
1200 } else if (flock->fl_type & F_INPROGRESS) {
1201 /* If the lease is already being broken, we just leave it */
1202 future = flock->fl_type;
1203 } else if (flock->fl_type & F_WRLCK) {
1204 /* Downgrade the exclusive lease to a read-only lease. */
1205 future = F_RDLCK | F_INPROGRESS;
1206 } else {
1207 /* the existing lease was read-only, so we can read too. */
1208 goto out;
1209 }
1210
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -05001211 if (IS_ERR(new_fl) && !i_have_this_lease
1212 && ((mode & O_NONBLOCK) == 0)) {
1213 error = PTR_ERR(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214 goto out;
1215 }
1216
1217 break_time = 0;
1218 if (lease_break_time > 0) {
1219 break_time = jiffies + lease_break_time * HZ;
1220 if (break_time == 0)
1221 break_time++; /* so that 0 means no break time */
1222 }
1223
1224 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1225 if (fl->fl_type != future) {
1226 fl->fl_type = future;
1227 fl->fl_break_time = break_time;
1228 /* lease must have lmops break callback */
1229 fl->fl_lmops->fl_break(fl);
1230 }
1231 }
1232
1233 if (i_have_this_lease || (mode & O_NONBLOCK)) {
1234 error = -EWOULDBLOCK;
1235 goto out;
1236 }
1237
1238restart:
1239 break_time = flock->fl_break_time;
1240 if (break_time != 0) {
1241 break_time -= jiffies;
1242 if (break_time == 0)
1243 break_time++;
1244 }
1245 error = locks_block_on_timeout(flock, new_fl, break_time);
1246 if (error >= 0) {
1247 if (error == 0)
1248 time_out_leases(inode);
1249 /* Wait for the next lease that has not been broken yet */
1250 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1251 flock = flock->fl_next) {
1252 if (flock->fl_type & F_INPROGRESS)
1253 goto restart;
1254 }
1255 error = 0;
1256 }
1257
1258out:
1259 unlock_kernel();
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -05001260 if (!IS_ERR(new_fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 locks_free_lock(new_fl);
1262 return error;
1263}
1264
1265EXPORT_SYMBOL(__break_lease);
1266
1267/**
1268 * lease_get_mtime
1269 * @inode: the inode
1270 * @time: pointer to a timespec which will contain the last modified time
1271 *
1272 * This is to force NFS clients to flush their caches for files with
1273 * exclusive leases. The justification is that if someone has an
1274 * exclusive lease, then they could be modifiying it.
1275 */
1276void lease_get_mtime(struct inode *inode, struct timespec *time)
1277{
1278 struct file_lock *flock = inode->i_flock;
1279 if (flock && IS_LEASE(flock) && (flock->fl_type & F_WRLCK))
1280 *time = current_fs_time(inode->i_sb);
1281 else
1282 *time = inode->i_mtime;
1283}
1284
1285EXPORT_SYMBOL(lease_get_mtime);
1286
1287/**
1288 * fcntl_getlease - Enquire what lease is currently active
1289 * @filp: the file
1290 *
1291 * The value returned by this function will be one of
1292 * (if no lease break is pending):
1293 *
1294 * %F_RDLCK to indicate a shared lease is held.
1295 *
1296 * %F_WRLCK to indicate an exclusive lease is held.
1297 *
1298 * %F_UNLCK to indicate no lease is held.
1299 *
1300 * (if a lease break is pending):
1301 *
1302 * %F_RDLCK to indicate an exclusive lease needs to be
1303 * changed to a shared lease (or removed).
1304 *
1305 * %F_UNLCK to indicate the lease needs to be removed.
1306 *
1307 * XXX: sfr & willy disagree over whether F_INPROGRESS
1308 * should be returned to userspace.
1309 */
1310int fcntl_getlease(struct file *filp)
1311{
1312 struct file_lock *fl;
1313 int type = F_UNLCK;
1314
1315 lock_kernel();
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001316 time_out_leases(filp->f_path.dentry->d_inode);
1317 for (fl = filp->f_path.dentry->d_inode->i_flock; fl && IS_LEASE(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 fl = fl->fl_next) {
1319 if (fl->fl_file == filp) {
1320 type = fl->fl_type & ~F_INPROGRESS;
1321 break;
1322 }
1323 }
1324 unlock_kernel();
1325 return type;
1326}
1327
1328/**
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001329 * setlease - sets a lease on an open file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 * @filp: file pointer
1331 * @arg: type of lease to obtain
1332 * @flp: input - file_lock to use, output - file_lock inserted
1333 *
1334 * The (input) flp->fl_lmops->fl_break function is required
1335 * by break_lease().
1336 *
1337 * Called with kernel lock held.
1338 */
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001339static int setlease(struct file *filp, long arg, struct file_lock **flp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340{
KAMBAROV, ZAUR7eaae282005-07-07 17:57:06 -07001341 struct file_lock *fl, **before, **my_before = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001342 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 struct inode *inode = dentry->d_inode;
1344 int error, rdlease_count = 0, wrlease_count = 0;
1345
J. Bruce Fields6d5e8b02007-05-31 17:03:46 -04001346 if ((current->fsuid != inode->i_uid) && !capable(CAP_LEASE))
1347 return -EACCES;
1348 if (!S_ISREG(inode->i_mode))
1349 return -EINVAL;
1350 error = security_file_lock(filp, arg);
1351 if (error)
1352 return error;
1353
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 time_out_leases(inode);
1355
J. Bruce Fieldsd2ab0b0c2007-06-30 12:40:32 -04001356 BUG_ON(!(*flp)->fl_lmops->fl_break);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357
KAMBAROV, ZAUR7eaae282005-07-07 17:57:06 -07001358 lease = *flp;
1359
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 error = -EAGAIN;
1361 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1362 goto out;
1363 if ((arg == F_WRLCK)
1364 && ((atomic_read(&dentry->d_count) > 1)
1365 || (atomic_read(&inode->i_count) > 1)))
1366 goto out;
1367
1368 /*
1369 * At this point, we know that if there is an exclusive
1370 * lease on this file, then we hold it on this filp
1371 * (otherwise our open of this file would have blocked).
1372 * And if we are trying to acquire an exclusive lease,
1373 * then the file is not open by anyone (including us)
1374 * except for this filp.
1375 */
1376 for (before = &inode->i_flock;
1377 ((fl = *before) != NULL) && IS_LEASE(fl);
1378 before = &fl->fl_next) {
1379 if (lease->fl_lmops->fl_mylease(fl, lease))
1380 my_before = before;
1381 else if (fl->fl_type == (F_INPROGRESS | F_UNLCK))
1382 /*
1383 * Someone is in the process of opening this
1384 * file for writing so we may not take an
1385 * exclusive lease on it.
1386 */
1387 wrlease_count++;
1388 else
1389 rdlease_count++;
1390 }
1391
1392 if ((arg == F_RDLCK && (wrlease_count > 0)) ||
1393 (arg == F_WRLCK && ((rdlease_count + wrlease_count) > 0)))
1394 goto out;
1395
1396 if (my_before != NULL) {
Trond Myklebust75dff552006-05-07 23:02:42 -04001397 *flp = *my_before;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398 error = lease->fl_lmops->fl_change(my_before, arg);
1399 goto out;
1400 }
1401
1402 error = 0;
1403 if (arg == F_UNLCK)
1404 goto out;
1405
1406 error = -EINVAL;
1407 if (!leases_enable)
1408 goto out;
1409
Trond Myklebust74361cb2006-08-14 08:54:48 -07001410 error = -ENOMEM;
1411 fl = locks_alloc_lock();
1412 if (fl == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 goto out;
1414
1415 locks_copy_lock(fl, lease);
1416
1417 locks_insert_lock(before, fl);
1418
1419 *flp = fl;
Trond Myklebust74361cb2006-08-14 08:54:48 -07001420 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421out:
1422 return error;
1423}
1424
1425 /**
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001426 * vfs_setlease - sets a lease on an open file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 * @filp: file pointer
1428 * @arg: type of lease to obtain
1429 * @lease: file_lock to use
1430 *
1431 * Call this to establish a lease on the file.
1432 * The fl_lmops fl_break function is required by break_lease
1433 */
1434
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001435int vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 int error;
1438
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 lock_kernel();
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001440 error = setlease(filp, arg, lease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441 unlock_kernel();
1442
1443 return error;
1444}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001445EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446
1447/**
1448 * fcntl_setlease - sets a lease on an open file
1449 * @fd: open file descriptor
1450 * @filp: file pointer
1451 * @arg: type of lease to obtain
1452 *
1453 * Call this fcntl to establish a lease on the file.
1454 * Note that you also need to call %F_SETSIG to
1455 * receive a signal when the lease is broken.
1456 */
1457int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1458{
1459 struct file_lock fl, *flp = &fl;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001460 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 struct inode *inode = dentry->d_inode;
1462 int error;
1463
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 locks_init_lock(&fl);
1465 error = lease_init(filp, arg, &fl);
1466 if (error)
1467 return error;
1468
1469 lock_kernel();
1470
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001471 error = vfs_setlease(filp, arg, &flp);
J. Bruce Fieldsdc15ae12005-11-10 19:08:00 -05001472 if (error || arg == F_UNLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473 goto out_unlock;
1474
1475 error = fasync_helper(fd, filp, 1, &flp->fl_fasync);
1476 if (error < 0) {
J. Bruce Fields6d5e8b02007-05-31 17:03:46 -04001477 /* remove lease just inserted by setlease */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 flp->fl_type = F_UNLCK | F_INPROGRESS;
J. Bruce Fields6d5e8b02007-05-31 17:03:46 -04001479 flp->fl_break_time = jiffies - 10;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 time_out_leases(inode);
1481 goto out_unlock;
1482 }
1483
Eric W. Biederman609d7fa2006-10-02 02:17:15 -07001484 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485out_unlock:
1486 unlock_kernel();
1487 return error;
1488}
1489
1490/**
1491 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1492 * @filp: The file to apply the lock to
1493 * @fl: The lock to be applied
1494 *
1495 * Add a FLOCK style lock to a file.
1496 */
1497int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1498{
1499 int error;
1500 might_sleep();
1501 for (;;) {
1502 error = flock_lock_file(filp, fl);
1503 if ((error != -EAGAIN) || !(fl->fl_flags & FL_SLEEP))
1504 break;
1505 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1506 if (!error)
1507 continue;
1508
1509 locks_delete_block(fl);
1510 break;
1511 }
1512 return error;
1513}
1514
1515EXPORT_SYMBOL(flock_lock_file_wait);
1516
1517/**
1518 * sys_flock: - flock() system call.
1519 * @fd: the file descriptor to lock.
1520 * @cmd: the type of lock to apply.
1521 *
1522 * Apply a %FL_FLOCK style lock to an open file descriptor.
1523 * The @cmd can be one of
1524 *
1525 * %LOCK_SH -- a shared lock.
1526 *
1527 * %LOCK_EX -- an exclusive lock.
1528 *
1529 * %LOCK_UN -- remove an existing lock.
1530 *
1531 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1532 *
1533 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1534 * processes read and write access respectively.
1535 */
1536asmlinkage long sys_flock(unsigned int fd, unsigned int cmd)
1537{
1538 struct file *filp;
1539 struct file_lock *lock;
1540 int can_sleep, unlock;
1541 int error;
1542
1543 error = -EBADF;
1544 filp = fget(fd);
1545 if (!filp)
1546 goto out;
1547
1548 can_sleep = !(cmd & LOCK_NB);
1549 cmd &= ~LOCK_NB;
1550 unlock = (cmd == LOCK_UN);
1551
1552 if (!unlock && !(cmd & LOCK_MAND) && !(filp->f_mode & 3))
1553 goto out_putf;
1554
1555 error = flock_make_lock(filp, &lock, cmd);
1556 if (error)
1557 goto out_putf;
1558 if (can_sleep)
1559 lock->fl_flags |= FL_SLEEP;
1560
1561 error = security_file_lock(filp, cmd);
1562 if (error)
1563 goto out_free;
1564
1565 if (filp->f_op && filp->f_op->flock)
1566 error = filp->f_op->flock(filp,
1567 (can_sleep) ? F_SETLKW : F_SETLK,
1568 lock);
1569 else
1570 error = flock_lock_file_wait(filp, lock);
1571
1572 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08001573 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574
1575 out_putf:
1576 fput(filp);
1577 out:
1578 return error;
1579}
1580
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001581/**
1582 * vfs_test_lock - test file byte range lock
1583 * @filp: The file to test lock for
1584 * @fl: The lock to test
1585 * @conf: Place to return a copy of the conflicting lock, if found
1586 *
1587 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1588 * setting conf->fl_type to something other than F_UNLCK.
1589 */
1590int vfs_test_lock(struct file *filp, struct file_lock *fl)
1591{
1592 if (filp->f_op && filp->f_op->lock)
1593 return filp->f_op->lock(filp, F_GETLK, fl);
1594 posix_test_lock(filp, fl);
1595 return 0;
1596}
1597EXPORT_SYMBOL_GPL(vfs_test_lock);
1598
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001599static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1600{
1601 flock->l_pid = fl->fl_pid;
1602#if BITS_PER_LONG == 32
1603 /*
1604 * Make sure we can represent the posix lock via
1605 * legacy 32bit flock.
1606 */
1607 if (fl->fl_start > OFFT_OFFSET_MAX)
1608 return -EOVERFLOW;
1609 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1610 return -EOVERFLOW;
1611#endif
1612 flock->l_start = fl->fl_start;
1613 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1614 fl->fl_end - fl->fl_start + 1;
1615 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04001616 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001617 return 0;
1618}
1619
1620#if BITS_PER_LONG == 32
1621static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1622{
1623 flock->l_pid = fl->fl_pid;
1624 flock->l_start = fl->fl_start;
1625 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1626 fl->fl_end - fl->fl_start + 1;
1627 flock->l_whence = 0;
1628 flock->l_type = fl->fl_type;
1629}
1630#endif
1631
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632/* Report the first existing lock that would conflict with l.
1633 * This implements the F_GETLK command of fcntl().
1634 */
1635int fcntl_getlk(struct file *filp, struct flock __user *l)
1636{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001637 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 struct flock flock;
1639 int error;
1640
1641 error = -EFAULT;
1642 if (copy_from_user(&flock, l, sizeof(flock)))
1643 goto out;
1644 error = -EINVAL;
1645 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1646 goto out;
1647
1648 error = flock_to_posix_lock(filp, &file_lock, &flock);
1649 if (error)
1650 goto out;
1651
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001652 error = vfs_test_lock(filp, &file_lock);
1653 if (error)
1654 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001656 flock.l_type = file_lock.fl_type;
1657 if (file_lock.fl_type != F_UNLCK) {
1658 error = posix_lock_to_flock(&flock, &file_lock);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05001659 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 }
1662 error = -EFAULT;
1663 if (!copy_to_user(l, &flock, sizeof(flock)))
1664 error = 0;
1665out:
1666 return error;
1667}
1668
Marc Eshel7723ec92007-01-18 15:08:55 -05001669/**
1670 * vfs_lock_file - file byte range lock
1671 * @filp: The file to apply the lock to
1672 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1673 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001674 * @conf: Place to return a copy of the conflicting lock, if found.
1675 *
1676 * A caller that doesn't care about the conflicting lock may pass NULL
1677 * as the final argument.
1678 *
1679 * If the filesystem defines a private ->lock() method, then @conf will
1680 * be left unchanged; so a caller that cares should initialize it to
1681 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05001682 *
1683 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1684 * locks, the ->lock() interface may return asynchronously, before the lock has
1685 * been granted or denied by the underlying filesystem, if (and only if)
1686 * fl_grant is set. Callers expecting ->lock() to return asynchronously
1687 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1688 * the request is for a blocking lock. When ->lock() does return asynchronously,
1689 * it must return -EINPROGRESS, and call ->fl_grant() when the lock
1690 * request completes.
1691 * If the request is for non-blocking lock the file system should return
1692 * -EINPROGRESS then try to get the lock and call the callback routine with
1693 * the result. If the request timed out the callback routine will return a
1694 * nonzero return code and the file system should release the lock. The file
1695 * system is also responsible to keep a corresponding posix lock when it
1696 * grants a lock so the VFS can find out which locks are locally held and do
1697 * the correct lock cleanup when required.
1698 * The underlying filesystem must not drop the kernel lock or call
1699 * ->fl_grant() before returning to the caller with a -EINPROGRESS
1700 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05001701 */
Marc Eshel150b3932007-01-18 16:15:35 -05001702int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05001703{
1704 if (filp->f_op && filp->f_op->lock)
1705 return filp->f_op->lock(filp, cmd, fl);
1706 else
Marc Eshel150b3932007-01-18 16:15:35 -05001707 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05001708}
1709EXPORT_SYMBOL_GPL(vfs_lock_file);
1710
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711/* Apply the lock described by l to an open file descriptor.
1712 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1713 */
Peter Staubachc2936212005-07-27 11:45:09 -07001714int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
1715 struct flock __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716{
1717 struct file_lock *file_lock = locks_alloc_lock();
1718 struct flock flock;
1719 struct inode *inode;
1720 int error;
1721
1722 if (file_lock == NULL)
1723 return -ENOLCK;
1724
1725 /*
1726 * This might block, so we do it before checking the inode.
1727 */
1728 error = -EFAULT;
1729 if (copy_from_user(&flock, l, sizeof(flock)))
1730 goto out;
1731
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001732 inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733
1734 /* Don't allow mandatory locks on files that may be memory mapped
1735 * and shared.
1736 */
1737 if (IS_MANDLOCK(inode) &&
1738 (inode->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID &&
1739 mapping_writably_mapped(filp->f_mapping)) {
1740 error = -EAGAIN;
1741 goto out;
1742 }
1743
Peter Staubachc2936212005-07-27 11:45:09 -07001744again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 error = flock_to_posix_lock(filp, file_lock, &flock);
1746 if (error)
1747 goto out;
1748 if (cmd == F_SETLKW) {
1749 file_lock->fl_flags |= FL_SLEEP;
1750 }
1751
1752 error = -EBADF;
1753 switch (flock.l_type) {
1754 case F_RDLCK:
1755 if (!(filp->f_mode & FMODE_READ))
1756 goto out;
1757 break;
1758 case F_WRLCK:
1759 if (!(filp->f_mode & FMODE_WRITE))
1760 goto out;
1761 break;
1762 case F_UNLCK:
1763 break;
1764 default:
1765 error = -EINVAL;
1766 goto out;
1767 }
1768
1769 error = security_file_lock(filp, file_lock->fl_type);
1770 if (error)
1771 goto out;
1772
Marc Eshel7723ec92007-01-18 15:08:55 -05001773 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001774 error = vfs_lock_file(filp, cmd, file_lock, NULL);
Marc Eshel7723ec92007-01-18 15:08:55 -05001775 if (error != -EAGAIN || cmd == F_SETLK)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776 break;
Marc Eshel7723ec92007-01-18 15:08:55 -05001777 error = wait_event_interruptible(file_lock->fl_wait,
1778 !file_lock->fl_next);
1779 if (!error)
1780 continue;
1781
1782 locks_delete_block(file_lock);
1783 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 }
1785
Peter Staubachc2936212005-07-27 11:45:09 -07001786 /*
1787 * Attempt to detect a close/fcntl race and recover by
1788 * releasing the lock that was just acquired.
1789 */
1790 if (!error && fcheck(fd) != filp && flock.l_type != F_UNLCK) {
1791 flock.l_type = F_UNLCK;
1792 goto again;
1793 }
1794
1795out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 locks_free_lock(file_lock);
1797 return error;
1798}
1799
1800#if BITS_PER_LONG == 32
1801/* Report the first existing lock that would conflict with l.
1802 * This implements the F_GETLK command of fcntl().
1803 */
1804int fcntl_getlk64(struct file *filp, struct flock64 __user *l)
1805{
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001806 struct file_lock file_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807 struct flock64 flock;
1808 int error;
1809
1810 error = -EFAULT;
1811 if (copy_from_user(&flock, l, sizeof(flock)))
1812 goto out;
1813 error = -EINVAL;
1814 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1815 goto out;
1816
1817 error = flock64_to_posix_lock(filp, &file_lock, &flock);
1818 if (error)
1819 goto out;
1820
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001821 error = vfs_test_lock(filp, &file_lock);
1822 if (error)
1823 goto out;
1824
Marc Eshel9d6a8c52007-02-21 00:55:18 -05001825 flock.l_type = file_lock.fl_type;
1826 if (file_lock.fl_type != F_UNLCK)
1827 posix_lock_to_flock64(&flock, &file_lock);
1828
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 error = -EFAULT;
1830 if (!copy_to_user(l, &flock, sizeof(flock)))
1831 error = 0;
1832
1833out:
1834 return error;
1835}
1836
1837/* Apply the lock described by l to an open file descriptor.
1838 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1839 */
Peter Staubachc2936212005-07-27 11:45:09 -07001840int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
1841 struct flock64 __user *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842{
1843 struct file_lock *file_lock = locks_alloc_lock();
1844 struct flock64 flock;
1845 struct inode *inode;
1846 int error;
1847
1848 if (file_lock == NULL)
1849 return -ENOLCK;
1850
1851 /*
1852 * This might block, so we do it before checking the inode.
1853 */
1854 error = -EFAULT;
1855 if (copy_from_user(&flock, l, sizeof(flock)))
1856 goto out;
1857
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001858 inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859
1860 /* Don't allow mandatory locks on files that may be memory mapped
1861 * and shared.
1862 */
1863 if (IS_MANDLOCK(inode) &&
1864 (inode->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID &&
1865 mapping_writably_mapped(filp->f_mapping)) {
1866 error = -EAGAIN;
1867 goto out;
1868 }
1869
Peter Staubachc2936212005-07-27 11:45:09 -07001870again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871 error = flock64_to_posix_lock(filp, file_lock, &flock);
1872 if (error)
1873 goto out;
1874 if (cmd == F_SETLKW64) {
1875 file_lock->fl_flags |= FL_SLEEP;
1876 }
1877
1878 error = -EBADF;
1879 switch (flock.l_type) {
1880 case F_RDLCK:
1881 if (!(filp->f_mode & FMODE_READ))
1882 goto out;
1883 break;
1884 case F_WRLCK:
1885 if (!(filp->f_mode & FMODE_WRITE))
1886 goto out;
1887 break;
1888 case F_UNLCK:
1889 break;
1890 default:
1891 error = -EINVAL;
1892 goto out;
1893 }
1894
1895 error = security_file_lock(filp, file_lock->fl_type);
1896 if (error)
1897 goto out;
1898
Marc Eshel7723ec92007-01-18 15:08:55 -05001899 for (;;) {
Marc Eshel150b3932007-01-18 16:15:35 -05001900 error = vfs_lock_file(filp, cmd, file_lock, NULL);
Marc Eshel7723ec92007-01-18 15:08:55 -05001901 if (error != -EAGAIN || cmd == F_SETLK64)
Peter Staubachc2936212005-07-27 11:45:09 -07001902 break;
Marc Eshel7723ec92007-01-18 15:08:55 -05001903 error = wait_event_interruptible(file_lock->fl_wait,
1904 !file_lock->fl_next);
1905 if (!error)
1906 continue;
1907
1908 locks_delete_block(file_lock);
1909 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 }
1911
Peter Staubachc2936212005-07-27 11:45:09 -07001912 /*
1913 * Attempt to detect a close/fcntl race and recover by
1914 * releasing the lock that was just acquired.
1915 */
1916 if (!error && fcheck(fd) != filp && flock.l_type != F_UNLCK) {
1917 flock.l_type = F_UNLCK;
1918 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 }
1920
1921out:
1922 locks_free_lock(file_lock);
1923 return error;
1924}
1925#endif /* BITS_PER_LONG == 32 */
1926
1927/*
1928 * This function is called when the file is being removed
1929 * from the task's fd array. POSIX locks belonging to this task
1930 * are deleted at this time.
1931 */
1932void locks_remove_posix(struct file *filp, fl_owner_t owner)
1933{
Miklos Szerediff7b86b2006-06-23 02:05:11 -07001934 struct file_lock lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935
1936 /*
1937 * If there are no locks held on this file, we don't need to call
1938 * posix_lock_file(). Another process could be setting a lock on this
1939 * file at the same time, but we wouldn't remove that lock anyway.
1940 */
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001941 if (!filp->f_path.dentry->d_inode->i_flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942 return;
1943
1944 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07001945 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 lock.fl_start = 0;
1947 lock.fl_end = OFFSET_MAX;
1948 lock.fl_owner = owner;
1949 lock.fl_pid = current->tgid;
1950 lock.fl_file = filp;
1951 lock.fl_ops = NULL;
1952 lock.fl_lmops = NULL;
1953
Marc Eshel150b3932007-01-18 16:15:35 -05001954 vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 if (lock.fl_ops && lock.fl_ops->fl_release_private)
1957 lock.fl_ops->fl_release_private(&lock);
1958}
1959
1960EXPORT_SYMBOL(locks_remove_posix);
1961
1962/*
1963 * This function is called on the last close of an open file.
1964 */
1965void locks_remove_flock(struct file *filp)
1966{
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001967 struct inode * inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968 struct file_lock *fl;
1969 struct file_lock **before;
1970
1971 if (!inode->i_flock)
1972 return;
1973
1974 if (filp->f_op && filp->f_op->flock) {
1975 struct file_lock fl = {
1976 .fl_pid = current->tgid,
1977 .fl_file = filp,
1978 .fl_flags = FL_FLOCK,
1979 .fl_type = F_UNLCK,
1980 .fl_end = OFFSET_MAX,
1981 };
1982 filp->f_op->flock(filp, F_SETLKW, &fl);
Trond Myklebust80fec4c2005-06-22 17:16:31 +00001983 if (fl.fl_ops && fl.fl_ops->fl_release_private)
1984 fl.fl_ops->fl_release_private(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985 }
1986
1987 lock_kernel();
1988 before = &inode->i_flock;
1989
1990 while ((fl = *before) != NULL) {
1991 if (fl->fl_file == filp) {
Peter Staubachc2936212005-07-27 11:45:09 -07001992 if (IS_FLOCK(fl)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 locks_delete_lock(before);
1994 continue;
1995 }
1996 if (IS_LEASE(fl)) {
1997 lease_modify(before, F_UNLCK);
1998 continue;
1999 }
2000 /* What? */
2001 BUG();
2002 }
2003 before = &fl->fl_next;
2004 }
2005 unlock_kernel();
2006}
2007
2008/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 * posix_unblock_lock - stop waiting for a file lock
2010 * @filp: how the file was opened
2011 * @waiter: the lock which was waiting
2012 *
2013 * lockd needs to block waiting for locks.
2014 */
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002015int
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016posix_unblock_lock(struct file *filp, struct file_lock *waiter)
2017{
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002018 int status = 0;
2019
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020 lock_kernel();
J. Bruce Fields5996a292006-01-03 09:55:44 +01002021 if (waiter->fl_next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022 __locks_delete_block(waiter);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002023 else
2024 status = -ENOENT;
J. Bruce Fields5996a292006-01-03 09:55:44 +01002025 unlock_kernel();
J. Bruce Fields64a318e2006-01-03 09:55:46 +01002026 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027}
2028
2029EXPORT_SYMBOL(posix_unblock_lock);
2030
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002031/**
2032 * vfs_cancel_lock - file byte range unblock lock
2033 * @filp: The file to apply the unblock to
2034 * @fl: The lock to be unblocked
2035 *
2036 * Used by lock managers to cancel blocked requests
2037 */
2038int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2039{
2040 if (filp->f_op && filp->f_op->lock)
2041 return filp->f_op->lock(filp, F_CANCELLK, fl);
2042 return 0;
2043}
2044
2045EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2046
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047static void lock_get_status(char* out, struct file_lock *fl, int id, char *pfx)
2048{
2049 struct inode *inode = NULL;
2050
2051 if (fl->fl_file != NULL)
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08002052 inode = fl->fl_file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053
2054 out += sprintf(out, "%d:%s ", id, pfx);
2055 if (IS_POSIX(fl)) {
2056 out += sprintf(out, "%6s %s ",
2057 (fl->fl_flags & FL_ACCESS) ? "ACCESS" : "POSIX ",
2058 (inode == NULL) ? "*NOINODE*" :
2059 (IS_MANDLOCK(inode) &&
2060 (inode->i_mode & (S_IXGRP | S_ISGID)) == S_ISGID) ?
2061 "MANDATORY" : "ADVISORY ");
2062 } else if (IS_FLOCK(fl)) {
2063 if (fl->fl_type & LOCK_MAND) {
2064 out += sprintf(out, "FLOCK MSNFS ");
2065 } else {
2066 out += sprintf(out, "FLOCK ADVISORY ");
2067 }
2068 } else if (IS_LEASE(fl)) {
2069 out += sprintf(out, "LEASE ");
2070 if (fl->fl_type & F_INPROGRESS)
2071 out += sprintf(out, "BREAKING ");
2072 else if (fl->fl_file)
2073 out += sprintf(out, "ACTIVE ");
2074 else
2075 out += sprintf(out, "BREAKER ");
2076 } else {
2077 out += sprintf(out, "UNKNOWN UNKNOWN ");
2078 }
2079 if (fl->fl_type & LOCK_MAND) {
2080 out += sprintf(out, "%s ",
2081 (fl->fl_type & LOCK_READ)
2082 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2083 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2084 } else {
2085 out += sprintf(out, "%s ",
2086 (fl->fl_type & F_INPROGRESS)
2087 ? (fl->fl_type & F_UNLCK) ? "UNLCK" : "READ "
2088 : (fl->fl_type & F_WRLCK) ? "WRITE" : "READ ");
2089 }
2090 if (inode) {
2091#ifdef WE_CAN_BREAK_LSLK_NOW
2092 out += sprintf(out, "%d %s:%ld ", fl->fl_pid,
2093 inode->i_sb->s_id, inode->i_ino);
2094#else
2095 /* userspace relies on this representation of dev_t ;-( */
2096 out += sprintf(out, "%d %02x:%02x:%ld ", fl->fl_pid,
2097 MAJOR(inode->i_sb->s_dev),
2098 MINOR(inode->i_sb->s_dev), inode->i_ino);
2099#endif
2100 } else {
2101 out += sprintf(out, "%d <none>:0 ", fl->fl_pid);
2102 }
2103 if (IS_POSIX(fl)) {
2104 if (fl->fl_end == OFFSET_MAX)
2105 out += sprintf(out, "%Ld EOF\n", fl->fl_start);
2106 else
2107 out += sprintf(out, "%Ld %Ld\n", fl->fl_start,
2108 fl->fl_end);
2109 } else {
2110 out += sprintf(out, "0 EOF\n");
2111 }
2112}
2113
2114static void move_lock_status(char **p, off_t* pos, off_t offset)
2115{
2116 int len;
2117 len = strlen(*p);
2118 if(*pos >= offset) {
2119 /* the complete line is valid */
2120 *p += len;
2121 *pos += len;
2122 return;
2123 }
2124 if(*pos+len > offset) {
2125 /* use the second part of the line */
2126 int i = offset-*pos;
2127 memmove(*p,*p+i,len-i);
2128 *p += len-i;
2129 *pos += len;
2130 return;
2131 }
2132 /* discard the complete line */
2133 *pos += len;
2134}
2135
2136/**
2137 * get_locks_status - reports lock usage in /proc/locks
2138 * @buffer: address in userspace to write into
2139 * @start: ?
2140 * @offset: how far we are through the buffer
2141 * @length: how much to read
2142 */
2143
2144int get_locks_status(char *buffer, char **start, off_t offset, int length)
2145{
2146 struct list_head *tmp;
2147 char *q = buffer;
2148 off_t pos = 0;
2149 int i = 0;
2150
2151 lock_kernel();
2152 list_for_each(tmp, &file_lock_list) {
2153 struct list_head *btmp;
2154 struct file_lock *fl = list_entry(tmp, struct file_lock, fl_link);
2155 lock_get_status(q, fl, ++i, "");
2156 move_lock_status(&q, &pos, offset);
2157
2158 if(pos >= offset+length)
2159 goto done;
2160
2161 list_for_each(btmp, &fl->fl_block) {
2162 struct file_lock *bfl = list_entry(btmp,
2163 struct file_lock, fl_block);
2164 lock_get_status(q, bfl, i, " ->");
2165 move_lock_status(&q, &pos, offset);
2166
2167 if(pos >= offset+length)
2168 goto done;
2169 }
2170 }
2171done:
2172 unlock_kernel();
2173 *start = buffer;
2174 if(q-buffer < length)
2175 return (q-buffer);
2176 return length;
2177}
2178
2179/**
2180 * lock_may_read - checks that the region is free of locks
2181 * @inode: the inode that is being read
2182 * @start: the first byte to read
2183 * @len: the number of bytes to read
2184 *
2185 * Emulates Windows locking requirements. Whole-file
2186 * mandatory locks (share modes) can prohibit a read and
2187 * byte-range POSIX locks can prohibit a read if they overlap.
2188 *
2189 * N.B. this function is only ever called
2190 * from knfsd and ownership of locks is never checked.
2191 */
2192int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2193{
2194 struct file_lock *fl;
2195 int result = 1;
2196 lock_kernel();
2197 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2198 if (IS_POSIX(fl)) {
2199 if (fl->fl_type == F_RDLCK)
2200 continue;
2201 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2202 continue;
2203 } else if (IS_FLOCK(fl)) {
2204 if (!(fl->fl_type & LOCK_MAND))
2205 continue;
2206 if (fl->fl_type & LOCK_READ)
2207 continue;
2208 } else
2209 continue;
2210 result = 0;
2211 break;
2212 }
2213 unlock_kernel();
2214 return result;
2215}
2216
2217EXPORT_SYMBOL(lock_may_read);
2218
2219/**
2220 * lock_may_write - checks that the region is free of locks
2221 * @inode: the inode that is being written
2222 * @start: the first byte to write
2223 * @len: the number of bytes to write
2224 *
2225 * Emulates Windows locking requirements. Whole-file
2226 * mandatory locks (share modes) can prohibit a write and
2227 * byte-range POSIX locks can prohibit a write if they overlap.
2228 *
2229 * N.B. this function is only ever called
2230 * from knfsd and ownership of locks is never checked.
2231 */
2232int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2233{
2234 struct file_lock *fl;
2235 int result = 1;
2236 lock_kernel();
2237 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2238 if (IS_POSIX(fl)) {
2239 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2240 continue;
2241 } else if (IS_FLOCK(fl)) {
2242 if (!(fl->fl_type & LOCK_MAND))
2243 continue;
2244 if (fl->fl_type & LOCK_WRITE)
2245 continue;
2246 } else
2247 continue;
2248 result = 0;
2249 break;
2250 }
2251 unlock_kernel();
2252 return result;
2253}
2254
2255EXPORT_SYMBOL(lock_may_write);
2256
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257static int __init filelock_init(void)
2258{
2259 filelock_cache = kmem_cache_create("file_lock_cache",
2260 sizeof(struct file_lock), 0, SLAB_PANIC,
2261 init_once, NULL);
2262 return 0;
2263}
2264
2265core_initcall(filelock_init);