[SSB]: Sparse fixes.
[linux/fpc-iii.git] / fs / locks.c
blobc795eaaf6c4ceb75e5b4a0e9775df8c37ffb9240
1 /*
2 * linux/fs/locks.c
4 * Provide support for fcntl()'s F_GETLK, F_SETLK, and F_SETLKW calls.
5 * Doug Evans (dje@spiff.uucp), August 07, 1992
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.
12 * Miscellaneous edits, and a total rewrite of posix_lock_file() code.
13 * Kai Petzke (wpp@marie.physik.tu-berlin.de), 1994
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
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
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
31 * Implemented two lock personalities - FL_FLOCK and FL_POSIX.
33 * FL_POSIX locks are created with calls to fcntl() and lockf() through the
34 * fcntl() system call. They have the semantics described above.
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.
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).
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
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.
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.
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.
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.
72 * Tidied up block list handling. Added '/proc/locks' interface.
73 * Andy Walker (andy@lysaker.kvaerner.no), April 24, 1996.
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.
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.
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.
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.
94 * Made the block list a circular list to minimise searching in the list.
95 * Andy Walker (andy@lysaker.kvaerner.no), Sep 25, 1996.
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.
101 * Some adaptations for NFS support.
102 * Olaf Kirch (okir@monad.swb.de), Dec 1996,
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.
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.
112 * Leases and LOCK_MAND
113 * Matthew Wilcox <willy@debian.org>, June, 2000.
114 * Stephen Rothwell <sfr@canb.auug.org.au>, June, 2000.
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>
127 #include <linux/rcupdate.h>
129 #include <asm/semaphore.h>
130 #include <asm/uaccess.h>
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)
136 int leases_enable = 1;
137 int lease_break_time = 45;
139 #define for_each_lock(inode, lockp) \
140 for (lockp = &inode->i_flock; *lockp != NULL; lockp = &(*lockp)->fl_next)
142 static LIST_HEAD(file_lock_list);
143 static LIST_HEAD(blocked_list);
145 static struct kmem_cache *filelock_cache __read_mostly;
147 /* Allocate an empty lock structure. */
148 static struct file_lock *locks_alloc_lock(void)
150 return kmem_cache_alloc(filelock_cache, GFP_KERNEL);
153 static void locks_release_private(struct file_lock *fl)
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;
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;
168 /* Free a lock which is not in use. */
169 static void locks_free_lock(struct file_lock *fl)
171 BUG_ON(waitqueue_active(&fl->fl_wait));
172 BUG_ON(!list_empty(&fl->fl_block));
173 BUG_ON(!list_empty(&fl->fl_link));
175 locks_release_private(fl);
176 kmem_cache_free(filelock_cache, fl);
179 void locks_init_lock(struct file_lock *fl)
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;
196 EXPORT_SYMBOL(locks_init_lock);
199 * Initialises the fields of the file lock which are invariant for
200 * free file_locks.
202 static void init_once(void *foo, struct kmem_cache *cache, unsigned long flags)
204 struct file_lock *lock = (struct file_lock *) foo;
206 locks_init_lock(lock);
209 static void locks_copy_private(struct file_lock *new, struct file_lock *fl)
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;
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;
224 * Initialize a new lock from an existing file_lock structure.
226 static void __locks_copy_lock(struct file_lock *new, const struct file_lock *fl)
228 new->fl_owner = fl->fl_owner;
229 new->fl_pid = fl->fl_pid;
230 new->fl_file = NULL;
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;
235 new->fl_ops = NULL;
236 new->fl_lmops = NULL;
239 void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
241 locks_release_private(new);
243 __locks_copy_lock(new, fl);
244 new->fl_file = fl->fl_file;
245 new->fl_ops = fl->fl_ops;
246 new->fl_lmops = fl->fl_lmops;
248 locks_copy_private(new, fl);
251 EXPORT_SYMBOL(locks_copy_lock);
253 static 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;
264 return -EINVAL;
267 /* Fill in a file_lock structure with an appropriate FLOCK lock. */
268 static int flock_make_lock(struct file *filp, struct file_lock **lock,
269 unsigned int cmd)
271 struct file_lock *fl;
272 int type = flock_translate_cmd(cmd);
273 if (type < 0)
274 return type;
276 fl = locks_alloc_lock();
277 if (fl == NULL)
278 return -ENOMEM;
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;
286 *lock = fl;
287 return 0;
290 static int assign_type(struct file_lock *fl, int type)
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;
301 return 0;
304 /* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
305 * style lock.
307 static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
308 struct flock *l)
310 off_t start, end;
312 switch (l->l_whence) {
313 case SEEK_SET:
314 start = 0;
315 break;
316 case SEEK_CUR:
317 start = filp->f_pos;
318 break;
319 case SEEK_END:
320 start = i_size_read(filp->f_path.dentry->d_inode);
321 break;
322 default:
323 return -EINVAL;
326 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
327 POSIX-2001 defines it. */
328 start += l->l_start;
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) {
336 end = start - 1;
337 fl->fl_end = end;
338 start += l->l_len;
339 if (start < 0)
340 return -EINVAL;
342 fl->fl_start = start; /* we record the absolute position */
343 if (fl->fl_end < fl->fl_start)
344 return -EOVERFLOW;
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;
353 return assign_type(fl, l->l_type);
356 #if BITS_PER_LONG == 32
357 static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
358 struct flock64 *l)
360 loff_t start;
362 switch (l->l_whence) {
363 case SEEK_SET:
364 start = 0;
365 break;
366 case SEEK_CUR:
367 start = filp->f_pos;
368 break;
369 case SEEK_END:
370 start = i_size_read(filp->f_path.dentry->d_inode);
371 break;
372 default:
373 return -EINVAL;
376 start += l->l_start;
377 if (start < 0)
378 return -EINVAL;
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;
388 fl->fl_start = start; /* we record the absolute position */
389 if (fl->fl_end < fl->fl_start)
390 return -EOVERFLOW;
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;
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;
409 return (0);
411 #endif
413 /* default lease lock manager operations */
414 static void lease_break_callback(struct file_lock *fl)
416 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
419 static void lease_release_private_callback(struct file_lock *fl)
421 if (!fl->fl_file)
422 return;
424 f_delown(fl->fl_file);
425 fl->fl_file->f_owner.signum = 0;
428 static int lease_mylease_callback(struct file_lock *fl, struct file_lock *try)
430 return fl->fl_file == try->fl_file;
433 static struct lock_manager_operations lease_manager_ops = {
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,
441 * Initialize a lease, use the default lock manager operations
443 static int lease_init(struct file *filp, int type, struct file_lock *fl)
445 if (assign_type(fl, type) != 0)
446 return -EINVAL;
448 fl->fl_owner = current->files;
449 fl->fl_pid = current->tgid;
451 fl->fl_file = filp;
452 fl->fl_flags = FL_LEASE;
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;
460 /* Allocate a file_lock initialised to this type of lease */
461 static struct file_lock *lease_alloc(struct file *filp, int type)
463 struct file_lock *fl = locks_alloc_lock();
464 int error = -ENOMEM;
466 if (fl == NULL)
467 return ERR_PTR(error);
469 error = lease_init(filp, type, fl);
470 if (error) {
471 locks_free_lock(fl);
472 return ERR_PTR(error);
474 return fl;
477 /* Check if two locks overlap each other.
479 static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
481 return ((fl1->fl_end >= fl2->fl_start) &&
482 (fl2->fl_end >= fl1->fl_start));
486 * Check whether two locks have the same owner.
488 static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
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;
496 /* Remove waiter from blocker's block list.
497 * When blocker ends up pointing to itself then the list is empty.
499 static void __locks_delete_block(struct file_lock *waiter)
501 list_del_init(&waiter->fl_block);
502 list_del_init(&waiter->fl_link);
503 waiter->fl_next = NULL;
508 static void locks_delete_block(struct file_lock *waiter)
510 lock_kernel();
511 __locks_delete_block(waiter);
512 unlock_kernel();
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.
520 static void locks_insert_block(struct file_lock *blocker,
521 struct file_lock *waiter)
523 BUG_ON(!list_empty(&waiter->fl_block));
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);
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.
534 static void locks_wake_up_blocks(struct file_lock *blocker)
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);
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.
550 static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
552 list_add(&fl->fl_link, &file_lock_list);
554 /* insert into file's list */
555 fl->fl_next = *pos;
556 *pos = fl;
558 if (fl->fl_ops && fl->fl_ops->fl_insert)
559 fl->fl_ops->fl_insert(fl);
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.
568 static void locks_delete_lock(struct file_lock **thisfl_p)
570 struct file_lock *fl = *thisfl_p;
572 *thisfl_p = fl->fl_next;
573 fl->fl_next = NULL;
574 list_del_init(&fl->fl_link);
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;
582 if (fl->fl_ops && fl->fl_ops->fl_remove)
583 fl->fl_ops->fl_remove(fl);
585 locks_wake_up_blocks(fl);
586 locks_free_lock(fl);
589 /* Determine if lock sys_fl blocks lock caller_fl. Common functionality
590 * checks for shared/exclusive status of overlapping locks.
592 static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
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;
601 /* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
602 * checking before calling the locks_conflict().
604 static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
606 /* POSIX locks owned by the same process do not conflict with
607 * each other.
609 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
610 return (0);
612 /* Check whether they overlap */
613 if (!locks_overlap(caller_fl, sys_fl))
614 return 0;
616 return (locks_conflict(caller_fl, sys_fl));
619 /* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
620 * checking before calling the locks_conflict().
622 static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
624 /* FLOCK locks referring to the same filp do not conflict with
625 * each other.
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;
632 return (locks_conflict(caller_fl, sys_fl));
635 static int interruptible_sleep_on_locked(wait_queue_head_t *fl_wait, int timeout)
637 int result = 0;
638 DECLARE_WAITQUEUE(wait, current);
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;
653 static int locks_block_on_timeout(struct file_lock *blocker, struct file_lock *waiter, int time)
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;
662 void
663 posix_test_lock(struct file *filp, struct file_lock *fl)
665 struct file_lock *cfl;
667 lock_kernel();
668 for (cfl = filp->f_path.dentry->d_inode->i_flock; cfl; cfl = cfl->fl_next) {
669 if (!IS_POSIX(cfl))
670 continue;
671 if (posix_locks_conflict(cfl, fl))
672 break;
674 if (cfl)
675 __locks_copy_lock(fl, cfl);
676 else
677 fl->fl_type = F_UNLCK;
678 unlock_kernel();
679 return;
682 EXPORT_SYMBOL(posix_test_lock);
684 /* This function tests for deadlock condition before putting a process to
685 * sleep. The detection scheme is no longer recursive. Recursive was neat,
686 * but dangerous - we risked stack corruption if the lock data was bad, or
687 * if the recursion was too deep for any other reason.
689 * We rely on the fact that a task can only be on one lock's wait queue
690 * at a time. When we find blocked_task on a wait queue we can re-search
691 * with blocked_task equal to that queue's owner, until either blocked_task
692 * isn't found, or blocked_task is found on a queue owned by my_task.
694 * Note: the above assumption may not be true when handling lock requests
695 * from a broken NFS client. But broken NFS clients have a lot more to
696 * worry about than proper deadlock detection anyway... --okir
698 static int posix_locks_deadlock(struct file_lock *caller_fl,
699 struct file_lock *block_fl)
701 struct list_head *tmp;
703 next_task:
704 if (posix_same_owner(caller_fl, block_fl))
705 return 1;
706 list_for_each(tmp, &blocked_list) {
707 struct file_lock *fl = list_entry(tmp, struct file_lock, fl_link);
708 if (posix_same_owner(fl, block_fl)) {
709 fl = fl->fl_next;
710 block_fl = fl;
711 goto next_task;
714 return 0;
717 /* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
718 * at the head of the list, but that's secret knowledge known only to
719 * flock_lock_file and posix_lock_file.
721 * Note that if called with an FL_EXISTS argument, the caller may determine
722 * whether or not a lock was successfully freed by testing the return
723 * value for -ENOENT.
725 static int flock_lock_file(struct file *filp, struct file_lock *request)
727 struct file_lock *new_fl = NULL;
728 struct file_lock **before;
729 struct inode * inode = filp->f_path.dentry->d_inode;
730 int error = 0;
731 int found = 0;
733 lock_kernel();
734 if (request->fl_flags & FL_ACCESS)
735 goto find_conflict;
736 for_each_lock(inode, before) {
737 struct file_lock *fl = *before;
738 if (IS_POSIX(fl))
739 break;
740 if (IS_LEASE(fl))
741 continue;
742 if (filp != fl->fl_file)
743 continue;
744 if (request->fl_type == fl->fl_type)
745 goto out;
746 found = 1;
747 locks_delete_lock(before);
748 break;
751 if (request->fl_type == F_UNLCK) {
752 if ((request->fl_flags & FL_EXISTS) && !found)
753 error = -ENOENT;
754 goto out;
757 error = -ENOMEM;
758 new_fl = locks_alloc_lock();
759 if (new_fl == NULL)
760 goto out;
762 * If a higher-priority process was blocked on the old file lock,
763 * give it the opportunity to lock the file.
765 if (found)
766 cond_resched();
768 find_conflict:
769 for_each_lock(inode, before) {
770 struct file_lock *fl = *before;
771 if (IS_POSIX(fl))
772 break;
773 if (IS_LEASE(fl))
774 continue;
775 if (!flock_locks_conflict(request, fl))
776 continue;
777 error = -EAGAIN;
778 if (request->fl_flags & FL_SLEEP)
779 locks_insert_block(fl, request);
780 goto out;
782 if (request->fl_flags & FL_ACCESS)
783 goto out;
784 locks_copy_lock(new_fl, request);
785 locks_insert_lock(before, new_fl);
786 new_fl = NULL;
787 error = 0;
789 out:
790 unlock_kernel();
791 if (new_fl)
792 locks_free_lock(new_fl);
793 return error;
796 static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
798 struct file_lock *fl;
799 struct file_lock *new_fl = NULL;
800 struct file_lock *new_fl2 = NULL;
801 struct file_lock *left = NULL;
802 struct file_lock *right = NULL;
803 struct file_lock **before;
804 int error, added = 0;
807 * We may need two file_lock structures for this operation,
808 * so we get them in advance to avoid races.
810 * In some cases we can be sure, that no new locks will be needed
812 if (!(request->fl_flags & FL_ACCESS) &&
813 (request->fl_type != F_UNLCK ||
814 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
815 new_fl = locks_alloc_lock();
816 new_fl2 = locks_alloc_lock();
819 lock_kernel();
820 if (request->fl_type != F_UNLCK) {
821 for_each_lock(inode, before) {
822 struct file_lock *fl = *before;
823 if (!IS_POSIX(fl))
824 continue;
825 if (!posix_locks_conflict(request, fl))
826 continue;
827 if (conflock)
828 locks_copy_lock(conflock, fl);
829 error = -EAGAIN;
830 if (!(request->fl_flags & FL_SLEEP))
831 goto out;
832 error = -EDEADLK;
833 if (posix_locks_deadlock(request, fl))
834 goto out;
835 error = -EAGAIN;
836 locks_insert_block(fl, request);
837 goto out;
841 /* If we're just looking for a conflict, we're done. */
842 error = 0;
843 if (request->fl_flags & FL_ACCESS)
844 goto out;
847 * Find the first old lock with the same owner as the new lock.
850 before = &inode->i_flock;
852 /* First skip locks owned by other processes. */
853 while ((fl = *before) && (!IS_POSIX(fl) ||
854 !posix_same_owner(request, fl))) {
855 before = &fl->fl_next;
858 /* Process locks with this owner. */
859 while ((fl = *before) && posix_same_owner(request, fl)) {
860 /* Detect adjacent or overlapping regions (if same lock type)
862 if (request->fl_type == fl->fl_type) {
863 /* In all comparisons of start vs end, use
864 * "start - 1" rather than "end + 1". If end
865 * is OFFSET_MAX, end + 1 will become negative.
867 if (fl->fl_end < request->fl_start - 1)
868 goto next_lock;
869 /* If the next lock in the list has entirely bigger
870 * addresses than the new one, insert the lock here.
872 if (fl->fl_start - 1 > request->fl_end)
873 break;
875 /* If we come here, the new and old lock are of the
876 * same type and adjacent or overlapping. Make one
877 * lock yielding from the lower start address of both
878 * locks to the higher end address.
880 if (fl->fl_start > request->fl_start)
881 fl->fl_start = request->fl_start;
882 else
883 request->fl_start = fl->fl_start;
884 if (fl->fl_end < request->fl_end)
885 fl->fl_end = request->fl_end;
886 else
887 request->fl_end = fl->fl_end;
888 if (added) {
889 locks_delete_lock(before);
890 continue;
892 request = fl;
893 added = 1;
895 else {
896 /* Processing for different lock types is a bit
897 * more complex.
899 if (fl->fl_end < request->fl_start)
900 goto next_lock;
901 if (fl->fl_start > request->fl_end)
902 break;
903 if (request->fl_type == F_UNLCK)
904 added = 1;
905 if (fl->fl_start < request->fl_start)
906 left = fl;
907 /* If the next lock in the list has a higher end
908 * address than the new one, insert the new one here.
910 if (fl->fl_end > request->fl_end) {
911 right = fl;
912 break;
914 if (fl->fl_start >= request->fl_start) {
915 /* The new lock completely replaces an old
916 * one (This may happen several times).
918 if (added) {
919 locks_delete_lock(before);
920 continue;
922 /* Replace the old lock with the new one.
923 * Wake up anybody waiting for the old one,
924 * as the change in lock type might satisfy
925 * their needs.
927 locks_wake_up_blocks(fl);
928 fl->fl_start = request->fl_start;
929 fl->fl_end = request->fl_end;
930 fl->fl_type = request->fl_type;
931 locks_release_private(fl);
932 locks_copy_private(fl, request);
933 request = fl;
934 added = 1;
937 /* Go on to next lock.
939 next_lock:
940 before = &fl->fl_next;
944 * The above code only modifies existing locks in case of
945 * merging or replacing. If new lock(s) need to be inserted
946 * all modifications are done bellow this, so it's safe yet to
947 * bail out.
949 error = -ENOLCK; /* "no luck" */
950 if (right && left == right && !new_fl2)
951 goto out;
953 error = 0;
954 if (!added) {
955 if (request->fl_type == F_UNLCK) {
956 if (request->fl_flags & FL_EXISTS)
957 error = -ENOENT;
958 goto out;
961 if (!new_fl) {
962 error = -ENOLCK;
963 goto out;
965 locks_copy_lock(new_fl, request);
966 locks_insert_lock(before, new_fl);
967 new_fl = NULL;
969 if (right) {
970 if (left == right) {
971 /* The new lock breaks the old one in two pieces,
972 * so we have to use the second new lock.
974 left = new_fl2;
975 new_fl2 = NULL;
976 locks_copy_lock(left, right);
977 locks_insert_lock(before, left);
979 right->fl_start = request->fl_end + 1;
980 locks_wake_up_blocks(right);
982 if (left) {
983 left->fl_end = request->fl_start - 1;
984 locks_wake_up_blocks(left);
986 out:
987 unlock_kernel();
989 * Free any unused locks.
991 if (new_fl)
992 locks_free_lock(new_fl);
993 if (new_fl2)
994 locks_free_lock(new_fl2);
995 return error;
999 * posix_lock_file - Apply a POSIX-style lock to a file
1000 * @filp: The file to apply the lock to
1001 * @fl: The lock to be applied
1002 * @conflock: Place to return a copy of the conflicting lock, if found.
1004 * Add a POSIX style lock to a file.
1005 * We merge adjacent & overlapping locks whenever possible.
1006 * POSIX locks are sorted by owner task, then by starting address
1008 * Note that if called with an FL_EXISTS argument, the caller may determine
1009 * whether or not a lock was successfully freed by testing the return
1010 * value for -ENOENT.
1012 int posix_lock_file(struct file *filp, struct file_lock *fl,
1013 struct file_lock *conflock)
1015 return __posix_lock_file(filp->f_path.dentry->d_inode, fl, conflock);
1017 EXPORT_SYMBOL(posix_lock_file);
1020 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1021 * @filp: The file to apply the lock to
1022 * @fl: The lock to be applied
1024 * Add a POSIX style lock to a file.
1025 * We merge adjacent & overlapping locks whenever possible.
1026 * POSIX locks are sorted by owner task, then by starting address
1028 int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1030 int error;
1031 might_sleep ();
1032 for (;;) {
1033 error = posix_lock_file(filp, fl, NULL);
1034 if ((error != -EAGAIN) || !(fl->fl_flags & FL_SLEEP))
1035 break;
1036 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1037 if (!error)
1038 continue;
1040 locks_delete_block(fl);
1041 break;
1043 return error;
1045 EXPORT_SYMBOL(posix_lock_file_wait);
1048 * locks_mandatory_locked - Check for an active lock
1049 * @inode: the file to check
1051 * Searches the inode's list of locks to find any POSIX locks which conflict.
1052 * This function is called from locks_verify_locked() only.
1054 int locks_mandatory_locked(struct inode *inode)
1056 fl_owner_t owner = current->files;
1057 struct file_lock *fl;
1060 * Search the lock list for this inode for any POSIX locks.
1062 lock_kernel();
1063 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1064 if (!IS_POSIX(fl))
1065 continue;
1066 if (fl->fl_owner != owner)
1067 break;
1069 unlock_kernel();
1070 return fl ? -EAGAIN : 0;
1074 * locks_mandatory_area - Check for a conflicting lock
1075 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1076 * for shared
1077 * @inode: the file to check
1078 * @filp: how the file was opened (if it was)
1079 * @offset: start of area to check
1080 * @count: length of area to check
1082 * Searches the inode's list of locks to find any POSIX locks which conflict.
1083 * This function is called from rw_verify_area() and
1084 * locks_verify_truncate().
1086 int locks_mandatory_area(int read_write, struct inode *inode,
1087 struct file *filp, loff_t offset,
1088 size_t count)
1090 struct file_lock fl;
1091 int error;
1093 locks_init_lock(&fl);
1094 fl.fl_owner = current->files;
1095 fl.fl_pid = current->tgid;
1096 fl.fl_file = filp;
1097 fl.fl_flags = FL_POSIX | FL_ACCESS;
1098 if (filp && !(filp->f_flags & O_NONBLOCK))
1099 fl.fl_flags |= FL_SLEEP;
1100 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1101 fl.fl_start = offset;
1102 fl.fl_end = offset + count - 1;
1104 for (;;) {
1105 error = __posix_lock_file(inode, &fl, NULL);
1106 if (error != -EAGAIN)
1107 break;
1108 if (!(fl.fl_flags & FL_SLEEP))
1109 break;
1110 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1111 if (!error) {
1113 * If we've been sleeping someone might have
1114 * changed the permissions behind our back.
1116 if ((inode->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID)
1117 continue;
1120 locks_delete_block(&fl);
1121 break;
1124 return error;
1127 EXPORT_SYMBOL(locks_mandatory_area);
1129 /* We already had a lease on this file; just change its type */
1130 int lease_modify(struct file_lock **before, int arg)
1132 struct file_lock *fl = *before;
1133 int error = assign_type(fl, arg);
1135 if (error)
1136 return error;
1137 locks_wake_up_blocks(fl);
1138 if (arg == F_UNLCK)
1139 locks_delete_lock(before);
1140 return 0;
1143 EXPORT_SYMBOL(lease_modify);
1145 static void time_out_leases(struct inode *inode)
1147 struct file_lock **before;
1148 struct file_lock *fl;
1150 before = &inode->i_flock;
1151 while ((fl = *before) && IS_LEASE(fl) && (fl->fl_type & F_INPROGRESS)) {
1152 if ((fl->fl_break_time == 0)
1153 || time_before(jiffies, fl->fl_break_time)) {
1154 before = &fl->fl_next;
1155 continue;
1157 lease_modify(before, fl->fl_type & ~F_INPROGRESS);
1158 if (fl == *before) /* lease_modify may have freed fl */
1159 before = &fl->fl_next;
1164 * __break_lease - revoke all outstanding leases on file
1165 * @inode: the inode of the file to return
1166 * @mode: the open mode (read or write)
1168 * break_lease (inlined for speed) has checked there already is at least
1169 * some kind of lock (maybe a lease) on this file. Leases are broken on
1170 * a call to open() or truncate(). This function can sleep unless you
1171 * specified %O_NONBLOCK to your open().
1173 int __break_lease(struct inode *inode, unsigned int mode)
1175 int error = 0, future;
1176 struct file_lock *new_fl, *flock;
1177 struct file_lock *fl;
1178 unsigned long break_time;
1179 int i_have_this_lease = 0;
1181 new_fl = lease_alloc(NULL, mode & FMODE_WRITE ? F_WRLCK : F_RDLCK);
1183 lock_kernel();
1185 time_out_leases(inode);
1187 flock = inode->i_flock;
1188 if ((flock == NULL) || !IS_LEASE(flock))
1189 goto out;
1191 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next)
1192 if (fl->fl_owner == current->files)
1193 i_have_this_lease = 1;
1195 if (mode & FMODE_WRITE) {
1196 /* If we want write access, we have to revoke any lease. */
1197 future = F_UNLCK | F_INPROGRESS;
1198 } else if (flock->fl_type & F_INPROGRESS) {
1199 /* If the lease is already being broken, we just leave it */
1200 future = flock->fl_type;
1201 } else if (flock->fl_type & F_WRLCK) {
1202 /* Downgrade the exclusive lease to a read-only lease. */
1203 future = F_RDLCK | F_INPROGRESS;
1204 } else {
1205 /* the existing lease was read-only, so we can read too. */
1206 goto out;
1209 if (IS_ERR(new_fl) && !i_have_this_lease
1210 && ((mode & O_NONBLOCK) == 0)) {
1211 error = PTR_ERR(new_fl);
1212 goto out;
1215 break_time = 0;
1216 if (lease_break_time > 0) {
1217 break_time = jiffies + lease_break_time * HZ;
1218 if (break_time == 0)
1219 break_time++; /* so that 0 means no break time */
1222 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1223 if (fl->fl_type != future) {
1224 fl->fl_type = future;
1225 fl->fl_break_time = break_time;
1226 /* lease must have lmops break callback */
1227 fl->fl_lmops->fl_break(fl);
1231 if (i_have_this_lease || (mode & O_NONBLOCK)) {
1232 error = -EWOULDBLOCK;
1233 goto out;
1236 restart:
1237 break_time = flock->fl_break_time;
1238 if (break_time != 0) {
1239 break_time -= jiffies;
1240 if (break_time == 0)
1241 break_time++;
1243 error = locks_block_on_timeout(flock, new_fl, break_time);
1244 if (error >= 0) {
1245 if (error == 0)
1246 time_out_leases(inode);
1247 /* Wait for the next lease that has not been broken yet */
1248 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1249 flock = flock->fl_next) {
1250 if (flock->fl_type & F_INPROGRESS)
1251 goto restart;
1253 error = 0;
1256 out:
1257 unlock_kernel();
1258 if (!IS_ERR(new_fl))
1259 locks_free_lock(new_fl);
1260 return error;
1263 EXPORT_SYMBOL(__break_lease);
1266 * lease_get_mtime
1267 * @inode: the inode
1268 * @time: pointer to a timespec which will contain the last modified time
1270 * This is to force NFS clients to flush their caches for files with
1271 * exclusive leases. The justification is that if someone has an
1272 * exclusive lease, then they could be modifiying it.
1274 void lease_get_mtime(struct inode *inode, struct timespec *time)
1276 struct file_lock *flock = inode->i_flock;
1277 if (flock && IS_LEASE(flock) && (flock->fl_type & F_WRLCK))
1278 *time = current_fs_time(inode->i_sb);
1279 else
1280 *time = inode->i_mtime;
1283 EXPORT_SYMBOL(lease_get_mtime);
1286 * fcntl_getlease - Enquire what lease is currently active
1287 * @filp: the file
1289 * The value returned by this function will be one of
1290 * (if no lease break is pending):
1292 * %F_RDLCK to indicate a shared lease is held.
1294 * %F_WRLCK to indicate an exclusive lease is held.
1296 * %F_UNLCK to indicate no lease is held.
1298 * (if a lease break is pending):
1300 * %F_RDLCK to indicate an exclusive lease needs to be
1301 * changed to a shared lease (or removed).
1303 * %F_UNLCK to indicate the lease needs to be removed.
1305 * XXX: sfr & willy disagree over whether F_INPROGRESS
1306 * should be returned to userspace.
1308 int fcntl_getlease(struct file *filp)
1310 struct file_lock *fl;
1311 int type = F_UNLCK;
1313 lock_kernel();
1314 time_out_leases(filp->f_path.dentry->d_inode);
1315 for (fl = filp->f_path.dentry->d_inode->i_flock; fl && IS_LEASE(fl);
1316 fl = fl->fl_next) {
1317 if (fl->fl_file == filp) {
1318 type = fl->fl_type & ~F_INPROGRESS;
1319 break;
1322 unlock_kernel();
1323 return type;
1327 * generic_setlease - sets a lease on an open file
1328 * @filp: file pointer
1329 * @arg: type of lease to obtain
1330 * @flp: input - file_lock to use, output - file_lock inserted
1332 * The (input) flp->fl_lmops->fl_break function is required
1333 * by break_lease().
1335 * Called with kernel lock held.
1337 int generic_setlease(struct file *filp, long arg, struct file_lock **flp)
1339 struct file_lock *fl, **before, **my_before = NULL, *lease;
1340 struct dentry *dentry = filp->f_path.dentry;
1341 struct inode *inode = dentry->d_inode;
1342 int error, rdlease_count = 0, wrlease_count = 0;
1344 if ((current->fsuid != inode->i_uid) && !capable(CAP_LEASE))
1345 return -EACCES;
1346 if (!S_ISREG(inode->i_mode))
1347 return -EINVAL;
1348 error = security_file_lock(filp, arg);
1349 if (error)
1350 return error;
1352 time_out_leases(inode);
1354 BUG_ON(!(*flp)->fl_lmops->fl_break);
1356 lease = *flp;
1358 error = -EAGAIN;
1359 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1360 goto out;
1361 if ((arg == F_WRLCK)
1362 && ((atomic_read(&dentry->d_count) > 1)
1363 || (atomic_read(&inode->i_count) > 1)))
1364 goto out;
1367 * At this point, we know that if there is an exclusive
1368 * lease on this file, then we hold it on this filp
1369 * (otherwise our open of this file would have blocked).
1370 * And if we are trying to acquire an exclusive lease,
1371 * then the file is not open by anyone (including us)
1372 * except for this filp.
1374 for (before = &inode->i_flock;
1375 ((fl = *before) != NULL) && IS_LEASE(fl);
1376 before = &fl->fl_next) {
1377 if (lease->fl_lmops->fl_mylease(fl, lease))
1378 my_before = before;
1379 else if (fl->fl_type == (F_INPROGRESS | F_UNLCK))
1381 * Someone is in the process of opening this
1382 * file for writing so we may not take an
1383 * exclusive lease on it.
1385 wrlease_count++;
1386 else
1387 rdlease_count++;
1390 if ((arg == F_RDLCK && (wrlease_count > 0)) ||
1391 (arg == F_WRLCK && ((rdlease_count + wrlease_count) > 0)))
1392 goto out;
1394 if (my_before != NULL) {
1395 *flp = *my_before;
1396 error = lease->fl_lmops->fl_change(my_before, arg);
1397 goto out;
1400 error = 0;
1401 if (arg == F_UNLCK)
1402 goto out;
1404 error = -EINVAL;
1405 if (!leases_enable)
1406 goto out;
1408 error = -ENOMEM;
1409 fl = locks_alloc_lock();
1410 if (fl == NULL)
1411 goto out;
1413 locks_copy_lock(fl, lease);
1415 locks_insert_lock(before, fl);
1417 *flp = fl;
1418 error = 0;
1419 out:
1420 return error;
1422 EXPORT_SYMBOL(generic_setlease);
1425 * vfs_setlease - sets a lease on an open file
1426 * @filp: file pointer
1427 * @arg: type of lease to obtain
1428 * @lease: file_lock to use
1430 * Call this to establish a lease on the file.
1431 * The (*lease)->fl_lmops->fl_break operation must be set; if not,
1432 * break_lease will oops!
1434 * This will call the filesystem's setlease file method, if
1435 * defined. Note that there is no getlease method; instead, the
1436 * filesystem setlease method should call back to setlease() to
1437 * add a lease to the inode's lease list, where fcntl_getlease() can
1438 * find it. Since fcntl_getlease() only reports whether the current
1439 * task holds a lease, a cluster filesystem need only do this for
1440 * leases held by processes on this node.
1442 * There is also no break_lease method; filesystems that
1443 * handle their own leases shoud break leases themselves from the
1444 * filesystem's open, create, and (on truncate) setattr methods.
1446 * Warning: the only current setlease methods exist only to disable
1447 * leases in certain cases. More vfs changes may be required to
1448 * allow a full filesystem lease implementation.
1451 int vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
1453 int error;
1455 lock_kernel();
1456 if (filp->f_op && filp->f_op->setlease)
1457 error = filp->f_op->setlease(filp, arg, lease);
1458 else
1459 error = generic_setlease(filp, arg, lease);
1460 unlock_kernel();
1462 return error;
1464 EXPORT_SYMBOL_GPL(vfs_setlease);
1467 * fcntl_setlease - sets a lease on an open file
1468 * @fd: open file descriptor
1469 * @filp: file pointer
1470 * @arg: type of lease to obtain
1472 * Call this fcntl to establish a lease on the file.
1473 * Note that you also need to call %F_SETSIG to
1474 * receive a signal when the lease is broken.
1476 int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1478 struct file_lock fl, *flp = &fl;
1479 struct dentry *dentry = filp->f_path.dentry;
1480 struct inode *inode = dentry->d_inode;
1481 int error;
1483 locks_init_lock(&fl);
1484 error = lease_init(filp, arg, &fl);
1485 if (error)
1486 return error;
1488 lock_kernel();
1490 error = vfs_setlease(filp, arg, &flp);
1491 if (error || arg == F_UNLCK)
1492 goto out_unlock;
1494 error = fasync_helper(fd, filp, 1, &flp->fl_fasync);
1495 if (error < 0) {
1496 /* remove lease just inserted by setlease */
1497 flp->fl_type = F_UNLCK | F_INPROGRESS;
1498 flp->fl_break_time = jiffies - 10;
1499 time_out_leases(inode);
1500 goto out_unlock;
1503 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
1504 out_unlock:
1505 unlock_kernel();
1506 return error;
1510 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1511 * @filp: The file to apply the lock to
1512 * @fl: The lock to be applied
1514 * Add a FLOCK style lock to a file.
1516 int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1518 int error;
1519 might_sleep();
1520 for (;;) {
1521 error = flock_lock_file(filp, fl);
1522 if ((error != -EAGAIN) || !(fl->fl_flags & FL_SLEEP))
1523 break;
1524 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1525 if (!error)
1526 continue;
1528 locks_delete_block(fl);
1529 break;
1531 return error;
1534 EXPORT_SYMBOL(flock_lock_file_wait);
1537 * sys_flock: - flock() system call.
1538 * @fd: the file descriptor to lock.
1539 * @cmd: the type of lock to apply.
1541 * Apply a %FL_FLOCK style lock to an open file descriptor.
1542 * The @cmd can be one of
1544 * %LOCK_SH -- a shared lock.
1546 * %LOCK_EX -- an exclusive lock.
1548 * %LOCK_UN -- remove an existing lock.
1550 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1552 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1553 * processes read and write access respectively.
1555 asmlinkage long sys_flock(unsigned int fd, unsigned int cmd)
1557 struct file *filp;
1558 struct file_lock *lock;
1559 int can_sleep, unlock;
1560 int error;
1562 error = -EBADF;
1563 filp = fget(fd);
1564 if (!filp)
1565 goto out;
1567 can_sleep = !(cmd & LOCK_NB);
1568 cmd &= ~LOCK_NB;
1569 unlock = (cmd == LOCK_UN);
1571 if (!unlock && !(cmd & LOCK_MAND) && !(filp->f_mode & 3))
1572 goto out_putf;
1574 error = flock_make_lock(filp, &lock, cmd);
1575 if (error)
1576 goto out_putf;
1577 if (can_sleep)
1578 lock->fl_flags |= FL_SLEEP;
1580 error = security_file_lock(filp, cmd);
1581 if (error)
1582 goto out_free;
1584 if (filp->f_op && filp->f_op->flock)
1585 error = filp->f_op->flock(filp,
1586 (can_sleep) ? F_SETLKW : F_SETLK,
1587 lock);
1588 else
1589 error = flock_lock_file_wait(filp, lock);
1591 out_free:
1592 locks_free_lock(lock);
1594 out_putf:
1595 fput(filp);
1596 out:
1597 return error;
1601 * vfs_test_lock - test file byte range lock
1602 * @filp: The file to test lock for
1603 * @fl: The lock to test; also used to hold result
1605 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1606 * setting conf->fl_type to something other than F_UNLCK.
1608 int vfs_test_lock(struct file *filp, struct file_lock *fl)
1610 if (filp->f_op && filp->f_op->lock)
1611 return filp->f_op->lock(filp, F_GETLK, fl);
1612 posix_test_lock(filp, fl);
1613 return 0;
1615 EXPORT_SYMBOL_GPL(vfs_test_lock);
1617 static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1619 flock->l_pid = fl->fl_pid;
1620 #if BITS_PER_LONG == 32
1622 * Make sure we can represent the posix lock via
1623 * legacy 32bit flock.
1625 if (fl->fl_start > OFFT_OFFSET_MAX)
1626 return -EOVERFLOW;
1627 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1628 return -EOVERFLOW;
1629 #endif
1630 flock->l_start = fl->fl_start;
1631 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1632 fl->fl_end - fl->fl_start + 1;
1633 flock->l_whence = 0;
1634 flock->l_type = fl->fl_type;
1635 return 0;
1638 #if BITS_PER_LONG == 32
1639 static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1641 flock->l_pid = fl->fl_pid;
1642 flock->l_start = fl->fl_start;
1643 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1644 fl->fl_end - fl->fl_start + 1;
1645 flock->l_whence = 0;
1646 flock->l_type = fl->fl_type;
1648 #endif
1650 /* Report the first existing lock that would conflict with l.
1651 * This implements the F_GETLK command of fcntl().
1653 int fcntl_getlk(struct file *filp, struct flock __user *l)
1655 struct file_lock file_lock;
1656 struct flock flock;
1657 int error;
1659 error = -EFAULT;
1660 if (copy_from_user(&flock, l, sizeof(flock)))
1661 goto out;
1662 error = -EINVAL;
1663 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1664 goto out;
1666 error = flock_to_posix_lock(filp, &file_lock, &flock);
1667 if (error)
1668 goto out;
1670 error = vfs_test_lock(filp, &file_lock);
1671 if (error)
1672 goto out;
1674 flock.l_type = file_lock.fl_type;
1675 if (file_lock.fl_type != F_UNLCK) {
1676 error = posix_lock_to_flock(&flock, &file_lock);
1677 if (error)
1678 goto out;
1680 error = -EFAULT;
1681 if (!copy_to_user(l, &flock, sizeof(flock)))
1682 error = 0;
1683 out:
1684 return error;
1688 * vfs_lock_file - file byte range lock
1689 * @filp: The file to apply the lock to
1690 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1691 * @fl: The lock to be applied
1692 * @conf: Place to return a copy of the conflicting lock, if found.
1694 * A caller that doesn't care about the conflicting lock may pass NULL
1695 * as the final argument.
1697 * If the filesystem defines a private ->lock() method, then @conf will
1698 * be left unchanged; so a caller that cares should initialize it to
1699 * some acceptable default.
1701 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1702 * locks, the ->lock() interface may return asynchronously, before the lock has
1703 * been granted or denied by the underlying filesystem, if (and only if)
1704 * fl_grant is set. Callers expecting ->lock() to return asynchronously
1705 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1706 * the request is for a blocking lock. When ->lock() does return asynchronously,
1707 * it must return -EINPROGRESS, and call ->fl_grant() when the lock
1708 * request completes.
1709 * If the request is for non-blocking lock the file system should return
1710 * -EINPROGRESS then try to get the lock and call the callback routine with
1711 * the result. If the request timed out the callback routine will return a
1712 * nonzero return code and the file system should release the lock. The file
1713 * system is also responsible to keep a corresponding posix lock when it
1714 * grants a lock so the VFS can find out which locks are locally held and do
1715 * the correct lock cleanup when required.
1716 * The underlying filesystem must not drop the kernel lock or call
1717 * ->fl_grant() before returning to the caller with a -EINPROGRESS
1718 * return code.
1720 int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
1722 if (filp->f_op && filp->f_op->lock)
1723 return filp->f_op->lock(filp, cmd, fl);
1724 else
1725 return posix_lock_file(filp, fl, conf);
1727 EXPORT_SYMBOL_GPL(vfs_lock_file);
1729 /* Apply the lock described by l to an open file descriptor.
1730 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1732 int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
1733 struct flock __user *l)
1735 struct file_lock *file_lock = locks_alloc_lock();
1736 struct flock flock;
1737 struct inode *inode;
1738 int error;
1740 if (file_lock == NULL)
1741 return -ENOLCK;
1744 * This might block, so we do it before checking the inode.
1746 error = -EFAULT;
1747 if (copy_from_user(&flock, l, sizeof(flock)))
1748 goto out;
1750 inode = filp->f_path.dentry->d_inode;
1752 /* Don't allow mandatory locks on files that may be memory mapped
1753 * and shared.
1755 if (IS_MANDLOCK(inode) &&
1756 (inode->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID &&
1757 mapping_writably_mapped(filp->f_mapping)) {
1758 error = -EAGAIN;
1759 goto out;
1762 again:
1763 error = flock_to_posix_lock(filp, file_lock, &flock);
1764 if (error)
1765 goto out;
1766 if (cmd == F_SETLKW) {
1767 file_lock->fl_flags |= FL_SLEEP;
1770 error = -EBADF;
1771 switch (flock.l_type) {
1772 case F_RDLCK:
1773 if (!(filp->f_mode & FMODE_READ))
1774 goto out;
1775 break;
1776 case F_WRLCK:
1777 if (!(filp->f_mode & FMODE_WRITE))
1778 goto out;
1779 break;
1780 case F_UNLCK:
1781 break;
1782 default:
1783 error = -EINVAL;
1784 goto out;
1787 error = security_file_lock(filp, file_lock->fl_type);
1788 if (error)
1789 goto out;
1791 for (;;) {
1792 error = vfs_lock_file(filp, cmd, file_lock, NULL);
1793 if (error != -EAGAIN || cmd == F_SETLK)
1794 break;
1795 error = wait_event_interruptible(file_lock->fl_wait,
1796 !file_lock->fl_next);
1797 if (!error)
1798 continue;
1800 locks_delete_block(file_lock);
1801 break;
1805 * Attempt to detect a close/fcntl race and recover by
1806 * releasing the lock that was just acquired.
1808 if (!error && fcheck(fd) != filp && flock.l_type != F_UNLCK) {
1809 flock.l_type = F_UNLCK;
1810 goto again;
1813 out:
1814 locks_free_lock(file_lock);
1815 return error;
1818 #if BITS_PER_LONG == 32
1819 /* Report the first existing lock that would conflict with l.
1820 * This implements the F_GETLK command of fcntl().
1822 int fcntl_getlk64(struct file *filp, struct flock64 __user *l)
1824 struct file_lock file_lock;
1825 struct flock64 flock;
1826 int error;
1828 error = -EFAULT;
1829 if (copy_from_user(&flock, l, sizeof(flock)))
1830 goto out;
1831 error = -EINVAL;
1832 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1833 goto out;
1835 error = flock64_to_posix_lock(filp, &file_lock, &flock);
1836 if (error)
1837 goto out;
1839 error = vfs_test_lock(filp, &file_lock);
1840 if (error)
1841 goto out;
1843 flock.l_type = file_lock.fl_type;
1844 if (file_lock.fl_type != F_UNLCK)
1845 posix_lock_to_flock64(&flock, &file_lock);
1847 error = -EFAULT;
1848 if (!copy_to_user(l, &flock, sizeof(flock)))
1849 error = 0;
1851 out:
1852 return error;
1855 /* Apply the lock described by l to an open file descriptor.
1856 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1858 int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
1859 struct flock64 __user *l)
1861 struct file_lock *file_lock = locks_alloc_lock();
1862 struct flock64 flock;
1863 struct inode *inode;
1864 int error;
1866 if (file_lock == NULL)
1867 return -ENOLCK;
1870 * This might block, so we do it before checking the inode.
1872 error = -EFAULT;
1873 if (copy_from_user(&flock, l, sizeof(flock)))
1874 goto out;
1876 inode = filp->f_path.dentry->d_inode;
1878 /* Don't allow mandatory locks on files that may be memory mapped
1879 * and shared.
1881 if (IS_MANDLOCK(inode) &&
1882 (inode->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID &&
1883 mapping_writably_mapped(filp->f_mapping)) {
1884 error = -EAGAIN;
1885 goto out;
1888 again:
1889 error = flock64_to_posix_lock(filp, file_lock, &flock);
1890 if (error)
1891 goto out;
1892 if (cmd == F_SETLKW64) {
1893 file_lock->fl_flags |= FL_SLEEP;
1896 error = -EBADF;
1897 switch (flock.l_type) {
1898 case F_RDLCK:
1899 if (!(filp->f_mode & FMODE_READ))
1900 goto out;
1901 break;
1902 case F_WRLCK:
1903 if (!(filp->f_mode & FMODE_WRITE))
1904 goto out;
1905 break;
1906 case F_UNLCK:
1907 break;
1908 default:
1909 error = -EINVAL;
1910 goto out;
1913 error = security_file_lock(filp, file_lock->fl_type);
1914 if (error)
1915 goto out;
1917 for (;;) {
1918 error = vfs_lock_file(filp, cmd, file_lock, NULL);
1919 if (error != -EAGAIN || cmd == F_SETLK64)
1920 break;
1921 error = wait_event_interruptible(file_lock->fl_wait,
1922 !file_lock->fl_next);
1923 if (!error)
1924 continue;
1926 locks_delete_block(file_lock);
1927 break;
1931 * Attempt to detect a close/fcntl race and recover by
1932 * releasing the lock that was just acquired.
1934 if (!error && fcheck(fd) != filp && flock.l_type != F_UNLCK) {
1935 flock.l_type = F_UNLCK;
1936 goto again;
1939 out:
1940 locks_free_lock(file_lock);
1941 return error;
1943 #endif /* BITS_PER_LONG == 32 */
1946 * This function is called when the file is being removed
1947 * from the task's fd array. POSIX locks belonging to this task
1948 * are deleted at this time.
1950 void locks_remove_posix(struct file *filp, fl_owner_t owner)
1952 struct file_lock lock;
1955 * If there are no locks held on this file, we don't need to call
1956 * posix_lock_file(). Another process could be setting a lock on this
1957 * file at the same time, but we wouldn't remove that lock anyway.
1959 if (!filp->f_path.dentry->d_inode->i_flock)
1960 return;
1962 lock.fl_type = F_UNLCK;
1963 lock.fl_flags = FL_POSIX | FL_CLOSE;
1964 lock.fl_start = 0;
1965 lock.fl_end = OFFSET_MAX;
1966 lock.fl_owner = owner;
1967 lock.fl_pid = current->tgid;
1968 lock.fl_file = filp;
1969 lock.fl_ops = NULL;
1970 lock.fl_lmops = NULL;
1972 vfs_lock_file(filp, F_SETLK, &lock, NULL);
1974 if (lock.fl_ops && lock.fl_ops->fl_release_private)
1975 lock.fl_ops->fl_release_private(&lock);
1978 EXPORT_SYMBOL(locks_remove_posix);
1981 * This function is called on the last close of an open file.
1983 void locks_remove_flock(struct file *filp)
1985 struct inode * inode = filp->f_path.dentry->d_inode;
1986 struct file_lock *fl;
1987 struct file_lock **before;
1989 if (!inode->i_flock)
1990 return;
1992 if (filp->f_op && filp->f_op->flock) {
1993 struct file_lock fl = {
1994 .fl_pid = current->tgid,
1995 .fl_file = filp,
1996 .fl_flags = FL_FLOCK,
1997 .fl_type = F_UNLCK,
1998 .fl_end = OFFSET_MAX,
2000 filp->f_op->flock(filp, F_SETLKW, &fl);
2001 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2002 fl.fl_ops->fl_release_private(&fl);
2005 lock_kernel();
2006 before = &inode->i_flock;
2008 while ((fl = *before) != NULL) {
2009 if (fl->fl_file == filp) {
2010 if (IS_FLOCK(fl)) {
2011 locks_delete_lock(before);
2012 continue;
2014 if (IS_LEASE(fl)) {
2015 lease_modify(before, F_UNLCK);
2016 continue;
2018 /* What? */
2019 BUG();
2021 before = &fl->fl_next;
2023 unlock_kernel();
2027 * posix_unblock_lock - stop waiting for a file lock
2028 * @filp: how the file was opened
2029 * @waiter: the lock which was waiting
2031 * lockd needs to block waiting for locks.
2034 posix_unblock_lock(struct file *filp, struct file_lock *waiter)
2036 int status = 0;
2038 lock_kernel();
2039 if (waiter->fl_next)
2040 __locks_delete_block(waiter);
2041 else
2042 status = -ENOENT;
2043 unlock_kernel();
2044 return status;
2047 EXPORT_SYMBOL(posix_unblock_lock);
2050 * vfs_cancel_lock - file byte range unblock lock
2051 * @filp: The file to apply the unblock to
2052 * @fl: The lock to be unblocked
2054 * Used by lock managers to cancel blocked requests
2056 int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2058 if (filp->f_op && filp->f_op->lock)
2059 return filp->f_op->lock(filp, F_CANCELLK, fl);
2060 return 0;
2063 EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2065 static void lock_get_status(char* out, struct file_lock *fl, int id, char *pfx)
2067 struct inode *inode = NULL;
2069 if (fl->fl_file != NULL)
2070 inode = fl->fl_file->f_path.dentry->d_inode;
2072 out += sprintf(out, "%d:%s ", id, pfx);
2073 if (IS_POSIX(fl)) {
2074 out += sprintf(out, "%6s %s ",
2075 (fl->fl_flags & FL_ACCESS) ? "ACCESS" : "POSIX ",
2076 (inode == NULL) ? "*NOINODE*" :
2077 (IS_MANDLOCK(inode) &&
2078 (inode->i_mode & (S_IXGRP | S_ISGID)) == S_ISGID) ?
2079 "MANDATORY" : "ADVISORY ");
2080 } else if (IS_FLOCK(fl)) {
2081 if (fl->fl_type & LOCK_MAND) {
2082 out += sprintf(out, "FLOCK MSNFS ");
2083 } else {
2084 out += sprintf(out, "FLOCK ADVISORY ");
2086 } else if (IS_LEASE(fl)) {
2087 out += sprintf(out, "LEASE ");
2088 if (fl->fl_type & F_INPROGRESS)
2089 out += sprintf(out, "BREAKING ");
2090 else if (fl->fl_file)
2091 out += sprintf(out, "ACTIVE ");
2092 else
2093 out += sprintf(out, "BREAKER ");
2094 } else {
2095 out += sprintf(out, "UNKNOWN UNKNOWN ");
2097 if (fl->fl_type & LOCK_MAND) {
2098 out += sprintf(out, "%s ",
2099 (fl->fl_type & LOCK_READ)
2100 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2101 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2102 } else {
2103 out += sprintf(out, "%s ",
2104 (fl->fl_type & F_INPROGRESS)
2105 ? (fl->fl_type & F_UNLCK) ? "UNLCK" : "READ "
2106 : (fl->fl_type & F_WRLCK) ? "WRITE" : "READ ");
2108 if (inode) {
2109 #ifdef WE_CAN_BREAK_LSLK_NOW
2110 out += sprintf(out, "%d %s:%ld ", fl->fl_pid,
2111 inode->i_sb->s_id, inode->i_ino);
2112 #else
2113 /* userspace relies on this representation of dev_t ;-( */
2114 out += sprintf(out, "%d %02x:%02x:%ld ", fl->fl_pid,
2115 MAJOR(inode->i_sb->s_dev),
2116 MINOR(inode->i_sb->s_dev), inode->i_ino);
2117 #endif
2118 } else {
2119 out += sprintf(out, "%d <none>:0 ", fl->fl_pid);
2121 if (IS_POSIX(fl)) {
2122 if (fl->fl_end == OFFSET_MAX)
2123 out += sprintf(out, "%Ld EOF\n", fl->fl_start);
2124 else
2125 out += sprintf(out, "%Ld %Ld\n", fl->fl_start,
2126 fl->fl_end);
2127 } else {
2128 out += sprintf(out, "0 EOF\n");
2132 static void move_lock_status(char **p, off_t* pos, off_t offset)
2134 int len;
2135 len = strlen(*p);
2136 if(*pos >= offset) {
2137 /* the complete line is valid */
2138 *p += len;
2139 *pos += len;
2140 return;
2142 if(*pos+len > offset) {
2143 /* use the second part of the line */
2144 int i = offset-*pos;
2145 memmove(*p,*p+i,len-i);
2146 *p += len-i;
2147 *pos += len;
2148 return;
2150 /* discard the complete line */
2151 *pos += len;
2155 * get_locks_status - reports lock usage in /proc/locks
2156 * @buffer: address in userspace to write into
2157 * @start: ?
2158 * @offset: how far we are through the buffer
2159 * @length: how much to read
2162 int get_locks_status(char *buffer, char **start, off_t offset, int length)
2164 struct list_head *tmp;
2165 char *q = buffer;
2166 off_t pos = 0;
2167 int i = 0;
2169 lock_kernel();
2170 list_for_each(tmp, &file_lock_list) {
2171 struct list_head *btmp;
2172 struct file_lock *fl = list_entry(tmp, struct file_lock, fl_link);
2173 lock_get_status(q, fl, ++i, "");
2174 move_lock_status(&q, &pos, offset);
2176 if(pos >= offset+length)
2177 goto done;
2179 list_for_each(btmp, &fl->fl_block) {
2180 struct file_lock *bfl = list_entry(btmp,
2181 struct file_lock, fl_block);
2182 lock_get_status(q, bfl, i, " ->");
2183 move_lock_status(&q, &pos, offset);
2185 if(pos >= offset+length)
2186 goto done;
2189 done:
2190 unlock_kernel();
2191 *start = buffer;
2192 if(q-buffer < length)
2193 return (q-buffer);
2194 return length;
2198 * lock_may_read - checks that the region is free of locks
2199 * @inode: the inode that is being read
2200 * @start: the first byte to read
2201 * @len: the number of bytes to read
2203 * Emulates Windows locking requirements. Whole-file
2204 * mandatory locks (share modes) can prohibit a read and
2205 * byte-range POSIX locks can prohibit a read if they overlap.
2207 * N.B. this function is only ever called
2208 * from knfsd and ownership of locks is never checked.
2210 int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2212 struct file_lock *fl;
2213 int result = 1;
2214 lock_kernel();
2215 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2216 if (IS_POSIX(fl)) {
2217 if (fl->fl_type == F_RDLCK)
2218 continue;
2219 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2220 continue;
2221 } else if (IS_FLOCK(fl)) {
2222 if (!(fl->fl_type & LOCK_MAND))
2223 continue;
2224 if (fl->fl_type & LOCK_READ)
2225 continue;
2226 } else
2227 continue;
2228 result = 0;
2229 break;
2231 unlock_kernel();
2232 return result;
2235 EXPORT_SYMBOL(lock_may_read);
2238 * lock_may_write - checks that the region is free of locks
2239 * @inode: the inode that is being written
2240 * @start: the first byte to write
2241 * @len: the number of bytes to write
2243 * Emulates Windows locking requirements. Whole-file
2244 * mandatory locks (share modes) can prohibit a write and
2245 * byte-range POSIX locks can prohibit a write if they overlap.
2247 * N.B. this function is only ever called
2248 * from knfsd and ownership of locks is never checked.
2250 int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2252 struct file_lock *fl;
2253 int result = 1;
2254 lock_kernel();
2255 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2256 if (IS_POSIX(fl)) {
2257 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2258 continue;
2259 } else if (IS_FLOCK(fl)) {
2260 if (!(fl->fl_type & LOCK_MAND))
2261 continue;
2262 if (fl->fl_type & LOCK_WRITE)
2263 continue;
2264 } else
2265 continue;
2266 result = 0;
2267 break;
2269 unlock_kernel();
2270 return result;
2273 EXPORT_SYMBOL(lock_may_write);
2275 static int __init filelock_init(void)
2277 filelock_cache = kmem_cache_create("file_lock_cache",
2278 sizeof(struct file_lock), 0, SLAB_PANIC,
2279 init_once);
2280 return 0;
2283 core_initcall(filelock_init);