locks: clean up lease_alloc()
[linux-2.6-block.git] / fs / locks.c
CommitLineData
1da177e4
LT
1/*
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>
4fb3a538 127#include <linux/rcupdate.h>
1da177e4
LT
128
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
26bcbf96 142static LIST_HEAD(file_lock_list);
1da177e4
LT
143static LIST_HEAD(blocked_list);
144
e18b890b 145static struct kmem_cache *filelock_cache __read_mostly;
1da177e4
LT
146
147/* Allocate an empty lock structure. */
148static struct file_lock *locks_alloc_lock(void)
149{
e94b1766 150 return kmem_cache_alloc(filelock_cache, GFP_KERNEL);
1da177e4
LT
151}
152
47831f35
TM
153static 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
1da177e4 168/* Free a lock which is not in use. */
33443c42 169static void locks_free_lock(struct file_lock *fl)
1da177e4 170{
5ce29646
MS
171 BUG_ON(waitqueue_active(&fl->fl_wait));
172 BUG_ON(!list_empty(&fl->fl_block));
173 BUG_ON(!list_empty(&fl->fl_link));
1da177e4 174
47831f35 175 locks_release_private(fl);
1da177e4
LT
176 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 */
e18b890b 202static void init_once(void *foo, struct kmem_cache *cache, unsigned long flags)
1da177e4
LT
203{
204 struct file_lock *lock = (struct file_lock *) foo;
205
1da177e4
LT
206 locks_init_lock(lock);
207}
208
47831f35
TM
209static 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
1da177e4
LT
223/*
224 * Initialize a new lock from an existing file_lock structure.
225 */
0996905f 226static void __locks_copy_lock(struct file_lock *new, const struct file_lock *fl)
1da177e4
LT
227{
228 new->fl_owner = fl->fl_owner;
229 new->fl_pid = fl->fl_pid;
0996905f 230 new->fl_file = NULL;
1da177e4
LT
231 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;
0996905f
TM
235 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;
1da177e4
LT
245 new->fl_ops = fl->fl_ops;
246 new->fl_lmops = fl->fl_lmops;
47831f35
TM
247
248 locks_copy_private(new, fl);
1da177e4
LT
249}
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) {
f5579f8c 313 case SEEK_SET:
1da177e4
LT
314 start = 0;
315 break;
f5579f8c 316 case SEEK_CUR:
1da177e4
LT
317 start = filp->f_pos;
318 break;
f5579f8c 319 case SEEK_END:
0f7fc9e4 320 start = i_size_read(filp->f_path.dentry->d_inode);
1da177e4
LT
321 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;
4c780a46
TM
329 if (start < 0)
330 return -EINVAL;
331 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) {
1da177e4 336 end = start - 1;
4c780a46 337 fl->fl_end = end;
1da177e4 338 start += l->l_len;
4c780a46
TM
339 if (start < 0)
340 return -EINVAL;
1da177e4 341 }
1da177e4 342 fl->fl_start = start; /* we record the absolute position */
4c780a46
TM
343 if (fl->fl_end < fl->fl_start)
344 return -EOVERFLOW;
1da177e4
LT
345
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) {
f5579f8c 363 case SEEK_SET:
1da177e4
LT
364 start = 0;
365 break;
f5579f8c 366 case SEEK_CUR:
1da177e4
LT
367 start = filp->f_pos;
368 break;
f5579f8c 369 case SEEK_END:
0f7fc9e4 370 start = i_size_read(filp->f_path.dentry->d_inode);
1da177e4
LT
371 break;
372 default:
373 return -EINVAL;
374 }
375
4c780a46
TM
376 start += l->l_start;
377 if (start < 0)
1da177e4 378 return -EINVAL;
4c780a46
TM
379 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 }
1da177e4 388 fl->fl_start = start; /* we record the absolute position */
4c780a46
TM
389 if (fl->fl_end < fl->fl_start)
390 return -EOVERFLOW;
1da177e4
LT
391
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
75c96f85 428static int lease_mylease_callback(struct file_lock *fl, struct file_lock *try)
1da177e4
LT
429{
430 return fl->fl_file == try->fl_file;
431}
432
75c96f85 433static struct lock_manager_operations lease_manager_ops = {
1da177e4
LT
434 .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 {
75dff55a
TM
445 if (assign_type(fl, type) != 0)
446 return -EINVAL;
447
1da177e4
LT
448 fl->fl_owner = current->files;
449 fl->fl_pid = current->tgid;
450
451 fl->fl_file = filp;
452 fl->fl_flags = FL_LEASE;
1da177e4
LT
453 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 */
e32b8ee2 461static struct file_lock *lease_alloc(struct file *filp, int type)
1da177e4
LT
462{
463 struct file_lock *fl = locks_alloc_lock();
75dff55a 464 int error = -ENOMEM;
1da177e4
LT
465
466 if (fl == NULL)
e32b8ee2 467 return ERR_PTR(error);
1da177e4
LT
468
469 error = lease_init(filp, type, fl);
75dff55a
TM
470 if (error) {
471 locks_free_lock(fl);
e32b8ee2 472 return ERR_PTR(error);
75dff55a 473 }
e32b8ee2 474 return fl;
1da177e4
LT
475}
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 */
33443c42 488static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
1da177e4
LT
489{
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 */
33443c42 499static void __locks_delete_block(struct file_lock *waiter)
1da177e4
LT
500{
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{
6dc0fe8f 523 BUG_ON(!list_empty(&waiter->fl_block));
1da177e4
LT
524 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
8dc7c311 662int
9d6a8c5c 663posix_test_lock(struct file *filp, struct file_lock *fl)
1da177e4
LT
664{
665 struct file_lock *cfl;
666
667 lock_kernel();
0f7fc9e4 668 for (cfl = filp->f_path.dentry->d_inode->i_flock; cfl; cfl = cfl->fl_next) {
1da177e4
LT
669 if (!IS_POSIX(cfl))
670 continue;
671 if (posix_locks_conflict(cfl, fl))
672 break;
673 }
8dc7c311 674 if (cfl) {
9d6a8c5c 675 __locks_copy_lock(fl, cfl);
8dc7c311
AA
676 unlock_kernel();
677 return 1;
129a84de
BF
678 } else
679 fl->fl_type = F_UNLCK;
1da177e4 680 unlock_kernel();
8dc7c311 681 return 0;
1da177e4
LT
682}
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 */
b0904e14 700static int posix_locks_deadlock(struct file_lock *caller_fl,
1da177e4
LT
701 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
1da177e4
LT
719/* 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.
f475ae95
TM
722 *
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.
1da177e4 726 */
993dfa87 727static int flock_lock_file(struct file *filp, struct file_lock *request)
1da177e4 728{
993dfa87 729 struct file_lock *new_fl = NULL;
1da177e4 730 struct file_lock **before;
0f7fc9e4 731 struct inode * inode = filp->f_path.dentry->d_inode;
1da177e4
LT
732 int error = 0;
733 int found = 0;
734
735 lock_kernel();
f07f18dd
TM
736 if (request->fl_flags & FL_ACCESS)
737 goto find_conflict;
1da177e4
LT
738 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;
993dfa87 746 if (request->fl_type == fl->fl_type)
1da177e4
LT
747 goto out;
748 found = 1;
749 locks_delete_lock(before);
750 break;
751 }
1da177e4 752
f475ae95
TM
753 if (request->fl_type == F_UNLCK) {
754 if ((request->fl_flags & FL_EXISTS) && !found)
755 error = -ENOENT;
993dfa87 756 goto out;
f475ae95 757 }
1da177e4 758
9cedc194 759 error = -ENOMEM;
993dfa87
TM
760 new_fl = locks_alloc_lock();
761 if (new_fl == NULL)
762 goto out;
1da177e4
LT
763 /*
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
f07f18dd 770find_conflict:
1da177e4
LT
771 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;
993dfa87 777 if (!flock_locks_conflict(request, fl))
1da177e4
LT
778 continue;
779 error = -EAGAIN;
993dfa87
TM
780 if (request->fl_flags & FL_SLEEP)
781 locks_insert_block(fl, request);
1da177e4
LT
782 goto out;
783 }
f07f18dd
TM
784 if (request->fl_flags & FL_ACCESS)
785 goto out;
993dfa87 786 locks_copy_lock(new_fl, request);
1da177e4 787 locks_insert_lock(&inode->i_flock, new_fl);
993dfa87 788 new_fl = NULL;
9cedc194 789 error = 0;
1da177e4
LT
790
791out:
792 unlock_kernel();
993dfa87
TM
793 if (new_fl)
794 locks_free_lock(new_fl);
1da177e4
LT
795 return error;
796}
797
150b3934 798static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
1da177e4
LT
799{
800 struct file_lock *fl;
39005d02
MS
801 struct file_lock *new_fl = NULL;
802 struct file_lock *new_fl2 = NULL;
1da177e4
LT
803 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.
39005d02
MS
811 *
812 * In some cases we can be sure, that no new locks will be needed
1da177e4 813 */
39005d02
MS
814 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 }
1da177e4
LT
820
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;
5842add2
AA
829 if (conflock)
830 locks_copy_lock(conflock, fl);
1da177e4
LT
831 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
1da177e4 848 /*
1da177e4
LT
849 * 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) {
449231d6
OK
865 /* 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 */
1da177e4
LT
869 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 */
449231d6 874 if (fl->fl_start - 1 > request->fl_end)
1da177e4
LT
875 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;
47831f35
TM
933 locks_release_private(fl);
934 locks_copy_private(fl, request);
1da177e4
LT
935 request = fl;
936 added = 1;
937 }
938 }
939 /* Go on to next lock.
940 */
941 next_lock:
942 before = &fl->fl_next;
943 }
944
0d9a490a
MS
945 /*
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
1da177e4
LT
955 error = 0;
956 if (!added) {
f475ae95
TM
957 if (request->fl_type == F_UNLCK) {
958 if (request->fl_flags & FL_EXISTS)
959 error = -ENOENT;
1da177e4 960 goto out;
f475ae95 961 }
0d9a490a
MS
962
963 if (!new_fl) {
964 error = -ENOLCK;
965 goto out;
966 }
1da177e4
LT
967 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
150b3934 1004 * @conflock: Place to return a copy of the conflicting lock, if found.
1da177e4
LT
1005 *
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
f475ae95
TM
1009 *
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.
1da177e4 1013 */
150b3934 1014int posix_lock_file(struct file *filp, struct file_lock *fl,
5842add2
AA
1015 struct file_lock *conflock)
1016{
150b3934 1017 return __posix_lock_file(filp->f_path.dentry->d_inode, fl, conflock);
1da177e4 1018}
150b3934 1019EXPORT_SYMBOL(posix_lock_file);
1da177e4
LT
1020
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 (;;) {
150b3934 1035 error = posix_lock_file(filp, fl, NULL);
1da177e4
LT
1036 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 (;;) {
150b3934 1107 error = __posix_lock_file(inode, &fl, NULL);
1da177e4
LT
1108 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 }
1da177e4
LT
1159 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 *
87250dd2 1170 * 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
1da177e4
LT
1173 * 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;
1da177e4
LT
1180 unsigned long break_time;
1181 int i_have_this_lease = 0;
1182
e32b8ee2 1183 new_fl = lease_alloc(NULL, mode & FMODE_WRITE ? F_WRLCK : F_RDLCK);
1da177e4
LT
1184
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
e32b8ee2
BF
1211 if (IS_ERR(new_fl) && !i_have_this_lease
1212 && ((mode & O_NONBLOCK) == 0)) {
1213 error = PTR_ERR(new_fl);
1da177e4
LT
1214 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();
e32b8ee2 1260 if (!IS_ERR(new_fl))
1da177e4
LT
1261 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();
0f7fc9e4
JJS
1316 time_out_leases(filp->f_path.dentry->d_inode);
1317 for (fl = filp->f_path.dentry->d_inode->i_flock; fl && IS_LEASE(fl);
1da177e4
LT
1318 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/**
1329 * __setlease - sets a lease on an open file
1330 * @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 */
75c96f85 1339static int __setlease(struct file *filp, long arg, struct file_lock **flp)
1da177e4 1340{
7eaae282 1341 struct file_lock *fl, **before, **my_before = NULL, *lease;
0f7fc9e4 1342 struct dentry *dentry = filp->f_path.dentry;
1da177e4
LT
1343 struct inode *inode = dentry->d_inode;
1344 int error, rdlease_count = 0, wrlease_count = 0;
1345
1346 time_out_leases(inode);
1347
d2ab0b0c 1348 BUG_ON(!(*flp)->fl_lmops->fl_break);
1da177e4 1349
7eaae282
KZ
1350 lease = *flp;
1351
1da177e4
LT
1352 error = -EAGAIN;
1353 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1354 goto out;
1355 if ((arg == F_WRLCK)
1356 && ((atomic_read(&dentry->d_count) > 1)
1357 || (atomic_read(&inode->i_count) > 1)))
1358 goto out;
1359
1360 /*
1361 * At this point, we know that if there is an exclusive
1362 * lease on this file, then we hold it on this filp
1363 * (otherwise our open of this file would have blocked).
1364 * And if we are trying to acquire an exclusive lease,
1365 * then the file is not open by anyone (including us)
1366 * except for this filp.
1367 */
1368 for (before = &inode->i_flock;
1369 ((fl = *before) != NULL) && IS_LEASE(fl);
1370 before = &fl->fl_next) {
1371 if (lease->fl_lmops->fl_mylease(fl, lease))
1372 my_before = before;
1373 else if (fl->fl_type == (F_INPROGRESS | F_UNLCK))
1374 /*
1375 * Someone is in the process of opening this
1376 * file for writing so we may not take an
1377 * exclusive lease on it.
1378 */
1379 wrlease_count++;
1380 else
1381 rdlease_count++;
1382 }
1383
1384 if ((arg == F_RDLCK && (wrlease_count > 0)) ||
1385 (arg == F_WRLCK && ((rdlease_count + wrlease_count) > 0)))
1386 goto out;
1387
1388 if (my_before != NULL) {
75dff55a 1389 *flp = *my_before;
1da177e4
LT
1390 error = lease->fl_lmops->fl_change(my_before, arg);
1391 goto out;
1392 }
1393
1394 error = 0;
1395 if (arg == F_UNLCK)
1396 goto out;
1397
1398 error = -EINVAL;
1399 if (!leases_enable)
1400 goto out;
1401
74361cb6
TM
1402 error = -ENOMEM;
1403 fl = locks_alloc_lock();
1404 if (fl == NULL)
1da177e4
LT
1405 goto out;
1406
1407 locks_copy_lock(fl, lease);
1408
1409 locks_insert_lock(before, fl);
1410
1411 *flp = fl;
74361cb6 1412 error = 0;
1da177e4
LT
1413out:
1414 return error;
1415}
1416
1417 /**
1418 * setlease - sets a lease on an open file
1419 * @filp: file pointer
1420 * @arg: type of lease to obtain
1421 * @lease: file_lock to use
1422 *
1423 * Call this to establish a lease on the file.
1424 * The fl_lmops fl_break function is required by break_lease
1425 */
1426
1427int setlease(struct file *filp, long arg, struct file_lock **lease)
1428{
0f7fc9e4 1429 struct dentry *dentry = filp->f_path.dentry;
1da177e4
LT
1430 struct inode *inode = dentry->d_inode;
1431 int error;
1432
1433 if ((current->fsuid != inode->i_uid) && !capable(CAP_LEASE))
1434 return -EACCES;
1435 if (!S_ISREG(inode->i_mode))
1436 return -EINVAL;
1437 error = security_file_lock(filp, arg);
1438 if (error)
1439 return error;
1440
1441 lock_kernel();
1442 error = __setlease(filp, arg, lease);
1443 unlock_kernel();
1444
1445 return error;
1446}
1447
1448EXPORT_SYMBOL(setlease);
1449
1450/**
1451 * fcntl_setlease - sets a lease on an open file
1452 * @fd: open file descriptor
1453 * @filp: file pointer
1454 * @arg: type of lease to obtain
1455 *
1456 * Call this fcntl to establish a lease on the file.
1457 * Note that you also need to call %F_SETSIG to
1458 * receive a signal when the lease is broken.
1459 */
1460int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1461{
1462 struct file_lock fl, *flp = &fl;
0f7fc9e4 1463 struct dentry *dentry = filp->f_path.dentry;
1da177e4
LT
1464 struct inode *inode = dentry->d_inode;
1465 int error;
1466
1467 if ((current->fsuid != inode->i_uid) && !capable(CAP_LEASE))
1468 return -EACCES;
1469 if (!S_ISREG(inode->i_mode))
1470 return -EINVAL;
1471 error = security_file_lock(filp, arg);
1472 if (error)
1473 return error;
1474
1475 locks_init_lock(&fl);
1476 error = lease_init(filp, arg, &fl);
1477 if (error)
1478 return error;
1479
1480 lock_kernel();
1481
1482 error = __setlease(filp, arg, &flp);
dc15ae14 1483 if (error || arg == F_UNLCK)
1da177e4
LT
1484 goto out_unlock;
1485
1486 error = fasync_helper(fd, filp, 1, &flp->fl_fasync);
1487 if (error < 0) {
1488 /* remove lease just inserted by __setlease */
1489 flp->fl_type = F_UNLCK | F_INPROGRESS;
1490 flp->fl_break_time = jiffies- 10;
1491 time_out_leases(inode);
1492 goto out_unlock;
1493 }
1494
609d7fa9 1495 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
1da177e4
LT
1496out_unlock:
1497 unlock_kernel();
1498 return error;
1499}
1500
1501/**
1502 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1503 * @filp: The file to apply the lock to
1504 * @fl: The lock to be applied
1505 *
1506 * Add a FLOCK style lock to a file.
1507 */
1508int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1509{
1510 int error;
1511 might_sleep();
1512 for (;;) {
1513 error = flock_lock_file(filp, fl);
1514 if ((error != -EAGAIN) || !(fl->fl_flags & FL_SLEEP))
1515 break;
1516 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1517 if (!error)
1518 continue;
1519
1520 locks_delete_block(fl);
1521 break;
1522 }
1523 return error;
1524}
1525
1526EXPORT_SYMBOL(flock_lock_file_wait);
1527
1528/**
1529 * sys_flock: - flock() system call.
1530 * @fd: the file descriptor to lock.
1531 * @cmd: the type of lock to apply.
1532 *
1533 * Apply a %FL_FLOCK style lock to an open file descriptor.
1534 * The @cmd can be one of
1535 *
1536 * %LOCK_SH -- a shared lock.
1537 *
1538 * %LOCK_EX -- an exclusive lock.
1539 *
1540 * %LOCK_UN -- remove an existing lock.
1541 *
1542 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1543 *
1544 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1545 * processes read and write access respectively.
1546 */
1547asmlinkage long sys_flock(unsigned int fd, unsigned int cmd)
1548{
1549 struct file *filp;
1550 struct file_lock *lock;
1551 int can_sleep, unlock;
1552 int error;
1553
1554 error = -EBADF;
1555 filp = fget(fd);
1556 if (!filp)
1557 goto out;
1558
1559 can_sleep = !(cmd & LOCK_NB);
1560 cmd &= ~LOCK_NB;
1561 unlock = (cmd == LOCK_UN);
1562
1563 if (!unlock && !(cmd & LOCK_MAND) && !(filp->f_mode & 3))
1564 goto out_putf;
1565
1566 error = flock_make_lock(filp, &lock, cmd);
1567 if (error)
1568 goto out_putf;
1569 if (can_sleep)
1570 lock->fl_flags |= FL_SLEEP;
1571
1572 error = security_file_lock(filp, cmd);
1573 if (error)
1574 goto out_free;
1575
1576 if (filp->f_op && filp->f_op->flock)
1577 error = filp->f_op->flock(filp,
1578 (can_sleep) ? F_SETLKW : F_SETLK,
1579 lock);
1580 else
1581 error = flock_lock_file_wait(filp, lock);
1582
1583 out_free:
993dfa87 1584 locks_free_lock(lock);
1da177e4
LT
1585
1586 out_putf:
1587 fput(filp);
1588 out:
1589 return error;
1590}
1591
3ee17abd
BF
1592/**
1593 * vfs_test_lock - test file byte range lock
1594 * @filp: The file to test lock for
1595 * @fl: The lock to test
1596 * @conf: Place to return a copy of the conflicting lock, if found
1597 *
1598 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1599 * setting conf->fl_type to something other than F_UNLCK.
1600 */
1601int vfs_test_lock(struct file *filp, struct file_lock *fl)
1602{
1603 if (filp->f_op && filp->f_op->lock)
1604 return filp->f_op->lock(filp, F_GETLK, fl);
1605 posix_test_lock(filp, fl);
1606 return 0;
1607}
1608EXPORT_SYMBOL_GPL(vfs_test_lock);
1609
c2fa1b8a
BF
1610static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1611{
1612 flock->l_pid = fl->fl_pid;
1613#if BITS_PER_LONG == 32
1614 /*
1615 * Make sure we can represent the posix lock via
1616 * legacy 32bit flock.
1617 */
1618 if (fl->fl_start > OFFT_OFFSET_MAX)
1619 return -EOVERFLOW;
1620 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1621 return -EOVERFLOW;
1622#endif
1623 flock->l_start = fl->fl_start;
1624 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1625 fl->fl_end - fl->fl_start + 1;
1626 flock->l_whence = 0;
129a84de 1627 flock->l_type = fl->fl_type;
c2fa1b8a
BF
1628 return 0;
1629}
1630
1631#if BITS_PER_LONG == 32
1632static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1633{
1634 flock->l_pid = fl->fl_pid;
1635 flock->l_start = fl->fl_start;
1636 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1637 fl->fl_end - fl->fl_start + 1;
1638 flock->l_whence = 0;
1639 flock->l_type = fl->fl_type;
1640}
1641#endif
1642
1da177e4
LT
1643/* Report the first existing lock that would conflict with l.
1644 * This implements the F_GETLK command of fcntl().
1645 */
1646int fcntl_getlk(struct file *filp, struct flock __user *l)
1647{
9d6a8c5c 1648 struct file_lock file_lock;
1da177e4
LT
1649 struct flock flock;
1650 int error;
1651
1652 error = -EFAULT;
1653 if (copy_from_user(&flock, l, sizeof(flock)))
1654 goto out;
1655 error = -EINVAL;
1656 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1657 goto out;
1658
1659 error = flock_to_posix_lock(filp, &file_lock, &flock);
1660 if (error)
1661 goto out;
1662
3ee17abd
BF
1663 error = vfs_test_lock(filp, &file_lock);
1664 if (error)
1665 goto out;
1da177e4 1666
9d6a8c5c
ME
1667 flock.l_type = file_lock.fl_type;
1668 if (file_lock.fl_type != F_UNLCK) {
1669 error = posix_lock_to_flock(&flock, &file_lock);
c2fa1b8a 1670 if (error)
1da177e4 1671 goto out;
1da177e4
LT
1672 }
1673 error = -EFAULT;
1674 if (!copy_to_user(l, &flock, sizeof(flock)))
1675 error = 0;
1676out:
1677 return error;
1678}
1679
7723ec97
ME
1680/**
1681 * vfs_lock_file - file byte range lock
1682 * @filp: The file to apply the lock to
1683 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1684 * @fl: The lock to be applied
150b3934
ME
1685 * @conf: Place to return a copy of the conflicting lock, if found.
1686 *
1687 * A caller that doesn't care about the conflicting lock may pass NULL
1688 * as the final argument.
1689 *
1690 * If the filesystem defines a private ->lock() method, then @conf will
1691 * be left unchanged; so a caller that cares should initialize it to
1692 * some acceptable default.
2beb6614
ME
1693 *
1694 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1695 * locks, the ->lock() interface may return asynchronously, before the lock has
1696 * been granted or denied by the underlying filesystem, if (and only if)
1697 * fl_grant is set. Callers expecting ->lock() to return asynchronously
1698 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1699 * the request is for a blocking lock. When ->lock() does return asynchronously,
1700 * it must return -EINPROGRESS, and call ->fl_grant() when the lock
1701 * request completes.
1702 * If the request is for non-blocking lock the file system should return
1703 * -EINPROGRESS then try to get the lock and call the callback routine with
1704 * the result. If the request timed out the callback routine will return a
1705 * nonzero return code and the file system should release the lock. The file
1706 * system is also responsible to keep a corresponding posix lock when it
1707 * grants a lock so the VFS can find out which locks are locally held and do
1708 * the correct lock cleanup when required.
1709 * The underlying filesystem must not drop the kernel lock or call
1710 * ->fl_grant() before returning to the caller with a -EINPROGRESS
1711 * return code.
7723ec97 1712 */
150b3934 1713int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
7723ec97
ME
1714{
1715 if (filp->f_op && filp->f_op->lock)
1716 return filp->f_op->lock(filp, cmd, fl);
1717 else
150b3934 1718 return posix_lock_file(filp, fl, conf);
7723ec97
ME
1719}
1720EXPORT_SYMBOL_GPL(vfs_lock_file);
1721
1da177e4
LT
1722/* Apply the lock described by l to an open file descriptor.
1723 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1724 */
c293621b
PS
1725int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
1726 struct flock __user *l)
1da177e4
LT
1727{
1728 struct file_lock *file_lock = locks_alloc_lock();
1729 struct flock flock;
1730 struct inode *inode;
1731 int error;
1732
1733 if (file_lock == NULL)
1734 return -ENOLCK;
1735
1736 /*
1737 * This might block, so we do it before checking the inode.
1738 */
1739 error = -EFAULT;
1740 if (copy_from_user(&flock, l, sizeof(flock)))
1741 goto out;
1742
0f7fc9e4 1743 inode = filp->f_path.dentry->d_inode;
1da177e4
LT
1744
1745 /* Don't allow mandatory locks on files that may be memory mapped
1746 * and shared.
1747 */
1748 if (IS_MANDLOCK(inode) &&
1749 (inode->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID &&
1750 mapping_writably_mapped(filp->f_mapping)) {
1751 error = -EAGAIN;
1752 goto out;
1753 }
1754
c293621b 1755again:
1da177e4
LT
1756 error = flock_to_posix_lock(filp, file_lock, &flock);
1757 if (error)
1758 goto out;
1759 if (cmd == F_SETLKW) {
1760 file_lock->fl_flags |= FL_SLEEP;
1761 }
1762
1763 error = -EBADF;
1764 switch (flock.l_type) {
1765 case F_RDLCK:
1766 if (!(filp->f_mode & FMODE_READ))
1767 goto out;
1768 break;
1769 case F_WRLCK:
1770 if (!(filp->f_mode & FMODE_WRITE))
1771 goto out;
1772 break;
1773 case F_UNLCK:
1774 break;
1775 default:
1776 error = -EINVAL;
1777 goto out;
1778 }
1779
1780 error = security_file_lock(filp, file_lock->fl_type);
1781 if (error)
1782 goto out;
1783
7723ec97 1784 for (;;) {
150b3934 1785 error = vfs_lock_file(filp, cmd, file_lock, NULL);
7723ec97 1786 if (error != -EAGAIN || cmd == F_SETLK)
1da177e4 1787 break;
7723ec97
ME
1788 error = wait_event_interruptible(file_lock->fl_wait,
1789 !file_lock->fl_next);
1790 if (!error)
1791 continue;
1792
1793 locks_delete_block(file_lock);
1794 break;
c293621b 1795 }
1da177e4 1796
c293621b
PS
1797 /*
1798 * Attempt to detect a close/fcntl race and recover by
1799 * releasing the lock that was just acquired.
1800 */
1801 if (!error && fcheck(fd) != filp && flock.l_type != F_UNLCK) {
1802 flock.l_type = F_UNLCK;
1803 goto again;
1da177e4
LT
1804 }
1805
c293621b 1806out:
1da177e4
LT
1807 locks_free_lock(file_lock);
1808 return error;
1809}
1810
1811#if BITS_PER_LONG == 32
1812/* Report the first existing lock that would conflict with l.
1813 * This implements the F_GETLK command of fcntl().
1814 */
1815int fcntl_getlk64(struct file *filp, struct flock64 __user *l)
1816{
9d6a8c5c 1817 struct file_lock file_lock;
1da177e4
LT
1818 struct flock64 flock;
1819 int error;
1820
1821 error = -EFAULT;
1822 if (copy_from_user(&flock, l, sizeof(flock)))
1823 goto out;
1824 error = -EINVAL;
1825 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1826 goto out;
1827
1828 error = flock64_to_posix_lock(filp, &file_lock, &flock);
1829 if (error)
1830 goto out;
1831
3ee17abd
BF
1832 error = vfs_test_lock(filp, &file_lock);
1833 if (error)
1834 goto out;
1835
9d6a8c5c
ME
1836 flock.l_type = file_lock.fl_type;
1837 if (file_lock.fl_type != F_UNLCK)
1838 posix_lock_to_flock64(&flock, &file_lock);
1839
1da177e4
LT
1840 error = -EFAULT;
1841 if (!copy_to_user(l, &flock, sizeof(flock)))
1842 error = 0;
1843
1844out:
1845 return error;
1846}
1847
1848/* Apply the lock described by l to an open file descriptor.
1849 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1850 */
c293621b
PS
1851int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
1852 struct flock64 __user *l)
1da177e4
LT
1853{
1854 struct file_lock *file_lock = locks_alloc_lock();
1855 struct flock64 flock;
1856 struct inode *inode;
1857 int error;
1858
1859 if (file_lock == NULL)
1860 return -ENOLCK;
1861
1862 /*
1863 * This might block, so we do it before checking the inode.
1864 */
1865 error = -EFAULT;
1866 if (copy_from_user(&flock, l, sizeof(flock)))
1867 goto out;
1868
0f7fc9e4 1869 inode = filp->f_path.dentry->d_inode;
1da177e4
LT
1870
1871 /* Don't allow mandatory locks on files that may be memory mapped
1872 * and shared.
1873 */
1874 if (IS_MANDLOCK(inode) &&
1875 (inode->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID &&
1876 mapping_writably_mapped(filp->f_mapping)) {
1877 error = -EAGAIN;
1878 goto out;
1879 }
1880
c293621b 1881again:
1da177e4
LT
1882 error = flock64_to_posix_lock(filp, file_lock, &flock);
1883 if (error)
1884 goto out;
1885 if (cmd == F_SETLKW64) {
1886 file_lock->fl_flags |= FL_SLEEP;
1887 }
1888
1889 error = -EBADF;
1890 switch (flock.l_type) {
1891 case F_RDLCK:
1892 if (!(filp->f_mode & FMODE_READ))
1893 goto out;
1894 break;
1895 case F_WRLCK:
1896 if (!(filp->f_mode & FMODE_WRITE))
1897 goto out;
1898 break;
1899 case F_UNLCK:
1900 break;
1901 default:
1902 error = -EINVAL;
1903 goto out;
1904 }
1905
1906 error = security_file_lock(filp, file_lock->fl_type);
1907 if (error)
1908 goto out;
1909
7723ec97 1910 for (;;) {
150b3934 1911 error = vfs_lock_file(filp, cmd, file_lock, NULL);
7723ec97 1912 if (error != -EAGAIN || cmd == F_SETLK64)
1da177e4 1913 break;
7723ec97
ME
1914 error = wait_event_interruptible(file_lock->fl_wait,
1915 !file_lock->fl_next);
1916 if (!error)
1917 continue;
1918
1919 locks_delete_block(file_lock);
1920 break;
c293621b 1921 }
1da177e4 1922
c293621b
PS
1923 /*
1924 * Attempt to detect a close/fcntl race and recover by
1925 * releasing the lock that was just acquired.
1926 */
1927 if (!error && fcheck(fd) != filp && flock.l_type != F_UNLCK) {
1928 flock.l_type = F_UNLCK;
1929 goto again;
1da177e4
LT
1930 }
1931
1932out:
1933 locks_free_lock(file_lock);
1934 return error;
1935}
1936#endif /* BITS_PER_LONG == 32 */
1937
1938/*
1939 * This function is called when the file is being removed
1940 * from the task's fd array. POSIX locks belonging to this task
1941 * are deleted at this time.
1942 */
1943void locks_remove_posix(struct file *filp, fl_owner_t owner)
1944{
ff7b86b8 1945 struct file_lock lock;
1da177e4
LT
1946
1947 /*
1948 * If there are no locks held on this file, we don't need to call
1949 * posix_lock_file(). Another process could be setting a lock on this
1950 * file at the same time, but we wouldn't remove that lock anyway.
1951 */
0f7fc9e4 1952 if (!filp->f_path.dentry->d_inode->i_flock)
1da177e4
LT
1953 return;
1954
1955 lock.fl_type = F_UNLCK;
75e1fcc0 1956 lock.fl_flags = FL_POSIX | FL_CLOSE;
1da177e4
LT
1957 lock.fl_start = 0;
1958 lock.fl_end = OFFSET_MAX;
1959 lock.fl_owner = owner;
1960 lock.fl_pid = current->tgid;
1961 lock.fl_file = filp;
1962 lock.fl_ops = NULL;
1963 lock.fl_lmops = NULL;
1964
150b3934 1965 vfs_lock_file(filp, F_SETLK, &lock, NULL);
1da177e4 1966
1da177e4
LT
1967 if (lock.fl_ops && lock.fl_ops->fl_release_private)
1968 lock.fl_ops->fl_release_private(&lock);
1969}
1970
1971EXPORT_SYMBOL(locks_remove_posix);
1972
1973/*
1974 * This function is called on the last close of an open file.
1975 */
1976void locks_remove_flock(struct file *filp)
1977{
0f7fc9e4 1978 struct inode * inode = filp->f_path.dentry->d_inode;
1da177e4
LT
1979 struct file_lock *fl;
1980 struct file_lock **before;
1981
1982 if (!inode->i_flock)
1983 return;
1984
1985 if (filp->f_op && filp->f_op->flock) {
1986 struct file_lock fl = {
1987 .fl_pid = current->tgid,
1988 .fl_file = filp,
1989 .fl_flags = FL_FLOCK,
1990 .fl_type = F_UNLCK,
1991 .fl_end = OFFSET_MAX,
1992 };
1993 filp->f_op->flock(filp, F_SETLKW, &fl);
80fec4c6
TM
1994 if (fl.fl_ops && fl.fl_ops->fl_release_private)
1995 fl.fl_ops->fl_release_private(&fl);
1da177e4
LT
1996 }
1997
1998 lock_kernel();
1999 before = &inode->i_flock;
2000
2001 while ((fl = *before) != NULL) {
2002 if (fl->fl_file == filp) {
c293621b 2003 if (IS_FLOCK(fl)) {
1da177e4
LT
2004 locks_delete_lock(before);
2005 continue;
2006 }
2007 if (IS_LEASE(fl)) {
2008 lease_modify(before, F_UNLCK);
2009 continue;
2010 }
2011 /* What? */
2012 BUG();
2013 }
2014 before = &fl->fl_next;
2015 }
2016 unlock_kernel();
2017}
2018
1da177e4
LT
2019/**
2020 * posix_unblock_lock - stop waiting for a file lock
2021 * @filp: how the file was opened
2022 * @waiter: the lock which was waiting
2023 *
2024 * lockd needs to block waiting for locks.
2025 */
64a318ee 2026int
1da177e4
LT
2027posix_unblock_lock(struct file *filp, struct file_lock *waiter)
2028{
64a318ee
BF
2029 int status = 0;
2030
1da177e4 2031 lock_kernel();
5996a298 2032 if (waiter->fl_next)
1da177e4 2033 __locks_delete_block(waiter);
64a318ee
BF
2034 else
2035 status = -ENOENT;
5996a298 2036 unlock_kernel();
64a318ee 2037 return status;
1da177e4
LT
2038}
2039
2040EXPORT_SYMBOL(posix_unblock_lock);
2041
9b9d2ab4
ME
2042/**
2043 * vfs_cancel_lock - file byte range unblock lock
2044 * @filp: The file to apply the unblock to
2045 * @fl: The lock to be unblocked
2046 *
2047 * Used by lock managers to cancel blocked requests
2048 */
2049int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2050{
2051 if (filp->f_op && filp->f_op->lock)
2052 return filp->f_op->lock(filp, F_CANCELLK, fl);
2053 return 0;
2054}
2055
2056EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2057
1da177e4
LT
2058static void lock_get_status(char* out, struct file_lock *fl, int id, char *pfx)
2059{
2060 struct inode *inode = NULL;
2061
2062 if (fl->fl_file != NULL)
0f7fc9e4 2063 inode = fl->fl_file->f_path.dentry->d_inode;
1da177e4
LT
2064
2065 out += sprintf(out, "%d:%s ", id, pfx);
2066 if (IS_POSIX(fl)) {
2067 out += sprintf(out, "%6s %s ",
2068 (fl->fl_flags & FL_ACCESS) ? "ACCESS" : "POSIX ",
2069 (inode == NULL) ? "*NOINODE*" :
2070 (IS_MANDLOCK(inode) &&
2071 (inode->i_mode & (S_IXGRP | S_ISGID)) == S_ISGID) ?
2072 "MANDATORY" : "ADVISORY ");
2073 } else if (IS_FLOCK(fl)) {
2074 if (fl->fl_type & LOCK_MAND) {
2075 out += sprintf(out, "FLOCK MSNFS ");
2076 } else {
2077 out += sprintf(out, "FLOCK ADVISORY ");
2078 }
2079 } else if (IS_LEASE(fl)) {
2080 out += sprintf(out, "LEASE ");
2081 if (fl->fl_type & F_INPROGRESS)
2082 out += sprintf(out, "BREAKING ");
2083 else if (fl->fl_file)
2084 out += sprintf(out, "ACTIVE ");
2085 else
2086 out += sprintf(out, "BREAKER ");
2087 } else {
2088 out += sprintf(out, "UNKNOWN UNKNOWN ");
2089 }
2090 if (fl->fl_type & LOCK_MAND) {
2091 out += sprintf(out, "%s ",
2092 (fl->fl_type & LOCK_READ)
2093 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2094 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2095 } else {
2096 out += sprintf(out, "%s ",
2097 (fl->fl_type & F_INPROGRESS)
2098 ? (fl->fl_type & F_UNLCK) ? "UNLCK" : "READ "
2099 : (fl->fl_type & F_WRLCK) ? "WRITE" : "READ ");
2100 }
2101 if (inode) {
2102#ifdef WE_CAN_BREAK_LSLK_NOW
2103 out += sprintf(out, "%d %s:%ld ", fl->fl_pid,
2104 inode->i_sb->s_id, inode->i_ino);
2105#else
2106 /* userspace relies on this representation of dev_t ;-( */
2107 out += sprintf(out, "%d %02x:%02x:%ld ", fl->fl_pid,
2108 MAJOR(inode->i_sb->s_dev),
2109 MINOR(inode->i_sb->s_dev), inode->i_ino);
2110#endif
2111 } else {
2112 out += sprintf(out, "%d <none>:0 ", fl->fl_pid);
2113 }
2114 if (IS_POSIX(fl)) {
2115 if (fl->fl_end == OFFSET_MAX)
2116 out += sprintf(out, "%Ld EOF\n", fl->fl_start);
2117 else
2118 out += sprintf(out, "%Ld %Ld\n", fl->fl_start,
2119 fl->fl_end);
2120 } else {
2121 out += sprintf(out, "0 EOF\n");
2122 }
2123}
2124
2125static void move_lock_status(char **p, off_t* pos, off_t offset)
2126{
2127 int len;
2128 len = strlen(*p);
2129 if(*pos >= offset) {
2130 /* the complete line is valid */
2131 *p += len;
2132 *pos += len;
2133 return;
2134 }
2135 if(*pos+len > offset) {
2136 /* use the second part of the line */
2137 int i = offset-*pos;
2138 memmove(*p,*p+i,len-i);
2139 *p += len-i;
2140 *pos += len;
2141 return;
2142 }
2143 /* discard the complete line */
2144 *pos += len;
2145}
2146
2147/**
2148 * get_locks_status - reports lock usage in /proc/locks
2149 * @buffer: address in userspace to write into
2150 * @start: ?
2151 * @offset: how far we are through the buffer
2152 * @length: how much to read
2153 */
2154
2155int get_locks_status(char *buffer, char **start, off_t offset, int length)
2156{
2157 struct list_head *tmp;
2158 char *q = buffer;
2159 off_t pos = 0;
2160 int i = 0;
2161
2162 lock_kernel();
2163 list_for_each(tmp, &file_lock_list) {
2164 struct list_head *btmp;
2165 struct file_lock *fl = list_entry(tmp, struct file_lock, fl_link);
2166 lock_get_status(q, fl, ++i, "");
2167 move_lock_status(&q, &pos, offset);
2168
2169 if(pos >= offset+length)
2170 goto done;
2171
2172 list_for_each(btmp, &fl->fl_block) {
2173 struct file_lock *bfl = list_entry(btmp,
2174 struct file_lock, fl_block);
2175 lock_get_status(q, bfl, i, " ->");
2176 move_lock_status(&q, &pos, offset);
2177
2178 if(pos >= offset+length)
2179 goto done;
2180 }
2181 }
2182done:
2183 unlock_kernel();
2184 *start = buffer;
2185 if(q-buffer < length)
2186 return (q-buffer);
2187 return length;
2188}
2189
2190/**
2191 * lock_may_read - checks that the region is free of locks
2192 * @inode: the inode that is being read
2193 * @start: the first byte to read
2194 * @len: the number of bytes to read
2195 *
2196 * Emulates Windows locking requirements. Whole-file
2197 * mandatory locks (share modes) can prohibit a read and
2198 * byte-range POSIX locks can prohibit a read if they overlap.
2199 *
2200 * N.B. this function is only ever called
2201 * from knfsd and ownership of locks is never checked.
2202 */
2203int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2204{
2205 struct file_lock *fl;
2206 int result = 1;
2207 lock_kernel();
2208 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2209 if (IS_POSIX(fl)) {
2210 if (fl->fl_type == F_RDLCK)
2211 continue;
2212 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2213 continue;
2214 } else if (IS_FLOCK(fl)) {
2215 if (!(fl->fl_type & LOCK_MAND))
2216 continue;
2217 if (fl->fl_type & LOCK_READ)
2218 continue;
2219 } else
2220 continue;
2221 result = 0;
2222 break;
2223 }
2224 unlock_kernel();
2225 return result;
2226}
2227
2228EXPORT_SYMBOL(lock_may_read);
2229
2230/**
2231 * lock_may_write - checks that the region is free of locks
2232 * @inode: the inode that is being written
2233 * @start: the first byte to write
2234 * @len: the number of bytes to write
2235 *
2236 * Emulates Windows locking requirements. Whole-file
2237 * mandatory locks (share modes) can prohibit a write and
2238 * byte-range POSIX locks can prohibit a write if they overlap.
2239 *
2240 * N.B. this function is only ever called
2241 * from knfsd and ownership of locks is never checked.
2242 */
2243int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2244{
2245 struct file_lock *fl;
2246 int result = 1;
2247 lock_kernel();
2248 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2249 if (IS_POSIX(fl)) {
2250 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2251 continue;
2252 } else if (IS_FLOCK(fl)) {
2253 if (!(fl->fl_type & LOCK_MAND))
2254 continue;
2255 if (fl->fl_type & LOCK_WRITE)
2256 continue;
2257 } else
2258 continue;
2259 result = 0;
2260 break;
2261 }
2262 unlock_kernel();
2263 return result;
2264}
2265
2266EXPORT_SYMBOL(lock_may_write);
2267
1da177e4
LT
2268static int __init filelock_init(void)
2269{
2270 filelock_cache = kmem_cache_create("file_lock_cache",
2271 sizeof(struct file_lock), 0, SLAB_PANIC,
2272 init_once, NULL);
2273 return 0;
2274}
2275
2276core_initcall(filelock_init);