radix-tree-avoid-atomic-allocations-for-preloaded-insertions
[linux-2.6/linux-trees-mm.git] / fs / locks.c
blob7ffd4650afc7c79c2218b457a99a13defefeb932
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(struct kmem_cache *cache, void *foo)
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 static int posix_owner_shared(struct file_lock *caller_fl);
517 /* Insert waiter into blocker's block list.
518 * We use a circular list so that processes can be easily woken up in
519 * the order they blocked. The documentation doesn't require this but
520 * it seems like the reasonable thing to do.
522 static void locks_insert_block(struct file_lock *blocker,
523 struct file_lock *waiter)
525 BUG_ON(!list_empty(&waiter->fl_block));
526 list_add_tail(&waiter->fl_block, &blocker->fl_block);
527 waiter->fl_next = blocker;
528 if (IS_POSIX(blocker) && !posix_owner_shared(waiter))
529 list_add(&waiter->fl_link, &blocked_list);
532 /* Wake up processes blocked waiting for blocker.
533 * If told to wait then schedule the processes until the block list
534 * is empty, otherwise empty the block list ourselves.
536 static void locks_wake_up_blocks(struct file_lock *blocker)
538 while (!list_empty(&blocker->fl_block)) {
539 struct file_lock *waiter;
541 waiter = list_first_entry(&blocker->fl_block,
542 struct file_lock, fl_block);
543 __locks_delete_block(waiter);
544 if (waiter->fl_lmops && waiter->fl_lmops->fl_notify)
545 waiter->fl_lmops->fl_notify(waiter);
546 else
547 wake_up(&waiter->fl_wait);
551 /* Insert file lock fl into an inode's lock list at the position indicated
552 * by pos. At the same time add the lock to the global file lock list.
554 static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
556 list_add(&fl->fl_link, &file_lock_list);
558 /* insert into file's list */
559 fl->fl_next = *pos;
560 *pos = fl;
562 if (fl->fl_ops && fl->fl_ops->fl_insert)
563 fl->fl_ops->fl_insert(fl);
567 * Delete a lock and then free it.
568 * Wake up processes that are blocked waiting for this lock,
569 * notify the FS that the lock has been cleared and
570 * finally free the lock.
572 static void locks_delete_lock(struct file_lock **thisfl_p)
574 struct file_lock *fl = *thisfl_p;
576 *thisfl_p = fl->fl_next;
577 fl->fl_next = NULL;
578 list_del_init(&fl->fl_link);
580 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
581 if (fl->fl_fasync != NULL) {
582 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
583 fl->fl_fasync = NULL;
586 if (fl->fl_ops && fl->fl_ops->fl_remove)
587 fl->fl_ops->fl_remove(fl);
589 locks_wake_up_blocks(fl);
590 locks_free_lock(fl);
593 /* Determine if lock sys_fl blocks lock caller_fl. Common functionality
594 * checks for shared/exclusive status of overlapping locks.
596 static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
598 if (sys_fl->fl_type == F_WRLCK)
599 return 1;
600 if (caller_fl->fl_type == F_WRLCK)
601 return 1;
602 return 0;
605 /* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
606 * checking before calling the locks_conflict().
608 static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
610 /* POSIX locks owned by the same process do not conflict with
611 * each other.
613 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
614 return (0);
616 /* Check whether they overlap */
617 if (!locks_overlap(caller_fl, sys_fl))
618 return 0;
620 return (locks_conflict(caller_fl, sys_fl));
623 /* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
624 * checking before calling the locks_conflict().
626 static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
628 /* FLOCK locks referring to the same filp do not conflict with
629 * each other.
631 if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
632 return (0);
633 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
634 return 0;
636 return (locks_conflict(caller_fl, sys_fl));
639 static int interruptible_sleep_on_locked(wait_queue_head_t *fl_wait, int timeout)
641 int result = 0;
642 DECLARE_WAITQUEUE(wait, current);
644 __set_current_state(TASK_INTERRUPTIBLE);
645 add_wait_queue(fl_wait, &wait);
646 if (timeout == 0)
647 schedule();
648 else
649 result = schedule_timeout(timeout);
650 if (signal_pending(current))
651 result = -ERESTARTSYS;
652 remove_wait_queue(fl_wait, &wait);
653 __set_current_state(TASK_RUNNING);
654 return result;
657 static int locks_block_on_timeout(struct file_lock *blocker, struct file_lock *waiter, int time)
659 int result;
660 locks_insert_block(blocker, waiter);
661 result = interruptible_sleep_on_locked(&waiter->fl_wait, time);
662 __locks_delete_block(waiter);
663 return result;
666 void
667 posix_test_lock(struct file *filp, struct file_lock *fl)
669 struct file_lock *cfl;
671 lock_kernel();
672 for (cfl = filp->f_path.dentry->d_inode->i_flock; cfl; cfl = cfl->fl_next) {
673 if (!IS_POSIX(cfl))
674 continue;
675 if (posix_locks_conflict(fl, cfl))
676 break;
678 if (cfl)
679 __locks_copy_lock(fl, cfl);
680 else
681 fl->fl_type = F_UNLCK;
682 unlock_kernel();
683 return;
686 EXPORT_SYMBOL(posix_test_lock);
689 * Deadlock detection:
691 * We attempt to detect deadlocks that are due purely to posix file
692 * locks.
694 * We assume that a task can be waiting for at most one lock at a time.
695 * So for any acquired lock, the process holding that lock may be
696 * waiting on at most one other lock. That lock in turns may be held by
697 * someone waiting for at most one other lock. Given a requested lock
698 * caller_fl which is about to wait for a conflicting lock block_fl, we
699 * follow this chain of waiters to ensure we are not about to create a
700 * cycle.
702 * Since we do this before we ever put a process to sleep on a lock, we
703 * are ensured that there is never a cycle; that is what guarantees that
704 * the while() loop in posix_locks_deadlock() eventually completes.
706 * Note: the above assumption may not be true when handling lock
707 * requests from a broken NFS client. It may also fail in the presence
708 * of tasks (such as posix threads) sharing the same open file table.
710 * We don't necessarily care about returning EDEALK correctly in such
711 * cases, but we do need to avoid cycles in the lock dependency graph in
712 * order to ensure the loop in posix_locks_deadlock eventually
713 * terminates. To that end, we enforce the assumption above by refusing
714 * to return EDEADLK or add to the list of blocked locks in any case
715 * where a lock owner might be able to block on more than one lock.
718 static int posix_owner_shared(struct file_lock *caller_fl)
721 * The caller is a lock manager (lockd/nfsd), and won't
722 * necessarily guarantee that a single lock owner won't block on
723 * two locks at once:
725 if (caller_fl->fl_lmops && caller_fl->fl_lmops->fl_compare_owner)
726 return 1;
728 * Multiple tasks share current->files, also allowing the same
729 * "owner" to block on two locks at once:
731 if (current->files == NULL || atomic_read(&current->files->count) > 1)
732 return 1;
734 * The lock is not on behalf of a file manager, and no other
735 * tasks share this file owner (and, as long as this task is
736 * stuck waiting for a lock, that's not going to change):
738 return 0;
741 /* Find a lock that the owner of the given block_fl is blocking on. */
742 static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
744 struct file_lock *fl;
746 list_for_each_entry(fl, &blocked_list, fl_link)
747 if (posix_same_owner(fl, block_fl))
748 return fl->fl_next;
749 return NULL;
752 static int posix_locks_deadlock(struct file_lock *caller_fl,
753 struct file_lock *block_fl)
755 if (posix_owner_shared(caller_fl))
756 return 0;
758 while ((block_fl = what_owner_is_waiting_for(block_fl)))
759 if (posix_same_owner(caller_fl, block_fl))
760 return 1;
761 return 0;
764 /* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
765 * after any leases, but before any posix locks.
767 * Note that if called with an FL_EXISTS argument, the caller may determine
768 * whether or not a lock was successfully freed by testing the return
769 * value for -ENOENT.
771 static int flock_lock_file(struct file *filp, struct file_lock *request)
773 struct file_lock *new_fl = NULL;
774 struct file_lock **before;
775 struct inode * inode = filp->f_path.dentry->d_inode;
776 int error = 0;
777 int found = 0;
779 lock_kernel();
780 if (request->fl_flags & FL_ACCESS)
781 goto find_conflict;
783 if (request->fl_type != F_UNLCK) {
784 error = -ENOMEM;
785 new_fl = locks_alloc_lock();
786 if (new_fl == NULL)
787 goto out;
788 error = 0;
791 for_each_lock(inode, before) {
792 struct file_lock *fl = *before;
793 if (IS_POSIX(fl))
794 break;
795 if (IS_LEASE(fl))
796 continue;
797 if (filp != fl->fl_file)
798 continue;
799 if (request->fl_type == fl->fl_type)
800 goto out;
801 found = 1;
802 locks_delete_lock(before);
803 break;
806 if (request->fl_type == F_UNLCK) {
807 if ((request->fl_flags & FL_EXISTS) && !found)
808 error = -ENOENT;
809 goto out;
813 * If a higher-priority process was blocked on the old file lock,
814 * give it the opportunity to lock the file.
816 if (found)
817 cond_resched();
819 find_conflict:
820 for_each_lock(inode, before) {
821 struct file_lock *fl = *before;
822 if (IS_POSIX(fl))
823 break;
824 if (IS_LEASE(fl))
825 continue;
826 if (!flock_locks_conflict(request, fl))
827 continue;
828 error = -EAGAIN;
829 if (request->fl_flags & FL_SLEEP)
830 locks_insert_block(fl, request);
831 goto out;
833 if (request->fl_flags & FL_ACCESS)
834 goto out;
835 locks_copy_lock(new_fl, request);
836 locks_insert_lock(before, new_fl);
837 new_fl = NULL;
838 error = 0;
840 out:
841 unlock_kernel();
842 if (new_fl)
843 locks_free_lock(new_fl);
844 return error;
847 static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
849 struct file_lock *fl;
850 struct file_lock *new_fl = NULL;
851 struct file_lock *new_fl2 = NULL;
852 struct file_lock *left = NULL;
853 struct file_lock *right = NULL;
854 struct file_lock **before;
855 int error, added = 0;
858 * We may need two file_lock structures for this operation,
859 * so we get them in advance to avoid races.
861 * In some cases we can be sure, that no new locks will be needed
863 if (!(request->fl_flags & FL_ACCESS) &&
864 (request->fl_type != F_UNLCK ||
865 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
866 new_fl = locks_alloc_lock();
867 new_fl2 = locks_alloc_lock();
870 lock_kernel();
871 if (request->fl_type != F_UNLCK) {
872 for_each_lock(inode, before) {
873 fl = *before;
874 if (!IS_POSIX(fl))
875 continue;
876 if (!posix_locks_conflict(request, fl))
877 continue;
878 if (conflock)
879 locks_copy_lock(conflock, fl);
880 error = -EAGAIN;
881 if (!(request->fl_flags & FL_SLEEP))
882 goto out;
883 error = -EDEADLK;
884 if (posix_locks_deadlock(request, fl))
885 goto out;
886 error = -EAGAIN;
887 locks_insert_block(fl, request);
888 goto out;
892 /* If we're just looking for a conflict, we're done. */
893 error = 0;
894 if (request->fl_flags & FL_ACCESS)
895 goto out;
898 * Find the first old lock with the same owner as the new lock.
901 before = &inode->i_flock;
903 /* First skip locks owned by other processes. */
904 while ((fl = *before) && (!IS_POSIX(fl) ||
905 !posix_same_owner(request, fl))) {
906 before = &fl->fl_next;
909 /* Process locks with this owner. */
910 while ((fl = *before) && posix_same_owner(request, fl)) {
911 /* Detect adjacent or overlapping regions (if same lock type)
913 if (request->fl_type == fl->fl_type) {
914 /* In all comparisons of start vs end, use
915 * "start - 1" rather than "end + 1". If end
916 * is OFFSET_MAX, end + 1 will become negative.
918 if (fl->fl_end < request->fl_start - 1)
919 goto next_lock;
920 /* If the next lock in the list has entirely bigger
921 * addresses than the new one, insert the lock here.
923 if (fl->fl_start - 1 > request->fl_end)
924 break;
926 /* If we come here, the new and old lock are of the
927 * same type and adjacent or overlapping. Make one
928 * lock yielding from the lower start address of both
929 * locks to the higher end address.
931 if (fl->fl_start > request->fl_start)
932 fl->fl_start = request->fl_start;
933 else
934 request->fl_start = fl->fl_start;
935 if (fl->fl_end < request->fl_end)
936 fl->fl_end = request->fl_end;
937 else
938 request->fl_end = fl->fl_end;
939 if (added) {
940 locks_delete_lock(before);
941 continue;
943 request = fl;
944 added = 1;
946 else {
947 /* Processing for different lock types is a bit
948 * more complex.
950 if (fl->fl_end < request->fl_start)
951 goto next_lock;
952 if (fl->fl_start > request->fl_end)
953 break;
954 if (request->fl_type == F_UNLCK)
955 added = 1;
956 if (fl->fl_start < request->fl_start)
957 left = fl;
958 /* If the next lock in the list has a higher end
959 * address than the new one, insert the new one here.
961 if (fl->fl_end > request->fl_end) {
962 right = fl;
963 break;
965 if (fl->fl_start >= request->fl_start) {
966 /* The new lock completely replaces an old
967 * one (This may happen several times).
969 if (added) {
970 locks_delete_lock(before);
971 continue;
973 /* Replace the old lock with the new one.
974 * Wake up anybody waiting for the old one,
975 * as the change in lock type might satisfy
976 * their needs.
978 locks_wake_up_blocks(fl);
979 fl->fl_start = request->fl_start;
980 fl->fl_end = request->fl_end;
981 fl->fl_type = request->fl_type;
982 locks_release_private(fl);
983 locks_copy_private(fl, request);
984 request = fl;
985 added = 1;
988 /* Go on to next lock.
990 next_lock:
991 before = &fl->fl_next;
995 * The above code only modifies existing locks in case of
996 * merging or replacing. If new lock(s) need to be inserted
997 * all modifications are done bellow this, so it's safe yet to
998 * bail out.
1000 error = -ENOLCK; /* "no luck" */
1001 if (right && left == right && !new_fl2)
1002 goto out;
1004 error = 0;
1005 if (!added) {
1006 if (request->fl_type == F_UNLCK) {
1007 if (request->fl_flags & FL_EXISTS)
1008 error = -ENOENT;
1009 goto out;
1012 if (!new_fl) {
1013 error = -ENOLCK;
1014 goto out;
1016 locks_copy_lock(new_fl, request);
1017 locks_insert_lock(before, new_fl);
1018 new_fl = NULL;
1020 if (right) {
1021 if (left == right) {
1022 /* The new lock breaks the old one in two pieces,
1023 * so we have to use the second new lock.
1025 left = new_fl2;
1026 new_fl2 = NULL;
1027 locks_copy_lock(left, right);
1028 locks_insert_lock(before, left);
1030 right->fl_start = request->fl_end + 1;
1031 locks_wake_up_blocks(right);
1033 if (left) {
1034 left->fl_end = request->fl_start - 1;
1035 locks_wake_up_blocks(left);
1037 out:
1038 unlock_kernel();
1040 * Free any unused locks.
1042 if (new_fl)
1043 locks_free_lock(new_fl);
1044 if (new_fl2)
1045 locks_free_lock(new_fl2);
1046 return error;
1050 * posix_lock_file - Apply a POSIX-style lock to a file
1051 * @filp: The file to apply the lock to
1052 * @fl: The lock to be applied
1053 * @conflock: Place to return a copy of the conflicting lock, if found.
1055 * Add a POSIX style lock to a file.
1056 * We merge adjacent & overlapping locks whenever possible.
1057 * POSIX locks are sorted by owner task, then by starting address
1059 * Note that if called with an FL_EXISTS argument, the caller may determine
1060 * whether or not a lock was successfully freed by testing the return
1061 * value for -ENOENT.
1063 int posix_lock_file(struct file *filp, struct file_lock *fl,
1064 struct file_lock *conflock)
1066 return __posix_lock_file(filp->f_path.dentry->d_inode, fl, conflock);
1068 EXPORT_SYMBOL(posix_lock_file);
1071 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1072 * @filp: The file to apply the lock to
1073 * @fl: The lock to be applied
1075 * Add a POSIX style lock to a file.
1076 * We merge adjacent & overlapping locks whenever possible.
1077 * POSIX locks are sorted by owner task, then by starting address
1079 int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1081 int error;
1082 might_sleep ();
1083 for (;;) {
1084 error = posix_lock_file(filp, fl, NULL);
1085 if ((error != -EAGAIN) || !(fl->fl_flags & FL_SLEEP))
1086 break;
1087 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1088 if (!error)
1089 continue;
1091 locks_delete_block(fl);
1092 break;
1094 return error;
1096 EXPORT_SYMBOL(posix_lock_file_wait);
1099 * locks_mandatory_locked - Check for an active lock
1100 * @inode: the file to check
1102 * Searches the inode's list of locks to find any POSIX locks which conflict.
1103 * This function is called from locks_verify_locked() only.
1105 int locks_mandatory_locked(struct inode *inode)
1107 fl_owner_t owner = current->files;
1108 struct file_lock *fl;
1111 * Search the lock list for this inode for any POSIX locks.
1113 lock_kernel();
1114 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1115 if (!IS_POSIX(fl))
1116 continue;
1117 if (fl->fl_owner != owner)
1118 break;
1120 unlock_kernel();
1121 return fl ? -EAGAIN : 0;
1125 * locks_mandatory_area - Check for a conflicting lock
1126 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1127 * for shared
1128 * @inode: the file to check
1129 * @filp: how the file was opened (if it was)
1130 * @offset: start of area to check
1131 * @count: length of area to check
1133 * Searches the inode's list of locks to find any POSIX locks which conflict.
1134 * This function is called from rw_verify_area() and
1135 * locks_verify_truncate().
1137 int locks_mandatory_area(int read_write, struct inode *inode,
1138 struct file *filp, loff_t offset,
1139 size_t count)
1141 struct file_lock fl;
1142 int error;
1144 locks_init_lock(&fl);
1145 fl.fl_owner = current->files;
1146 fl.fl_pid = current->tgid;
1147 fl.fl_file = filp;
1148 fl.fl_flags = FL_POSIX | FL_ACCESS;
1149 if (filp && !(filp->f_flags & O_NONBLOCK))
1150 fl.fl_flags |= FL_SLEEP;
1151 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1152 fl.fl_start = offset;
1153 fl.fl_end = offset + count - 1;
1155 for (;;) {
1156 error = __posix_lock_file(inode, &fl, NULL);
1157 if (error != -EAGAIN)
1158 break;
1159 if (!(fl.fl_flags & FL_SLEEP))
1160 break;
1161 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1162 if (!error) {
1164 * If we've been sleeping someone might have
1165 * changed the permissions behind our back.
1167 if (__mandatory_lock(inode))
1168 continue;
1171 locks_delete_block(&fl);
1172 break;
1175 return error;
1178 EXPORT_SYMBOL(locks_mandatory_area);
1180 /* We already had a lease on this file; just change its type */
1181 int lease_modify(struct file_lock **before, int arg)
1183 struct file_lock *fl = *before;
1184 int error = assign_type(fl, arg);
1186 if (error)
1187 return error;
1188 locks_wake_up_blocks(fl);
1189 if (arg == F_UNLCK)
1190 locks_delete_lock(before);
1191 return 0;
1194 EXPORT_SYMBOL(lease_modify);
1196 static void time_out_leases(struct inode *inode)
1198 struct file_lock **before;
1199 struct file_lock *fl;
1201 before = &inode->i_flock;
1202 while ((fl = *before) && IS_LEASE(fl) && (fl->fl_type & F_INPROGRESS)) {
1203 if ((fl->fl_break_time == 0)
1204 || time_before(jiffies, fl->fl_break_time)) {
1205 before = &fl->fl_next;
1206 continue;
1208 lease_modify(before, fl->fl_type & ~F_INPROGRESS);
1209 if (fl == *before) /* lease_modify may have freed fl */
1210 before = &fl->fl_next;
1215 * __break_lease - revoke all outstanding leases on file
1216 * @inode: the inode of the file to return
1217 * @mode: the open mode (read or write)
1219 * break_lease (inlined for speed) has checked there already is at least
1220 * some kind of lock (maybe a lease) on this file. Leases are broken on
1221 * a call to open() or truncate(). This function can sleep unless you
1222 * specified %O_NONBLOCK to your open().
1224 int __break_lease(struct inode *inode, unsigned int mode)
1226 int error = 0, future;
1227 struct file_lock *new_fl, *flock;
1228 struct file_lock *fl;
1229 unsigned long break_time;
1230 int i_have_this_lease = 0;
1232 new_fl = lease_alloc(NULL, mode & FMODE_WRITE ? F_WRLCK : F_RDLCK);
1234 lock_kernel();
1236 time_out_leases(inode);
1238 flock = inode->i_flock;
1239 if ((flock == NULL) || !IS_LEASE(flock))
1240 goto out;
1242 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next)
1243 if (fl->fl_owner == current->files)
1244 i_have_this_lease = 1;
1246 if (mode & FMODE_WRITE) {
1247 /* If we want write access, we have to revoke any lease. */
1248 future = F_UNLCK | F_INPROGRESS;
1249 } else if (flock->fl_type & F_INPROGRESS) {
1250 /* If the lease is already being broken, we just leave it */
1251 future = flock->fl_type;
1252 } else if (flock->fl_type & F_WRLCK) {
1253 /* Downgrade the exclusive lease to a read-only lease. */
1254 future = F_RDLCK | F_INPROGRESS;
1255 } else {
1256 /* the existing lease was read-only, so we can read too. */
1257 goto out;
1260 if (IS_ERR(new_fl) && !i_have_this_lease
1261 && ((mode & O_NONBLOCK) == 0)) {
1262 error = PTR_ERR(new_fl);
1263 goto out;
1266 break_time = 0;
1267 if (lease_break_time > 0) {
1268 break_time = jiffies + lease_break_time * HZ;
1269 if (break_time == 0)
1270 break_time++; /* so that 0 means no break time */
1273 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1274 if (fl->fl_type != future) {
1275 fl->fl_type = future;
1276 fl->fl_break_time = break_time;
1277 /* lease must have lmops break callback */
1278 fl->fl_lmops->fl_break(fl);
1282 if (i_have_this_lease || (mode & O_NONBLOCK)) {
1283 error = -EWOULDBLOCK;
1284 goto out;
1287 restart:
1288 break_time = flock->fl_break_time;
1289 if (break_time != 0) {
1290 break_time -= jiffies;
1291 if (break_time == 0)
1292 break_time++;
1294 error = locks_block_on_timeout(flock, new_fl, break_time);
1295 if (error >= 0) {
1296 if (error == 0)
1297 time_out_leases(inode);
1298 /* Wait for the next lease that has not been broken yet */
1299 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1300 flock = flock->fl_next) {
1301 if (flock->fl_type & F_INPROGRESS)
1302 goto restart;
1304 error = 0;
1307 out:
1308 unlock_kernel();
1309 if (!IS_ERR(new_fl))
1310 locks_free_lock(new_fl);
1311 return error;
1314 EXPORT_SYMBOL(__break_lease);
1317 * lease_get_mtime
1318 * @inode: the inode
1319 * @time: pointer to a timespec which will contain the last modified time
1321 * This is to force NFS clients to flush their caches for files with
1322 * exclusive leases. The justification is that if someone has an
1323 * exclusive lease, then they could be modifiying it.
1325 void lease_get_mtime(struct inode *inode, struct timespec *time)
1327 struct file_lock *flock = inode->i_flock;
1328 if (flock && IS_LEASE(flock) && (flock->fl_type & F_WRLCK))
1329 *time = current_fs_time(inode->i_sb);
1330 else
1331 *time = inode->i_mtime;
1334 EXPORT_SYMBOL(lease_get_mtime);
1337 * fcntl_getlease - Enquire what lease is currently active
1338 * @filp: the file
1340 * The value returned by this function will be one of
1341 * (if no lease break is pending):
1343 * %F_RDLCK to indicate a shared lease is held.
1345 * %F_WRLCK to indicate an exclusive lease is held.
1347 * %F_UNLCK to indicate no lease is held.
1349 * (if a lease break is pending):
1351 * %F_RDLCK to indicate an exclusive lease needs to be
1352 * changed to a shared lease (or removed).
1354 * %F_UNLCK to indicate the lease needs to be removed.
1356 * XXX: sfr & willy disagree over whether F_INPROGRESS
1357 * should be returned to userspace.
1359 int fcntl_getlease(struct file *filp)
1361 struct file_lock *fl;
1362 int type = F_UNLCK;
1364 lock_kernel();
1365 time_out_leases(filp->f_path.dentry->d_inode);
1366 for (fl = filp->f_path.dentry->d_inode->i_flock; fl && IS_LEASE(fl);
1367 fl = fl->fl_next) {
1368 if (fl->fl_file == filp) {
1369 type = fl->fl_type & ~F_INPROGRESS;
1370 break;
1373 unlock_kernel();
1374 return type;
1378 * generic_setlease - sets a lease on an open file
1379 * @filp: file pointer
1380 * @arg: type of lease to obtain
1381 * @flp: input - file_lock to use, output - file_lock inserted
1383 * The (input) flp->fl_lmops->fl_break function is required
1384 * by break_lease().
1386 * Called with kernel lock held.
1388 int generic_setlease(struct file *filp, long arg, struct file_lock **flp)
1390 struct file_lock *fl, **before, **my_before = NULL, *lease;
1391 struct file_lock *new_fl = NULL;
1392 struct dentry *dentry = filp->f_path.dentry;
1393 struct inode *inode = dentry->d_inode;
1394 int error, rdlease_count = 0, wrlease_count = 0;
1396 if ((current->fsuid != inode->i_uid) && !capable(CAP_LEASE))
1397 return -EACCES;
1398 if (!S_ISREG(inode->i_mode))
1399 return -EINVAL;
1400 error = security_file_lock(filp, arg);
1401 if (error)
1402 return error;
1404 time_out_leases(inode);
1406 BUG_ON(!(*flp)->fl_lmops->fl_break);
1408 lease = *flp;
1410 error = -EAGAIN;
1411 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1412 goto out;
1413 if ((arg == F_WRLCK)
1414 && ((atomic_read(&dentry->d_count) > 1)
1415 || (atomic_read(&inode->i_count) > 1)))
1416 goto out;
1418 error = -ENOMEM;
1419 new_fl = locks_alloc_lock();
1420 if (new_fl == NULL)
1421 goto out;
1424 * At this point, we know that if there is an exclusive
1425 * lease on this file, then we hold it on this filp
1426 * (otherwise our open of this file would have blocked).
1427 * And if we are trying to acquire an exclusive lease,
1428 * then the file is not open by anyone (including us)
1429 * except for this filp.
1431 for (before = &inode->i_flock;
1432 ((fl = *before) != NULL) && IS_LEASE(fl);
1433 before = &fl->fl_next) {
1434 if (lease->fl_lmops->fl_mylease(fl, lease))
1435 my_before = before;
1436 else if (fl->fl_type == (F_INPROGRESS | F_UNLCK))
1438 * Someone is in the process of opening this
1439 * file for writing so we may not take an
1440 * exclusive lease on it.
1442 wrlease_count++;
1443 else
1444 rdlease_count++;
1447 if ((arg == F_RDLCK && (wrlease_count > 0)) ||
1448 (arg == F_WRLCK && ((rdlease_count + wrlease_count) > 0)))
1449 goto out;
1451 if (my_before != NULL) {
1452 *flp = *my_before;
1453 error = lease->fl_lmops->fl_change(my_before, arg);
1454 goto out;
1457 error = 0;
1458 if (arg == F_UNLCK)
1459 goto out;
1461 error = -EINVAL;
1462 if (!leases_enable)
1463 goto out;
1465 locks_copy_lock(new_fl, lease);
1466 locks_insert_lock(before, new_fl);
1468 *flp = new_fl;
1469 return 0;
1471 out:
1472 if (new_fl != NULL)
1473 locks_free_lock(new_fl);
1474 return error;
1476 EXPORT_SYMBOL(generic_setlease);
1479 * vfs_setlease - sets a lease on an open file
1480 * @filp: file pointer
1481 * @arg: type of lease to obtain
1482 * @lease: file_lock to use
1484 * Call this to establish a lease on the file.
1485 * The (*lease)->fl_lmops->fl_break operation must be set; if not,
1486 * break_lease will oops!
1488 * This will call the filesystem's setlease file method, if
1489 * defined. Note that there is no getlease method; instead, the
1490 * filesystem setlease method should call back to setlease() to
1491 * add a lease to the inode's lease list, where fcntl_getlease() can
1492 * find it. Since fcntl_getlease() only reports whether the current
1493 * task holds a lease, a cluster filesystem need only do this for
1494 * leases held by processes on this node.
1496 * There is also no break_lease method; filesystems that
1497 * handle their own leases shoud break leases themselves from the
1498 * filesystem's open, create, and (on truncate) setattr methods.
1500 * Warning: the only current setlease methods exist only to disable
1501 * leases in certain cases. More vfs changes may be required to
1502 * allow a full filesystem lease implementation.
1505 int vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
1507 int error;
1509 lock_kernel();
1510 if (filp->f_op && filp->f_op->setlease)
1511 error = filp->f_op->setlease(filp, arg, lease);
1512 else
1513 error = generic_setlease(filp, arg, lease);
1514 unlock_kernel();
1516 return error;
1518 EXPORT_SYMBOL_GPL(vfs_setlease);
1521 * fcntl_setlease - sets a lease on an open file
1522 * @fd: open file descriptor
1523 * @filp: file pointer
1524 * @arg: type of lease to obtain
1526 * Call this fcntl to establish a lease on the file.
1527 * Note that you also need to call %F_SETSIG to
1528 * receive a signal when the lease is broken.
1530 int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1532 struct file_lock fl, *flp = &fl;
1533 struct dentry *dentry = filp->f_path.dentry;
1534 struct inode *inode = dentry->d_inode;
1535 int error;
1537 locks_init_lock(&fl);
1538 error = lease_init(filp, arg, &fl);
1539 if (error)
1540 return error;
1542 lock_kernel();
1544 error = vfs_setlease(filp, arg, &flp);
1545 if (error || arg == F_UNLCK)
1546 goto out_unlock;
1548 error = fasync_helper(fd, filp, 1, &flp->fl_fasync);
1549 if (error < 0) {
1550 /* remove lease just inserted by setlease */
1551 flp->fl_type = F_UNLCK | F_INPROGRESS;
1552 flp->fl_break_time = jiffies - 10;
1553 time_out_leases(inode);
1554 goto out_unlock;
1557 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
1558 out_unlock:
1559 unlock_kernel();
1560 return error;
1564 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1565 * @filp: The file to apply the lock to
1566 * @fl: The lock to be applied
1568 * Add a FLOCK style lock to a file.
1570 int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1572 int error;
1573 might_sleep();
1574 for (;;) {
1575 error = flock_lock_file(filp, fl);
1576 if ((error != -EAGAIN) || !(fl->fl_flags & FL_SLEEP))
1577 break;
1578 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1579 if (!error)
1580 continue;
1582 locks_delete_block(fl);
1583 break;
1585 return error;
1588 EXPORT_SYMBOL(flock_lock_file_wait);
1591 * sys_flock: - flock() system call.
1592 * @fd: the file descriptor to lock.
1593 * @cmd: the type of lock to apply.
1595 * Apply a %FL_FLOCK style lock to an open file descriptor.
1596 * The @cmd can be one of
1598 * %LOCK_SH -- a shared lock.
1600 * %LOCK_EX -- an exclusive lock.
1602 * %LOCK_UN -- remove an existing lock.
1604 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1606 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1607 * processes read and write access respectively.
1609 asmlinkage long sys_flock(unsigned int fd, unsigned int cmd)
1611 struct file *filp;
1612 struct file_lock *lock;
1613 int can_sleep, unlock;
1614 int error;
1616 error = -EBADF;
1617 filp = fget(fd);
1618 if (!filp)
1619 goto out;
1621 can_sleep = !(cmd & LOCK_NB);
1622 cmd &= ~LOCK_NB;
1623 unlock = (cmd == LOCK_UN);
1625 if (!unlock && !(cmd & LOCK_MAND) && !(filp->f_mode & 3))
1626 goto out_putf;
1628 error = flock_make_lock(filp, &lock, cmd);
1629 if (error)
1630 goto out_putf;
1631 if (can_sleep)
1632 lock->fl_flags |= FL_SLEEP;
1634 error = security_file_lock(filp, cmd);
1635 if (error)
1636 goto out_free;
1638 if (filp->f_op && filp->f_op->flock)
1639 error = filp->f_op->flock(filp,
1640 (can_sleep) ? F_SETLKW : F_SETLK,
1641 lock);
1642 else
1643 error = flock_lock_file_wait(filp, lock);
1645 out_free:
1646 locks_free_lock(lock);
1648 out_putf:
1649 fput(filp);
1650 out:
1651 return error;
1655 * vfs_test_lock - test file byte range lock
1656 * @filp: The file to test lock for
1657 * @fl: The lock to test; also used to hold result
1659 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1660 * setting conf->fl_type to something other than F_UNLCK.
1662 int vfs_test_lock(struct file *filp, struct file_lock *fl)
1664 if (filp->f_op && filp->f_op->lock)
1665 return filp->f_op->lock(filp, F_GETLK, fl);
1666 posix_test_lock(filp, fl);
1667 return 0;
1669 EXPORT_SYMBOL_GPL(vfs_test_lock);
1671 static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1673 flock->l_pid = fl->fl_pid;
1674 #if BITS_PER_LONG == 32
1676 * Make sure we can represent the posix lock via
1677 * legacy 32bit flock.
1679 if (fl->fl_start > OFFT_OFFSET_MAX)
1680 return -EOVERFLOW;
1681 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1682 return -EOVERFLOW;
1683 #endif
1684 flock->l_start = fl->fl_start;
1685 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1686 fl->fl_end - fl->fl_start + 1;
1687 flock->l_whence = 0;
1688 flock->l_type = fl->fl_type;
1689 return 0;
1692 #if BITS_PER_LONG == 32
1693 static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1695 flock->l_pid = fl->fl_pid;
1696 flock->l_start = fl->fl_start;
1697 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1698 fl->fl_end - fl->fl_start + 1;
1699 flock->l_whence = 0;
1700 flock->l_type = fl->fl_type;
1702 #endif
1704 /* Report the first existing lock that would conflict with l.
1705 * This implements the F_GETLK command of fcntl().
1707 int fcntl_getlk(struct file *filp, struct flock __user *l)
1709 struct file_lock file_lock;
1710 struct flock flock;
1711 int error;
1713 error = -EFAULT;
1714 if (copy_from_user(&flock, l, sizeof(flock)))
1715 goto out;
1716 error = -EINVAL;
1717 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1718 goto out;
1720 error = flock_to_posix_lock(filp, &file_lock, &flock);
1721 if (error)
1722 goto out;
1724 error = vfs_test_lock(filp, &file_lock);
1725 if (error)
1726 goto out;
1728 flock.l_type = file_lock.fl_type;
1729 if (file_lock.fl_type != F_UNLCK) {
1730 error = posix_lock_to_flock(&flock, &file_lock);
1731 if (error)
1732 goto out;
1734 error = -EFAULT;
1735 if (!copy_to_user(l, &flock, sizeof(flock)))
1736 error = 0;
1737 out:
1738 return error;
1742 * vfs_lock_file - file byte range lock
1743 * @filp: The file to apply the lock to
1744 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1745 * @fl: The lock to be applied
1746 * @conf: Place to return a copy of the conflicting lock, if found.
1748 * A caller that doesn't care about the conflicting lock may pass NULL
1749 * as the final argument.
1751 * If the filesystem defines a private ->lock() method, then @conf will
1752 * be left unchanged; so a caller that cares should initialize it to
1753 * some acceptable default.
1755 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1756 * locks, the ->lock() interface may return asynchronously, before the lock has
1757 * been granted or denied by the underlying filesystem, if (and only if)
1758 * fl_grant is set. Callers expecting ->lock() to return asynchronously
1759 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1760 * the request is for a blocking lock. When ->lock() does return asynchronously,
1761 * it must return -EINPROGRESS, and call ->fl_grant() when the lock
1762 * request completes.
1763 * If the request is for non-blocking lock the file system should return
1764 * -EINPROGRESS then try to get the lock and call the callback routine with
1765 * the result. If the request timed out the callback routine will return a
1766 * nonzero return code and the file system should release the lock. The file
1767 * system is also responsible to keep a corresponding posix lock when it
1768 * grants a lock so the VFS can find out which locks are locally held and do
1769 * the correct lock cleanup when required.
1770 * The underlying filesystem must not drop the kernel lock or call
1771 * ->fl_grant() before returning to the caller with a -EINPROGRESS
1772 * return code.
1774 int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
1776 if (filp->f_op && filp->f_op->lock)
1777 return filp->f_op->lock(filp, cmd, fl);
1778 else
1779 return posix_lock_file(filp, fl, conf);
1781 EXPORT_SYMBOL_GPL(vfs_lock_file);
1783 /* Apply the lock described by l to an open file descriptor.
1784 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1786 int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
1787 struct flock __user *l)
1789 struct file_lock *file_lock = locks_alloc_lock();
1790 struct flock flock;
1791 struct inode *inode;
1792 int error;
1794 if (file_lock == NULL)
1795 return -ENOLCK;
1798 * This might block, so we do it before checking the inode.
1800 error = -EFAULT;
1801 if (copy_from_user(&flock, l, sizeof(flock)))
1802 goto out;
1804 inode = filp->f_path.dentry->d_inode;
1806 /* Don't allow mandatory locks on files that may be memory mapped
1807 * and shared.
1809 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
1810 error = -EAGAIN;
1811 goto out;
1814 again:
1815 error = flock_to_posix_lock(filp, file_lock, &flock);
1816 if (error)
1817 goto out;
1818 if (cmd == F_SETLKW) {
1819 file_lock->fl_flags |= FL_SLEEP;
1822 error = -EBADF;
1823 switch (flock.l_type) {
1824 case F_RDLCK:
1825 if (!(filp->f_mode & FMODE_READ))
1826 goto out;
1827 break;
1828 case F_WRLCK:
1829 if (!(filp->f_mode & FMODE_WRITE))
1830 goto out;
1831 break;
1832 case F_UNLCK:
1833 break;
1834 default:
1835 error = -EINVAL;
1836 goto out;
1839 error = security_file_lock(filp, file_lock->fl_type);
1840 if (error)
1841 goto out;
1843 for (;;) {
1844 error = vfs_lock_file(filp, cmd, file_lock, NULL);
1845 if (error != -EAGAIN || cmd == F_SETLK)
1846 break;
1847 error = wait_event_interruptible(file_lock->fl_wait,
1848 !file_lock->fl_next);
1849 if (!error)
1850 continue;
1852 locks_delete_block(file_lock);
1853 break;
1857 * Attempt to detect a close/fcntl race and recover by
1858 * releasing the lock that was just acquired.
1860 if (!error && fcheck(fd) != filp && flock.l_type != F_UNLCK) {
1861 flock.l_type = F_UNLCK;
1862 goto again;
1865 out:
1866 locks_free_lock(file_lock);
1867 return error;
1870 #if BITS_PER_LONG == 32
1871 /* Report the first existing lock that would conflict with l.
1872 * This implements the F_GETLK command of fcntl().
1874 int fcntl_getlk64(struct file *filp, struct flock64 __user *l)
1876 struct file_lock file_lock;
1877 struct flock64 flock;
1878 int error;
1880 error = -EFAULT;
1881 if (copy_from_user(&flock, l, sizeof(flock)))
1882 goto out;
1883 error = -EINVAL;
1884 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1885 goto out;
1887 error = flock64_to_posix_lock(filp, &file_lock, &flock);
1888 if (error)
1889 goto out;
1891 error = vfs_test_lock(filp, &file_lock);
1892 if (error)
1893 goto out;
1895 flock.l_type = file_lock.fl_type;
1896 if (file_lock.fl_type != F_UNLCK)
1897 posix_lock_to_flock64(&flock, &file_lock);
1899 error = -EFAULT;
1900 if (!copy_to_user(l, &flock, sizeof(flock)))
1901 error = 0;
1903 out:
1904 return error;
1907 /* Apply the lock described by l to an open file descriptor.
1908 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1910 int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
1911 struct flock64 __user *l)
1913 struct file_lock *file_lock = locks_alloc_lock();
1914 struct flock64 flock;
1915 struct inode *inode;
1916 int error;
1918 if (file_lock == NULL)
1919 return -ENOLCK;
1922 * This might block, so we do it before checking the inode.
1924 error = -EFAULT;
1925 if (copy_from_user(&flock, l, sizeof(flock)))
1926 goto out;
1928 inode = filp->f_path.dentry->d_inode;
1930 /* Don't allow mandatory locks on files that may be memory mapped
1931 * and shared.
1933 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
1934 error = -EAGAIN;
1935 goto out;
1938 again:
1939 error = flock64_to_posix_lock(filp, file_lock, &flock);
1940 if (error)
1941 goto out;
1942 if (cmd == F_SETLKW64) {
1943 file_lock->fl_flags |= FL_SLEEP;
1946 error = -EBADF;
1947 switch (flock.l_type) {
1948 case F_RDLCK:
1949 if (!(filp->f_mode & FMODE_READ))
1950 goto out;
1951 break;
1952 case F_WRLCK:
1953 if (!(filp->f_mode & FMODE_WRITE))
1954 goto out;
1955 break;
1956 case F_UNLCK:
1957 break;
1958 default:
1959 error = -EINVAL;
1960 goto out;
1963 error = security_file_lock(filp, file_lock->fl_type);
1964 if (error)
1965 goto out;
1967 for (;;) {
1968 error = vfs_lock_file(filp, cmd, file_lock, NULL);
1969 if (error != -EAGAIN || cmd == F_SETLK64)
1970 break;
1971 error = wait_event_interruptible(file_lock->fl_wait,
1972 !file_lock->fl_next);
1973 if (!error)
1974 continue;
1976 locks_delete_block(file_lock);
1977 break;
1981 * Attempt to detect a close/fcntl race and recover by
1982 * releasing the lock that was just acquired.
1984 if (!error && fcheck(fd) != filp && flock.l_type != F_UNLCK) {
1985 flock.l_type = F_UNLCK;
1986 goto again;
1989 out:
1990 locks_free_lock(file_lock);
1991 return error;
1993 #endif /* BITS_PER_LONG == 32 */
1996 * This function is called when the file is being removed
1997 * from the task's fd array. POSIX locks belonging to this task
1998 * are deleted at this time.
2000 void locks_remove_posix(struct file *filp, fl_owner_t owner)
2002 struct file_lock lock;
2005 * If there are no locks held on this file, we don't need to call
2006 * posix_lock_file(). Another process could be setting a lock on this
2007 * file at the same time, but we wouldn't remove that lock anyway.
2009 if (!filp->f_path.dentry->d_inode->i_flock)
2010 return;
2012 lock.fl_type = F_UNLCK;
2013 lock.fl_flags = FL_POSIX | FL_CLOSE;
2014 lock.fl_start = 0;
2015 lock.fl_end = OFFSET_MAX;
2016 lock.fl_owner = owner;
2017 lock.fl_pid = current->tgid;
2018 lock.fl_file = filp;
2019 lock.fl_ops = NULL;
2020 lock.fl_lmops = NULL;
2022 vfs_lock_file(filp, F_SETLK, &lock, NULL);
2024 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2025 lock.fl_ops->fl_release_private(&lock);
2028 EXPORT_SYMBOL(locks_remove_posix);
2031 * This function is called on the last close of an open file.
2033 void locks_remove_flock(struct file *filp)
2035 struct inode * inode = filp->f_path.dentry->d_inode;
2036 struct file_lock *fl;
2037 struct file_lock **before;
2039 if (!inode->i_flock)
2040 return;
2042 if (filp->f_op && filp->f_op->flock) {
2043 struct file_lock fl = {
2044 .fl_pid = current->tgid,
2045 .fl_file = filp,
2046 .fl_flags = FL_FLOCK,
2047 .fl_type = F_UNLCK,
2048 .fl_end = OFFSET_MAX,
2050 filp->f_op->flock(filp, F_SETLKW, &fl);
2051 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2052 fl.fl_ops->fl_release_private(&fl);
2055 lock_kernel();
2056 before = &inode->i_flock;
2058 while ((fl = *before) != NULL) {
2059 if (fl->fl_file == filp) {
2060 if (IS_FLOCK(fl)) {
2061 locks_delete_lock(before);
2062 continue;
2064 if (IS_LEASE(fl)) {
2065 lease_modify(before, F_UNLCK);
2066 continue;
2068 /* What? */
2069 BUG();
2071 before = &fl->fl_next;
2073 unlock_kernel();
2077 * posix_unblock_lock - stop waiting for a file lock
2078 * @filp: how the file was opened
2079 * @waiter: the lock which was waiting
2081 * lockd needs to block waiting for locks.
2084 posix_unblock_lock(struct file *filp, struct file_lock *waiter)
2086 int status = 0;
2088 lock_kernel();
2089 if (waiter->fl_next)
2090 __locks_delete_block(waiter);
2091 else
2092 status = -ENOENT;
2093 unlock_kernel();
2094 return status;
2097 EXPORT_SYMBOL(posix_unblock_lock);
2100 * vfs_cancel_lock - file byte range unblock lock
2101 * @filp: The file to apply the unblock to
2102 * @fl: The lock to be unblocked
2104 * Used by lock managers to cancel blocked requests
2106 int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2108 if (filp->f_op && filp->f_op->lock)
2109 return filp->f_op->lock(filp, F_CANCELLK, fl);
2110 return 0;
2113 EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2115 #ifdef CONFIG_PROC_FS
2116 #include <linux/seq_file.h>
2118 static void lock_get_status(struct seq_file *f, struct file_lock *fl,
2119 int id, char *pfx)
2121 struct inode *inode = NULL;
2123 if (fl->fl_file != NULL)
2124 inode = fl->fl_file->f_path.dentry->d_inode;
2126 seq_printf(f, "%d:%s ", id, pfx);
2127 if (IS_POSIX(fl)) {
2128 seq_printf(f, "%6s %s ",
2129 (fl->fl_flags & FL_ACCESS) ? "ACCESS" : "POSIX ",
2130 (inode == NULL) ? "*NOINODE*" :
2131 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
2132 } else if (IS_FLOCK(fl)) {
2133 if (fl->fl_type & LOCK_MAND) {
2134 seq_printf(f, "FLOCK MSNFS ");
2135 } else {
2136 seq_printf(f, "FLOCK ADVISORY ");
2138 } else if (IS_LEASE(fl)) {
2139 seq_printf(f, "LEASE ");
2140 if (fl->fl_type & F_INPROGRESS)
2141 seq_printf(f, "BREAKING ");
2142 else if (fl->fl_file)
2143 seq_printf(f, "ACTIVE ");
2144 else
2145 seq_printf(f, "BREAKER ");
2146 } else {
2147 seq_printf(f, "UNKNOWN UNKNOWN ");
2149 if (fl->fl_type & LOCK_MAND) {
2150 seq_printf(f, "%s ",
2151 (fl->fl_type & LOCK_READ)
2152 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2153 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2154 } else {
2155 seq_printf(f, "%s ",
2156 (fl->fl_type & F_INPROGRESS)
2157 ? (fl->fl_type & F_UNLCK) ? "UNLCK" : "READ "
2158 : (fl->fl_type & F_WRLCK) ? "WRITE" : "READ ");
2160 if (inode) {
2161 #ifdef WE_CAN_BREAK_LSLK_NOW
2162 seq_printf(f, "%d %s:%ld ", fl->fl_pid,
2163 inode->i_sb->s_id, inode->i_ino);
2164 #else
2165 /* userspace relies on this representation of dev_t ;-( */
2166 seq_printf(f, "%d %02x:%02x:%ld ", fl->fl_pid,
2167 MAJOR(inode->i_sb->s_dev),
2168 MINOR(inode->i_sb->s_dev), inode->i_ino);
2169 #endif
2170 } else {
2171 seq_printf(f, "%d <none>:0 ", fl->fl_pid);
2173 if (IS_POSIX(fl)) {
2174 if (fl->fl_end == OFFSET_MAX)
2175 seq_printf(f, "%Ld EOF\n", fl->fl_start);
2176 else
2177 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
2178 } else {
2179 seq_printf(f, "0 EOF\n");
2183 static int locks_show(struct seq_file *f, void *v)
2185 struct file_lock *fl, *bfl;
2187 fl = list_entry(v, struct file_lock, fl_link);
2189 lock_get_status(f, fl, (long)f->private, "");
2191 list_for_each_entry(bfl, &fl->fl_block, fl_block)
2192 lock_get_status(f, bfl, (long)f->private, " ->");
2194 f->private++;
2195 return 0;
2198 static void *locks_start(struct seq_file *f, loff_t *pos)
2200 lock_kernel();
2201 f->private = (void *)1;
2202 return seq_list_start(&file_lock_list, *pos);
2205 static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2207 return seq_list_next(v, &file_lock_list, pos);
2210 static void locks_stop(struct seq_file *f, void *v)
2212 unlock_kernel();
2215 struct seq_operations locks_seq_operations = {
2216 .start = locks_start,
2217 .next = locks_next,
2218 .stop = locks_stop,
2219 .show = locks_show,
2221 #endif
2224 * lock_may_read - checks that the region is free of locks
2225 * @inode: the inode that is being read
2226 * @start: the first byte to read
2227 * @len: the number of bytes to read
2229 * Emulates Windows locking requirements. Whole-file
2230 * mandatory locks (share modes) can prohibit a read and
2231 * byte-range POSIX locks can prohibit a read if they overlap.
2233 * N.B. this function is only ever called
2234 * from knfsd and ownership of locks is never checked.
2236 int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2238 struct file_lock *fl;
2239 int result = 1;
2240 lock_kernel();
2241 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2242 if (IS_POSIX(fl)) {
2243 if (fl->fl_type == F_RDLCK)
2244 continue;
2245 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2246 continue;
2247 } else if (IS_FLOCK(fl)) {
2248 if (!(fl->fl_type & LOCK_MAND))
2249 continue;
2250 if (fl->fl_type & LOCK_READ)
2251 continue;
2252 } else
2253 continue;
2254 result = 0;
2255 break;
2257 unlock_kernel();
2258 return result;
2261 EXPORT_SYMBOL(lock_may_read);
2264 * lock_may_write - checks that the region is free of locks
2265 * @inode: the inode that is being written
2266 * @start: the first byte to write
2267 * @len: the number of bytes to write
2269 * Emulates Windows locking requirements. Whole-file
2270 * mandatory locks (share modes) can prohibit a write and
2271 * byte-range POSIX locks can prohibit a write if they overlap.
2273 * N.B. this function is only ever called
2274 * from knfsd and ownership of locks is never checked.
2276 int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2278 struct file_lock *fl;
2279 int result = 1;
2280 lock_kernel();
2281 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2282 if (IS_POSIX(fl)) {
2283 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2284 continue;
2285 } else if (IS_FLOCK(fl)) {
2286 if (!(fl->fl_type & LOCK_MAND))
2287 continue;
2288 if (fl->fl_type & LOCK_WRITE)
2289 continue;
2290 } else
2291 continue;
2292 result = 0;
2293 break;
2295 unlock_kernel();
2296 return result;
2299 EXPORT_SYMBOL(lock_may_write);
2301 static int __init filelock_init(void)
2303 filelock_cache = kmem_cache_create("file_lock_cache",
2304 sizeof(struct file_lock), 0, SLAB_PANIC,
2305 init_once);
2306 return 0;
2309 core_initcall(filelock_init);