Committer: Michael Beasley <mike@snafu.setup>
[mikesnafu-overlay.git] / fs / locks.c
blob159e0f6044bc335874bbcaa01c240829ea7b4e55
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>
128 #include <linux/pid_namespace.h>
130 #include <asm/semaphore.h>
131 #include <asm/uaccess.h>
133 #define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
134 #define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
135 #define IS_LEASE(fl) (fl->fl_flags & FL_LEASE)
137 int leases_enable = 1;
138 int lease_break_time = 45;
140 #define for_each_lock(inode, lockp) \
141 for (lockp = &inode->i_flock; *lockp != NULL; lockp = &(*lockp)->fl_next)
143 static LIST_HEAD(file_lock_list);
144 static LIST_HEAD(blocked_list);
146 static struct kmem_cache *filelock_cache __read_mostly;
148 /* Allocate an empty lock structure. */
149 static struct file_lock *locks_alloc_lock(void)
151 return kmem_cache_alloc(filelock_cache, GFP_KERNEL);
154 static void locks_release_private(struct file_lock *fl)
156 if (fl->fl_ops) {
157 if (fl->fl_ops->fl_release_private)
158 fl->fl_ops->fl_release_private(fl);
159 fl->fl_ops = NULL;
161 if (fl->fl_lmops) {
162 if (fl->fl_lmops->fl_release_private)
163 fl->fl_lmops->fl_release_private(fl);
164 fl->fl_lmops = NULL;
169 /* Free a lock which is not in use. */
170 static void locks_free_lock(struct file_lock *fl)
172 BUG_ON(waitqueue_active(&fl->fl_wait));
173 BUG_ON(!list_empty(&fl->fl_block));
174 BUG_ON(!list_empty(&fl->fl_link));
176 locks_release_private(fl);
177 kmem_cache_free(filelock_cache, fl);
180 void locks_init_lock(struct file_lock *fl)
182 INIT_LIST_HEAD(&fl->fl_link);
183 INIT_LIST_HEAD(&fl->fl_block);
184 init_waitqueue_head(&fl->fl_wait);
185 fl->fl_next = NULL;
186 fl->fl_fasync = NULL;
187 fl->fl_owner = NULL;
188 fl->fl_pid = 0;
189 fl->fl_nspid = NULL;
190 fl->fl_file = NULL;
191 fl->fl_flags = 0;
192 fl->fl_type = 0;
193 fl->fl_start = fl->fl_end = 0;
194 fl->fl_ops = NULL;
195 fl->fl_lmops = NULL;
198 EXPORT_SYMBOL(locks_init_lock);
201 * Initialises the fields of the file lock which are invariant for
202 * free file_locks.
204 static void init_once(struct kmem_cache *cache, void *foo)
206 struct file_lock *lock = (struct file_lock *) foo;
208 locks_init_lock(lock);
211 static void locks_copy_private(struct file_lock *new, struct file_lock *fl)
213 if (fl->fl_ops) {
214 if (fl->fl_ops->fl_copy_lock)
215 fl->fl_ops->fl_copy_lock(new, fl);
216 new->fl_ops = fl->fl_ops;
218 if (fl->fl_lmops) {
219 if (fl->fl_lmops->fl_copy_lock)
220 fl->fl_lmops->fl_copy_lock(new, fl);
221 new->fl_lmops = fl->fl_lmops;
226 * Initialize a new lock from an existing file_lock structure.
228 static void __locks_copy_lock(struct file_lock *new, const struct file_lock *fl)
230 new->fl_owner = fl->fl_owner;
231 new->fl_pid = fl->fl_pid;
232 new->fl_file = NULL;
233 new->fl_flags = fl->fl_flags;
234 new->fl_type = fl->fl_type;
235 new->fl_start = fl->fl_start;
236 new->fl_end = fl->fl_end;
237 new->fl_ops = NULL;
238 new->fl_lmops = NULL;
241 void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
243 locks_release_private(new);
245 __locks_copy_lock(new, fl);
246 new->fl_file = fl->fl_file;
247 new->fl_ops = fl->fl_ops;
248 new->fl_lmops = fl->fl_lmops;
250 locks_copy_private(new, fl);
253 EXPORT_SYMBOL(locks_copy_lock);
255 static inline int flock_translate_cmd(int cmd) {
256 if (cmd & LOCK_MAND)
257 return cmd & (LOCK_MAND | LOCK_RW);
258 switch (cmd) {
259 case LOCK_SH:
260 return F_RDLCK;
261 case LOCK_EX:
262 return F_WRLCK;
263 case LOCK_UN:
264 return F_UNLCK;
266 return -EINVAL;
269 /* Fill in a file_lock structure with an appropriate FLOCK lock. */
270 static int flock_make_lock(struct file *filp, struct file_lock **lock,
271 unsigned int cmd)
273 struct file_lock *fl;
274 int type = flock_translate_cmd(cmd);
275 if (type < 0)
276 return type;
278 fl = locks_alloc_lock();
279 if (fl == NULL)
280 return -ENOMEM;
282 fl->fl_file = filp;
283 fl->fl_pid = current->tgid;
284 fl->fl_flags = FL_FLOCK;
285 fl->fl_type = type;
286 fl->fl_end = OFFSET_MAX;
288 *lock = fl;
289 return 0;
292 static int assign_type(struct file_lock *fl, int type)
294 switch (type) {
295 case F_RDLCK:
296 case F_WRLCK:
297 case F_UNLCK:
298 fl->fl_type = type;
299 break;
300 default:
301 return -EINVAL;
303 return 0;
306 /* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
307 * style lock.
309 static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
310 struct flock *l)
312 off_t start, end;
314 switch (l->l_whence) {
315 case SEEK_SET:
316 start = 0;
317 break;
318 case SEEK_CUR:
319 start = filp->f_pos;
320 break;
321 case SEEK_END:
322 start = i_size_read(filp->f_path.dentry->d_inode);
323 break;
324 default:
325 return -EINVAL;
328 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
329 POSIX-2001 defines it. */
330 start += l->l_start;
331 if (start < 0)
332 return -EINVAL;
333 fl->fl_end = OFFSET_MAX;
334 if (l->l_len > 0) {
335 end = start + l->l_len - 1;
336 fl->fl_end = end;
337 } else if (l->l_len < 0) {
338 end = start - 1;
339 fl->fl_end = end;
340 start += l->l_len;
341 if (start < 0)
342 return -EINVAL;
344 fl->fl_start = start; /* we record the absolute position */
345 if (fl->fl_end < fl->fl_start)
346 return -EOVERFLOW;
348 fl->fl_owner = current->files;
349 fl->fl_pid = current->tgid;
350 fl->fl_file = filp;
351 fl->fl_flags = FL_POSIX;
352 fl->fl_ops = NULL;
353 fl->fl_lmops = NULL;
355 return assign_type(fl, l->l_type);
358 #if BITS_PER_LONG == 32
359 static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
360 struct flock64 *l)
362 loff_t start;
364 switch (l->l_whence) {
365 case SEEK_SET:
366 start = 0;
367 break;
368 case SEEK_CUR:
369 start = filp->f_pos;
370 break;
371 case SEEK_END:
372 start = i_size_read(filp->f_path.dentry->d_inode);
373 break;
374 default:
375 return -EINVAL;
378 start += l->l_start;
379 if (start < 0)
380 return -EINVAL;
381 fl->fl_end = OFFSET_MAX;
382 if (l->l_len > 0) {
383 fl->fl_end = start + l->l_len - 1;
384 } else if (l->l_len < 0) {
385 fl->fl_end = start - 1;
386 start += l->l_len;
387 if (start < 0)
388 return -EINVAL;
390 fl->fl_start = start; /* we record the absolute position */
391 if (fl->fl_end < fl->fl_start)
392 return -EOVERFLOW;
394 fl->fl_owner = current->files;
395 fl->fl_pid = current->tgid;
396 fl->fl_file = filp;
397 fl->fl_flags = FL_POSIX;
398 fl->fl_ops = NULL;
399 fl->fl_lmops = NULL;
401 switch (l->l_type) {
402 case F_RDLCK:
403 case F_WRLCK:
404 case F_UNLCK:
405 fl->fl_type = l->l_type;
406 break;
407 default:
408 return -EINVAL;
411 return (0);
413 #endif
415 /* default lease lock manager operations */
416 static void lease_break_callback(struct file_lock *fl)
418 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
421 static void lease_release_private_callback(struct file_lock *fl)
423 if (!fl->fl_file)
424 return;
426 f_delown(fl->fl_file);
427 fl->fl_file->f_owner.signum = 0;
430 static int lease_mylease_callback(struct file_lock *fl, struct file_lock *try)
432 return fl->fl_file == try->fl_file;
435 static struct lock_manager_operations lease_manager_ops = {
436 .fl_break = lease_break_callback,
437 .fl_release_private = lease_release_private_callback,
438 .fl_mylease = lease_mylease_callback,
439 .fl_change = lease_modify,
443 * Initialize a lease, use the default lock manager operations
445 static int lease_init(struct file *filp, int type, struct file_lock *fl)
447 if (assign_type(fl, type) != 0)
448 return -EINVAL;
450 fl->fl_owner = current->files;
451 fl->fl_pid = current->tgid;
453 fl->fl_file = filp;
454 fl->fl_flags = FL_LEASE;
455 fl->fl_start = 0;
456 fl->fl_end = OFFSET_MAX;
457 fl->fl_ops = NULL;
458 fl->fl_lmops = &lease_manager_ops;
459 return 0;
462 /* Allocate a file_lock initialised to this type of lease */
463 static struct file_lock *lease_alloc(struct file *filp, int type)
465 struct file_lock *fl = locks_alloc_lock();
466 int error = -ENOMEM;
468 if (fl == NULL)
469 return ERR_PTR(error);
471 error = lease_init(filp, type, fl);
472 if (error) {
473 locks_free_lock(fl);
474 return ERR_PTR(error);
476 return fl;
479 /* Check if two locks overlap each other.
481 static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
483 return ((fl1->fl_end >= fl2->fl_start) &&
484 (fl2->fl_end >= fl1->fl_start));
488 * Check whether two locks have the same owner.
490 static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
492 if (fl1->fl_lmops && fl1->fl_lmops->fl_compare_owner)
493 return fl2->fl_lmops == fl1->fl_lmops &&
494 fl1->fl_lmops->fl_compare_owner(fl1, fl2);
495 return fl1->fl_owner == fl2->fl_owner;
498 /* Remove waiter from blocker's block list.
499 * When blocker ends up pointing to itself then the list is empty.
501 static void __locks_delete_block(struct file_lock *waiter)
503 list_del_init(&waiter->fl_block);
504 list_del_init(&waiter->fl_link);
505 waiter->fl_next = NULL;
510 static void locks_delete_block(struct file_lock *waiter)
512 lock_kernel();
513 __locks_delete_block(waiter);
514 unlock_kernel();
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))
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 fl->fl_nspid = get_pid(task_tgid(current));
560 /* insert into file's list */
561 fl->fl_next = *pos;
562 *pos = fl;
564 if (fl->fl_ops && fl->fl_ops->fl_insert)
565 fl->fl_ops->fl_insert(fl);
569 * Delete a lock and then free it.
570 * Wake up processes that are blocked waiting for this lock,
571 * notify the FS that the lock has been cleared and
572 * finally free the lock.
574 static void locks_delete_lock(struct file_lock **thisfl_p)
576 struct file_lock *fl = *thisfl_p;
578 *thisfl_p = fl->fl_next;
579 fl->fl_next = NULL;
580 list_del_init(&fl->fl_link);
582 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
583 if (fl->fl_fasync != NULL) {
584 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
585 fl->fl_fasync = NULL;
588 if (fl->fl_ops && fl->fl_ops->fl_remove)
589 fl->fl_ops->fl_remove(fl);
591 if (fl->fl_nspid) {
592 put_pid(fl->fl_nspid);
593 fl->fl_nspid = NULL;
596 locks_wake_up_blocks(fl);
597 locks_free_lock(fl);
600 /* Determine if lock sys_fl blocks lock caller_fl. Common functionality
601 * checks for shared/exclusive status of overlapping locks.
603 static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
605 if (sys_fl->fl_type == F_WRLCK)
606 return 1;
607 if (caller_fl->fl_type == F_WRLCK)
608 return 1;
609 return 0;
612 /* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
613 * checking before calling the locks_conflict().
615 static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
617 /* POSIX locks owned by the same process do not conflict with
618 * each other.
620 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
621 return (0);
623 /* Check whether they overlap */
624 if (!locks_overlap(caller_fl, sys_fl))
625 return 0;
627 return (locks_conflict(caller_fl, sys_fl));
630 /* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
631 * checking before calling the locks_conflict().
633 static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
635 /* FLOCK locks referring to the same filp do not conflict with
636 * each other.
638 if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
639 return (0);
640 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
641 return 0;
643 return (locks_conflict(caller_fl, sys_fl));
646 void
647 posix_test_lock(struct file *filp, struct file_lock *fl)
649 struct file_lock *cfl;
651 lock_kernel();
652 for (cfl = filp->f_path.dentry->d_inode->i_flock; cfl; cfl = cfl->fl_next) {
653 if (!IS_POSIX(cfl))
654 continue;
655 if (posix_locks_conflict(fl, cfl))
656 break;
658 if (cfl) {
659 __locks_copy_lock(fl, cfl);
660 if (cfl->fl_nspid)
661 fl->fl_pid = pid_vnr(cfl->fl_nspid);
662 } else
663 fl->fl_type = F_UNLCK;
664 unlock_kernel();
665 return;
667 EXPORT_SYMBOL(posix_test_lock);
670 * Deadlock detection:
672 * We attempt to detect deadlocks that are due purely to posix file
673 * locks.
675 * We assume that a task can be waiting for at most one lock at a time.
676 * So for any acquired lock, the process holding that lock may be
677 * waiting on at most one other lock. That lock in turns may be held by
678 * someone waiting for at most one other lock. Given a requested lock
679 * caller_fl which is about to wait for a conflicting lock block_fl, we
680 * follow this chain of waiters to ensure we are not about to create a
681 * cycle.
683 * Since we do this before we ever put a process to sleep on a lock, we
684 * are ensured that there is never a cycle; that is what guarantees that
685 * the while() loop in posix_locks_deadlock() eventually completes.
687 * Note: the above assumption may not be true when handling lock
688 * requests from a broken NFS client. It may also fail in the presence
689 * of tasks (such as posix threads) sharing the same open file table.
691 * To handle those cases, we just bail out after a few iterations.
694 #define MAX_DEADLK_ITERATIONS 10
696 /* Find a lock that the owner of the given block_fl is blocking on. */
697 static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
699 struct file_lock *fl;
701 list_for_each_entry(fl, &blocked_list, fl_link) {
702 if (posix_same_owner(fl, block_fl))
703 return fl->fl_next;
705 return NULL;
708 static int posix_locks_deadlock(struct file_lock *caller_fl,
709 struct file_lock *block_fl)
711 int i = 0;
713 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
714 if (i++ > MAX_DEADLK_ITERATIONS)
715 return 0;
716 if (posix_same_owner(caller_fl, block_fl))
717 return 1;
719 return 0;
722 /* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
723 * after any leases, but before any posix locks.
725 * Note that if called with an FL_EXISTS argument, the caller may determine
726 * whether or not a lock was successfully freed by testing the return
727 * value for -ENOENT.
729 static int flock_lock_file(struct file *filp, struct file_lock *request)
731 struct file_lock *new_fl = NULL;
732 struct file_lock **before;
733 struct inode * inode = filp->f_path.dentry->d_inode;
734 int error = 0;
735 int found = 0;
737 lock_kernel();
738 if (request->fl_flags & FL_ACCESS)
739 goto find_conflict;
741 if (request->fl_type != F_UNLCK) {
742 error = -ENOMEM;
743 new_fl = locks_alloc_lock();
744 if (new_fl == NULL)
745 goto out;
746 error = 0;
749 for_each_lock(inode, before) {
750 struct file_lock *fl = *before;
751 if (IS_POSIX(fl))
752 break;
753 if (IS_LEASE(fl))
754 continue;
755 if (filp != fl->fl_file)
756 continue;
757 if (request->fl_type == fl->fl_type)
758 goto out;
759 found = 1;
760 locks_delete_lock(before);
761 break;
764 if (request->fl_type == F_UNLCK) {
765 if ((request->fl_flags & FL_EXISTS) && !found)
766 error = -ENOENT;
767 goto out;
771 * If a higher-priority process was blocked on the old file lock,
772 * give it the opportunity to lock the file.
774 if (found)
775 cond_resched();
777 find_conflict:
778 for_each_lock(inode, before) {
779 struct file_lock *fl = *before;
780 if (IS_POSIX(fl))
781 break;
782 if (IS_LEASE(fl))
783 continue;
784 if (!flock_locks_conflict(request, fl))
785 continue;
786 error = -EAGAIN;
787 if (request->fl_flags & FL_SLEEP)
788 locks_insert_block(fl, request);
789 goto out;
791 if (request->fl_flags & FL_ACCESS)
792 goto out;
793 locks_copy_lock(new_fl, request);
794 locks_insert_lock(before, new_fl);
795 new_fl = NULL;
796 error = 0;
798 out:
799 unlock_kernel();
800 if (new_fl)
801 locks_free_lock(new_fl);
802 return error;
805 static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
807 struct file_lock *fl;
808 struct file_lock *new_fl = NULL;
809 struct file_lock *new_fl2 = NULL;
810 struct file_lock *left = NULL;
811 struct file_lock *right = NULL;
812 struct file_lock **before;
813 int error, added = 0;
816 * We may need two file_lock structures for this operation,
817 * so we get them in advance to avoid races.
819 * In some cases we can be sure, that no new locks will be needed
821 if (!(request->fl_flags & FL_ACCESS) &&
822 (request->fl_type != F_UNLCK ||
823 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
824 new_fl = locks_alloc_lock();
825 new_fl2 = locks_alloc_lock();
828 lock_kernel();
829 if (request->fl_type != F_UNLCK) {
830 for_each_lock(inode, before) {
831 fl = *before;
832 if (!IS_POSIX(fl))
833 continue;
834 if (!posix_locks_conflict(request, fl))
835 continue;
836 if (conflock)
837 locks_copy_lock(conflock, fl);
838 error = -EAGAIN;
839 if (!(request->fl_flags & FL_SLEEP))
840 goto out;
841 error = -EDEADLK;
842 if (posix_locks_deadlock(request, fl))
843 goto out;
844 error = -EAGAIN;
845 locks_insert_block(fl, request);
846 goto out;
850 /* If we're just looking for a conflict, we're done. */
851 error = 0;
852 if (request->fl_flags & FL_ACCESS)
853 goto out;
856 * Find the first old lock with the same owner as the new lock.
859 before = &inode->i_flock;
861 /* First skip locks owned by other processes. */
862 while ((fl = *before) && (!IS_POSIX(fl) ||
863 !posix_same_owner(request, fl))) {
864 before = &fl->fl_next;
867 /* Process locks with this owner. */
868 while ((fl = *before) && posix_same_owner(request, fl)) {
869 /* Detect adjacent or overlapping regions (if same lock type)
871 if (request->fl_type == fl->fl_type) {
872 /* In all comparisons of start vs end, use
873 * "start - 1" rather than "end + 1". If end
874 * is OFFSET_MAX, end + 1 will become negative.
876 if (fl->fl_end < request->fl_start - 1)
877 goto next_lock;
878 /* If the next lock in the list has entirely bigger
879 * addresses than the new one, insert the lock here.
881 if (fl->fl_start - 1 > request->fl_end)
882 break;
884 /* If we come here, the new and old lock are of the
885 * same type and adjacent or overlapping. Make one
886 * lock yielding from the lower start address of both
887 * locks to the higher end address.
889 if (fl->fl_start > request->fl_start)
890 fl->fl_start = request->fl_start;
891 else
892 request->fl_start = fl->fl_start;
893 if (fl->fl_end < request->fl_end)
894 fl->fl_end = request->fl_end;
895 else
896 request->fl_end = fl->fl_end;
897 if (added) {
898 locks_delete_lock(before);
899 continue;
901 request = fl;
902 added = 1;
904 else {
905 /* Processing for different lock types is a bit
906 * more complex.
908 if (fl->fl_end < request->fl_start)
909 goto next_lock;
910 if (fl->fl_start > request->fl_end)
911 break;
912 if (request->fl_type == F_UNLCK)
913 added = 1;
914 if (fl->fl_start < request->fl_start)
915 left = fl;
916 /* If the next lock in the list has a higher end
917 * address than the new one, insert the new one here.
919 if (fl->fl_end > request->fl_end) {
920 right = fl;
921 break;
923 if (fl->fl_start >= request->fl_start) {
924 /* The new lock completely replaces an old
925 * one (This may happen several times).
927 if (added) {
928 locks_delete_lock(before);
929 continue;
931 /* Replace the old lock with the new one.
932 * Wake up anybody waiting for the old one,
933 * as the change in lock type might satisfy
934 * their needs.
936 locks_wake_up_blocks(fl);
937 fl->fl_start = request->fl_start;
938 fl->fl_end = request->fl_end;
939 fl->fl_type = request->fl_type;
940 locks_release_private(fl);
941 locks_copy_private(fl, request);
942 request = fl;
943 added = 1;
946 /* Go on to next lock.
948 next_lock:
949 before = &fl->fl_next;
953 * The above code only modifies existing locks in case of
954 * merging or replacing. If new lock(s) need to be inserted
955 * all modifications are done bellow this, so it's safe yet to
956 * bail out.
958 error = -ENOLCK; /* "no luck" */
959 if (right && left == right && !new_fl2)
960 goto out;
962 error = 0;
963 if (!added) {
964 if (request->fl_type == F_UNLCK) {
965 if (request->fl_flags & FL_EXISTS)
966 error = -ENOENT;
967 goto out;
970 if (!new_fl) {
971 error = -ENOLCK;
972 goto out;
974 locks_copy_lock(new_fl, request);
975 locks_insert_lock(before, new_fl);
976 new_fl = NULL;
978 if (right) {
979 if (left == right) {
980 /* The new lock breaks the old one in two pieces,
981 * so we have to use the second new lock.
983 left = new_fl2;
984 new_fl2 = NULL;
985 locks_copy_lock(left, right);
986 locks_insert_lock(before, left);
988 right->fl_start = request->fl_end + 1;
989 locks_wake_up_blocks(right);
991 if (left) {
992 left->fl_end = request->fl_start - 1;
993 locks_wake_up_blocks(left);
995 out:
996 unlock_kernel();
998 * Free any unused locks.
1000 if (new_fl)
1001 locks_free_lock(new_fl);
1002 if (new_fl2)
1003 locks_free_lock(new_fl2);
1004 return error;
1008 * posix_lock_file - Apply a POSIX-style lock to a file
1009 * @filp: The file to apply the lock to
1010 * @fl: The lock to be applied
1011 * @conflock: Place to return a copy of the conflicting lock, if found.
1013 * Add a POSIX style lock to a file.
1014 * We merge adjacent & overlapping locks whenever possible.
1015 * POSIX locks are sorted by owner task, then by starting address
1017 * Note that if called with an FL_EXISTS argument, the caller may determine
1018 * whether or not a lock was successfully freed by testing the return
1019 * value for -ENOENT.
1021 int posix_lock_file(struct file *filp, struct file_lock *fl,
1022 struct file_lock *conflock)
1024 return __posix_lock_file(filp->f_path.dentry->d_inode, fl, conflock);
1026 EXPORT_SYMBOL(posix_lock_file);
1029 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1030 * @filp: The file to apply the lock to
1031 * @fl: The lock to be applied
1033 * Add a POSIX style lock to a file.
1034 * We merge adjacent & overlapping locks whenever possible.
1035 * POSIX locks are sorted by owner task, then by starting address
1037 int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1039 int error;
1040 might_sleep ();
1041 for (;;) {
1042 error = posix_lock_file(filp, fl, NULL);
1043 if ((error != -EAGAIN) || !(fl->fl_flags & FL_SLEEP))
1044 break;
1045 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1046 if (!error)
1047 continue;
1049 locks_delete_block(fl);
1050 break;
1052 return error;
1054 EXPORT_SYMBOL(posix_lock_file_wait);
1057 * locks_mandatory_locked - Check for an active lock
1058 * @inode: the file to check
1060 * Searches the inode's list of locks to find any POSIX locks which conflict.
1061 * This function is called from locks_verify_locked() only.
1063 int locks_mandatory_locked(struct inode *inode)
1065 fl_owner_t owner = current->files;
1066 struct file_lock *fl;
1069 * Search the lock list for this inode for any POSIX locks.
1071 lock_kernel();
1072 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1073 if (!IS_POSIX(fl))
1074 continue;
1075 if (fl->fl_owner != owner)
1076 break;
1078 unlock_kernel();
1079 return fl ? -EAGAIN : 0;
1083 * locks_mandatory_area - Check for a conflicting lock
1084 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1085 * for shared
1086 * @inode: the file to check
1087 * @filp: how the file was opened (if it was)
1088 * @offset: start of area to check
1089 * @count: length of area to check
1091 * Searches the inode's list of locks to find any POSIX locks which conflict.
1092 * This function is called from rw_verify_area() and
1093 * locks_verify_truncate().
1095 int locks_mandatory_area(int read_write, struct inode *inode,
1096 struct file *filp, loff_t offset,
1097 size_t count)
1099 struct file_lock fl;
1100 int error;
1102 locks_init_lock(&fl);
1103 fl.fl_owner = current->files;
1104 fl.fl_pid = current->tgid;
1105 fl.fl_file = filp;
1106 fl.fl_flags = FL_POSIX | FL_ACCESS;
1107 if (filp && !(filp->f_flags & O_NONBLOCK))
1108 fl.fl_flags |= FL_SLEEP;
1109 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1110 fl.fl_start = offset;
1111 fl.fl_end = offset + count - 1;
1113 for (;;) {
1114 error = __posix_lock_file(inode, &fl, NULL);
1115 if (error != -EAGAIN)
1116 break;
1117 if (!(fl.fl_flags & FL_SLEEP))
1118 break;
1119 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1120 if (!error) {
1122 * If we've been sleeping someone might have
1123 * changed the permissions behind our back.
1125 if (__mandatory_lock(inode))
1126 continue;
1129 locks_delete_block(&fl);
1130 break;
1133 return error;
1136 EXPORT_SYMBOL(locks_mandatory_area);
1138 /* We already had a lease on this file; just change its type */
1139 int lease_modify(struct file_lock **before, int arg)
1141 struct file_lock *fl = *before;
1142 int error = assign_type(fl, arg);
1144 if (error)
1145 return error;
1146 locks_wake_up_blocks(fl);
1147 if (arg == F_UNLCK)
1148 locks_delete_lock(before);
1149 return 0;
1152 EXPORT_SYMBOL(lease_modify);
1154 static void time_out_leases(struct inode *inode)
1156 struct file_lock **before;
1157 struct file_lock *fl;
1159 before = &inode->i_flock;
1160 while ((fl = *before) && IS_LEASE(fl) && (fl->fl_type & F_INPROGRESS)) {
1161 if ((fl->fl_break_time == 0)
1162 || time_before(jiffies, fl->fl_break_time)) {
1163 before = &fl->fl_next;
1164 continue;
1166 lease_modify(before, fl->fl_type & ~F_INPROGRESS);
1167 if (fl == *before) /* lease_modify may have freed fl */
1168 before = &fl->fl_next;
1173 * __break_lease - revoke all outstanding leases on file
1174 * @inode: the inode of the file to return
1175 * @mode: the open mode (read or write)
1177 * break_lease (inlined for speed) has checked there already is at least
1178 * some kind of lock (maybe a lease) on this file. Leases are broken on
1179 * a call to open() or truncate(). This function can sleep unless you
1180 * specified %O_NONBLOCK to your open().
1182 int __break_lease(struct inode *inode, unsigned int mode)
1184 int error = 0, future;
1185 struct file_lock *new_fl, *flock;
1186 struct file_lock *fl;
1187 unsigned long break_time;
1188 int i_have_this_lease = 0;
1190 new_fl = lease_alloc(NULL, mode & FMODE_WRITE ? F_WRLCK : F_RDLCK);
1192 lock_kernel();
1194 time_out_leases(inode);
1196 flock = inode->i_flock;
1197 if ((flock == NULL) || !IS_LEASE(flock))
1198 goto out;
1200 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next)
1201 if (fl->fl_owner == current->files)
1202 i_have_this_lease = 1;
1204 if (mode & FMODE_WRITE) {
1205 /* If we want write access, we have to revoke any lease. */
1206 future = F_UNLCK | F_INPROGRESS;
1207 } else if (flock->fl_type & F_INPROGRESS) {
1208 /* If the lease is already being broken, we just leave it */
1209 future = flock->fl_type;
1210 } else if (flock->fl_type & F_WRLCK) {
1211 /* Downgrade the exclusive lease to a read-only lease. */
1212 future = F_RDLCK | F_INPROGRESS;
1213 } else {
1214 /* the existing lease was read-only, so we can read too. */
1215 goto out;
1218 if (IS_ERR(new_fl) && !i_have_this_lease
1219 && ((mode & O_NONBLOCK) == 0)) {
1220 error = PTR_ERR(new_fl);
1221 goto out;
1224 break_time = 0;
1225 if (lease_break_time > 0) {
1226 break_time = jiffies + lease_break_time * HZ;
1227 if (break_time == 0)
1228 break_time++; /* so that 0 means no break time */
1231 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1232 if (fl->fl_type != future) {
1233 fl->fl_type = future;
1234 fl->fl_break_time = break_time;
1235 /* lease must have lmops break callback */
1236 fl->fl_lmops->fl_break(fl);
1240 if (i_have_this_lease || (mode & O_NONBLOCK)) {
1241 error = -EWOULDBLOCK;
1242 goto out;
1245 restart:
1246 break_time = flock->fl_break_time;
1247 if (break_time != 0) {
1248 break_time -= jiffies;
1249 if (break_time == 0)
1250 break_time++;
1252 locks_insert_block(flock, new_fl);
1253 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1254 !new_fl->fl_next, break_time);
1255 __locks_delete_block(new_fl);
1256 if (error >= 0) {
1257 if (error == 0)
1258 time_out_leases(inode);
1259 /* Wait for the next lease that has not been broken yet */
1260 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1261 flock = flock->fl_next) {
1262 if (flock->fl_type & F_INPROGRESS)
1263 goto restart;
1265 error = 0;
1268 out:
1269 unlock_kernel();
1270 if (!IS_ERR(new_fl))
1271 locks_free_lock(new_fl);
1272 return error;
1275 EXPORT_SYMBOL(__break_lease);
1278 * lease_get_mtime - get the last modified time of an inode
1279 * @inode: the inode
1280 * @time: pointer to a timespec which will contain the last modified time
1282 * This is to force NFS clients to flush their caches for files with
1283 * exclusive leases. The justification is that if someone has an
1284 * exclusive lease, then they could be modifying it.
1286 void lease_get_mtime(struct inode *inode, struct timespec *time)
1288 struct file_lock *flock = inode->i_flock;
1289 if (flock && IS_LEASE(flock) && (flock->fl_type & F_WRLCK))
1290 *time = current_fs_time(inode->i_sb);
1291 else
1292 *time = inode->i_mtime;
1295 EXPORT_SYMBOL(lease_get_mtime);
1298 * fcntl_getlease - Enquire what lease is currently active
1299 * @filp: the file
1301 * The value returned by this function will be one of
1302 * (if no lease break is pending):
1304 * %F_RDLCK to indicate a shared lease is held.
1306 * %F_WRLCK to indicate an exclusive lease is held.
1308 * %F_UNLCK to indicate no lease is held.
1310 * (if a lease break is pending):
1312 * %F_RDLCK to indicate an exclusive lease needs to be
1313 * changed to a shared lease (or removed).
1315 * %F_UNLCK to indicate the lease needs to be removed.
1317 * XXX: sfr & willy disagree over whether F_INPROGRESS
1318 * should be returned to userspace.
1320 int fcntl_getlease(struct file *filp)
1322 struct file_lock *fl;
1323 int type = F_UNLCK;
1325 lock_kernel();
1326 time_out_leases(filp->f_path.dentry->d_inode);
1327 for (fl = filp->f_path.dentry->d_inode->i_flock; fl && IS_LEASE(fl);
1328 fl = fl->fl_next) {
1329 if (fl->fl_file == filp) {
1330 type = fl->fl_type & ~F_INPROGRESS;
1331 break;
1334 unlock_kernel();
1335 return type;
1339 * generic_setlease - sets a lease on an open file
1340 * @filp: file pointer
1341 * @arg: type of lease to obtain
1342 * @flp: input - file_lock to use, output - file_lock inserted
1344 * The (input) flp->fl_lmops->fl_break function is required
1345 * by break_lease().
1347 * Called with kernel lock held.
1349 int generic_setlease(struct file *filp, long arg, struct file_lock **flp)
1351 struct file_lock *fl, **before, **my_before = NULL, *lease;
1352 struct file_lock *new_fl = NULL;
1353 struct dentry *dentry = filp->f_path.dentry;
1354 struct inode *inode = dentry->d_inode;
1355 int error, rdlease_count = 0, wrlease_count = 0;
1357 if ((current->fsuid != inode->i_uid) && !capable(CAP_LEASE))
1358 return -EACCES;
1359 if (!S_ISREG(inode->i_mode))
1360 return -EINVAL;
1361 error = security_file_lock(filp, arg);
1362 if (error)
1363 return error;
1365 time_out_leases(inode);
1367 BUG_ON(!(*flp)->fl_lmops->fl_break);
1369 lease = *flp;
1371 error = -EAGAIN;
1372 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1373 goto out;
1374 if ((arg == F_WRLCK)
1375 && ((atomic_read(&dentry->d_count) > 1)
1376 || (atomic_read(&inode->i_count) > 1)))
1377 goto out;
1379 error = -ENOMEM;
1380 new_fl = locks_alloc_lock();
1381 if (new_fl == NULL)
1382 goto out;
1385 * At this point, we know that if there is an exclusive
1386 * lease on this file, then we hold it on this filp
1387 * (otherwise our open of this file would have blocked).
1388 * And if we are trying to acquire an exclusive lease,
1389 * then the file is not open by anyone (including us)
1390 * except for this filp.
1392 for (before = &inode->i_flock;
1393 ((fl = *before) != NULL) && IS_LEASE(fl);
1394 before = &fl->fl_next) {
1395 if (lease->fl_lmops->fl_mylease(fl, lease))
1396 my_before = before;
1397 else if (fl->fl_type == (F_INPROGRESS | F_UNLCK))
1399 * Someone is in the process of opening this
1400 * file for writing so we may not take an
1401 * exclusive lease on it.
1403 wrlease_count++;
1404 else
1405 rdlease_count++;
1408 if ((arg == F_RDLCK && (wrlease_count > 0)) ||
1409 (arg == F_WRLCK && ((rdlease_count + wrlease_count) > 0)))
1410 goto out;
1412 if (my_before != NULL) {
1413 *flp = *my_before;
1414 error = lease->fl_lmops->fl_change(my_before, arg);
1415 goto out;
1418 error = 0;
1419 if (arg == F_UNLCK)
1420 goto out;
1422 error = -EINVAL;
1423 if (!leases_enable)
1424 goto out;
1426 locks_copy_lock(new_fl, lease);
1427 locks_insert_lock(before, new_fl);
1429 *flp = new_fl;
1430 return 0;
1432 out:
1433 if (new_fl != NULL)
1434 locks_free_lock(new_fl);
1435 return error;
1437 EXPORT_SYMBOL(generic_setlease);
1440 * vfs_setlease - sets a lease on an open file
1441 * @filp: file pointer
1442 * @arg: type of lease to obtain
1443 * @lease: file_lock to use
1445 * Call this to establish a lease on the file.
1446 * The (*lease)->fl_lmops->fl_break operation must be set; if not,
1447 * break_lease will oops!
1449 * This will call the filesystem's setlease file method, if
1450 * defined. Note that there is no getlease method; instead, the
1451 * filesystem setlease method should call back to setlease() to
1452 * add a lease to the inode's lease list, where fcntl_getlease() can
1453 * find it. Since fcntl_getlease() only reports whether the current
1454 * task holds a lease, a cluster filesystem need only do this for
1455 * leases held by processes on this node.
1457 * There is also no break_lease method; filesystems that
1458 * handle their own leases shoud break leases themselves from the
1459 * filesystem's open, create, and (on truncate) setattr methods.
1461 * Warning: the only current setlease methods exist only to disable
1462 * leases in certain cases. More vfs changes may be required to
1463 * allow a full filesystem lease implementation.
1466 int vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
1468 int error;
1470 lock_kernel();
1471 if (filp->f_op && filp->f_op->setlease)
1472 error = filp->f_op->setlease(filp, arg, lease);
1473 else
1474 error = generic_setlease(filp, arg, lease);
1475 unlock_kernel();
1477 return error;
1479 EXPORT_SYMBOL_GPL(vfs_setlease);
1482 * fcntl_setlease - sets a lease on an open file
1483 * @fd: open file descriptor
1484 * @filp: file pointer
1485 * @arg: type of lease to obtain
1487 * Call this fcntl to establish a lease on the file.
1488 * Note that you also need to call %F_SETSIG to
1489 * receive a signal when the lease is broken.
1491 int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1493 struct file_lock fl, *flp = &fl;
1494 struct dentry *dentry = filp->f_path.dentry;
1495 struct inode *inode = dentry->d_inode;
1496 int error;
1498 locks_init_lock(&fl);
1499 error = lease_init(filp, arg, &fl);
1500 if (error)
1501 return error;
1503 lock_kernel();
1505 error = vfs_setlease(filp, arg, &flp);
1506 if (error || arg == F_UNLCK)
1507 goto out_unlock;
1509 error = fasync_helper(fd, filp, 1, &flp->fl_fasync);
1510 if (error < 0) {
1511 /* remove lease just inserted by setlease */
1512 flp->fl_type = F_UNLCK | F_INPROGRESS;
1513 flp->fl_break_time = jiffies - 10;
1514 time_out_leases(inode);
1515 goto out_unlock;
1518 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
1519 out_unlock:
1520 unlock_kernel();
1521 return error;
1525 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1526 * @filp: The file to apply the lock to
1527 * @fl: The lock to be applied
1529 * Add a FLOCK style lock to a file.
1531 int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1533 int error;
1534 might_sleep();
1535 for (;;) {
1536 error = flock_lock_file(filp, fl);
1537 if ((error != -EAGAIN) || !(fl->fl_flags & FL_SLEEP))
1538 break;
1539 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1540 if (!error)
1541 continue;
1543 locks_delete_block(fl);
1544 break;
1546 return error;
1549 EXPORT_SYMBOL(flock_lock_file_wait);
1552 * sys_flock: - flock() system call.
1553 * @fd: the file descriptor to lock.
1554 * @cmd: the type of lock to apply.
1556 * Apply a %FL_FLOCK style lock to an open file descriptor.
1557 * The @cmd can be one of
1559 * %LOCK_SH -- a shared lock.
1561 * %LOCK_EX -- an exclusive lock.
1563 * %LOCK_UN -- remove an existing lock.
1565 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1567 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1568 * processes read and write access respectively.
1570 asmlinkage long sys_flock(unsigned int fd, unsigned int cmd)
1572 struct file *filp;
1573 struct file_lock *lock;
1574 int can_sleep, unlock;
1575 int error;
1577 error = -EBADF;
1578 filp = fget(fd);
1579 if (!filp)
1580 goto out;
1582 can_sleep = !(cmd & LOCK_NB);
1583 cmd &= ~LOCK_NB;
1584 unlock = (cmd == LOCK_UN);
1586 if (!unlock && !(cmd & LOCK_MAND) && !(filp->f_mode & 3))
1587 goto out_putf;
1589 error = flock_make_lock(filp, &lock, cmd);
1590 if (error)
1591 goto out_putf;
1592 if (can_sleep)
1593 lock->fl_flags |= FL_SLEEP;
1595 error = security_file_lock(filp, cmd);
1596 if (error)
1597 goto out_free;
1599 if (filp->f_op && filp->f_op->flock)
1600 error = filp->f_op->flock(filp,
1601 (can_sleep) ? F_SETLKW : F_SETLK,
1602 lock);
1603 else
1604 error = flock_lock_file_wait(filp, lock);
1606 out_free:
1607 locks_free_lock(lock);
1609 out_putf:
1610 fput(filp);
1611 out:
1612 return error;
1616 * vfs_test_lock - test file byte range lock
1617 * @filp: The file to test lock for
1618 * @fl: The lock to test; also used to hold result
1620 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1621 * setting conf->fl_type to something other than F_UNLCK.
1623 int vfs_test_lock(struct file *filp, struct file_lock *fl)
1625 if (filp->f_op && filp->f_op->lock)
1626 return filp->f_op->lock(filp, F_GETLK, fl);
1627 posix_test_lock(filp, fl);
1628 return 0;
1630 EXPORT_SYMBOL_GPL(vfs_test_lock);
1632 static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1634 flock->l_pid = fl->fl_pid;
1635 #if BITS_PER_LONG == 32
1637 * Make sure we can represent the posix lock via
1638 * legacy 32bit flock.
1640 if (fl->fl_start > OFFT_OFFSET_MAX)
1641 return -EOVERFLOW;
1642 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1643 return -EOVERFLOW;
1644 #endif
1645 flock->l_start = fl->fl_start;
1646 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1647 fl->fl_end - fl->fl_start + 1;
1648 flock->l_whence = 0;
1649 flock->l_type = fl->fl_type;
1650 return 0;
1653 #if BITS_PER_LONG == 32
1654 static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1656 flock->l_pid = fl->fl_pid;
1657 flock->l_start = fl->fl_start;
1658 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1659 fl->fl_end - fl->fl_start + 1;
1660 flock->l_whence = 0;
1661 flock->l_type = fl->fl_type;
1663 #endif
1665 /* Report the first existing lock that would conflict with l.
1666 * This implements the F_GETLK command of fcntl().
1668 int fcntl_getlk(struct file *filp, struct flock __user *l)
1670 struct file_lock file_lock;
1671 struct flock flock;
1672 int error;
1674 error = -EFAULT;
1675 if (copy_from_user(&flock, l, sizeof(flock)))
1676 goto out;
1677 error = -EINVAL;
1678 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1679 goto out;
1681 error = flock_to_posix_lock(filp, &file_lock, &flock);
1682 if (error)
1683 goto out;
1685 error = vfs_test_lock(filp, &file_lock);
1686 if (error)
1687 goto out;
1689 flock.l_type = file_lock.fl_type;
1690 if (file_lock.fl_type != F_UNLCK) {
1691 error = posix_lock_to_flock(&flock, &file_lock);
1692 if (error)
1693 goto out;
1695 error = -EFAULT;
1696 if (!copy_to_user(l, &flock, sizeof(flock)))
1697 error = 0;
1698 out:
1699 return error;
1703 * vfs_lock_file - file byte range lock
1704 * @filp: The file to apply the lock to
1705 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1706 * @fl: The lock to be applied
1707 * @conf: Place to return a copy of the conflicting lock, if found.
1709 * A caller that doesn't care about the conflicting lock may pass NULL
1710 * as the final argument.
1712 * If the filesystem defines a private ->lock() method, then @conf will
1713 * be left unchanged; so a caller that cares should initialize it to
1714 * some acceptable default.
1716 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1717 * locks, the ->lock() interface may return asynchronously, before the lock has
1718 * been granted or denied by the underlying filesystem, if (and only if)
1719 * fl_grant is set. Callers expecting ->lock() to return asynchronously
1720 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1721 * the request is for a blocking lock. When ->lock() does return asynchronously,
1722 * it must return -EINPROGRESS, and call ->fl_grant() when the lock
1723 * request completes.
1724 * If the request is for non-blocking lock the file system should return
1725 * -EINPROGRESS then try to get the lock and call the callback routine with
1726 * the result. If the request timed out the callback routine will return a
1727 * nonzero return code and the file system should release the lock. The file
1728 * system is also responsible to keep a corresponding posix lock when it
1729 * grants a lock so the VFS can find out which locks are locally held and do
1730 * the correct lock cleanup when required.
1731 * The underlying filesystem must not drop the kernel lock or call
1732 * ->fl_grant() before returning to the caller with a -EINPROGRESS
1733 * return code.
1735 int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
1737 if (filp->f_op && filp->f_op->lock)
1738 return filp->f_op->lock(filp, cmd, fl);
1739 else
1740 return posix_lock_file(filp, fl, conf);
1742 EXPORT_SYMBOL_GPL(vfs_lock_file);
1744 /* Apply the lock described by l to an open file descriptor.
1745 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1747 int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
1748 struct flock __user *l)
1750 struct file_lock *file_lock = locks_alloc_lock();
1751 struct flock flock;
1752 struct inode *inode;
1753 struct file *f;
1754 int error;
1756 if (file_lock == NULL)
1757 return -ENOLCK;
1760 * This might block, so we do it before checking the inode.
1762 error = -EFAULT;
1763 if (copy_from_user(&flock, l, sizeof(flock)))
1764 goto out;
1766 inode = filp->f_path.dentry->d_inode;
1768 /* Don't allow mandatory locks on files that may be memory mapped
1769 * and shared.
1771 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
1772 error = -EAGAIN;
1773 goto out;
1776 again:
1777 error = flock_to_posix_lock(filp, file_lock, &flock);
1778 if (error)
1779 goto out;
1780 if (cmd == F_SETLKW) {
1781 file_lock->fl_flags |= FL_SLEEP;
1784 error = -EBADF;
1785 switch (flock.l_type) {
1786 case F_RDLCK:
1787 if (!(filp->f_mode & FMODE_READ))
1788 goto out;
1789 break;
1790 case F_WRLCK:
1791 if (!(filp->f_mode & FMODE_WRITE))
1792 goto out;
1793 break;
1794 case F_UNLCK:
1795 break;
1796 default:
1797 error = -EINVAL;
1798 goto out;
1801 error = security_file_lock(filp, file_lock->fl_type);
1802 if (error)
1803 goto out;
1805 if (filp->f_op && filp->f_op->lock != NULL)
1806 error = filp->f_op->lock(filp, cmd, file_lock);
1807 else {
1808 for (;;) {
1809 error = posix_lock_file(filp, file_lock, NULL);
1810 if (error != -EAGAIN || cmd == F_SETLK)
1811 break;
1812 error = wait_event_interruptible(file_lock->fl_wait,
1813 !file_lock->fl_next);
1814 if (!error)
1815 continue;
1817 locks_delete_block(file_lock);
1818 break;
1823 * Attempt to detect a close/fcntl race and recover by
1824 * releasing the lock that was just acquired.
1827 * we need that spin_lock here - it prevents reordering between
1828 * update of inode->i_flock and check for it done in close().
1829 * rcu_read_lock() wouldn't do.
1831 spin_lock(&current->files->file_lock);
1832 f = fcheck(fd);
1833 spin_unlock(&current->files->file_lock);
1834 if (!error && f != filp && flock.l_type != F_UNLCK) {
1835 flock.l_type = F_UNLCK;
1836 goto again;
1839 out:
1840 locks_free_lock(file_lock);
1841 return error;
1844 #if BITS_PER_LONG == 32
1845 /* Report the first existing lock that would conflict with l.
1846 * This implements the F_GETLK command of fcntl().
1848 int fcntl_getlk64(struct file *filp, struct flock64 __user *l)
1850 struct file_lock file_lock;
1851 struct flock64 flock;
1852 int error;
1854 error = -EFAULT;
1855 if (copy_from_user(&flock, l, sizeof(flock)))
1856 goto out;
1857 error = -EINVAL;
1858 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1859 goto out;
1861 error = flock64_to_posix_lock(filp, &file_lock, &flock);
1862 if (error)
1863 goto out;
1865 error = vfs_test_lock(filp, &file_lock);
1866 if (error)
1867 goto out;
1869 flock.l_type = file_lock.fl_type;
1870 if (file_lock.fl_type != F_UNLCK)
1871 posix_lock_to_flock64(&flock, &file_lock);
1873 error = -EFAULT;
1874 if (!copy_to_user(l, &flock, sizeof(flock)))
1875 error = 0;
1877 out:
1878 return error;
1881 /* Apply the lock described by l to an open file descriptor.
1882 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1884 int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
1885 struct flock64 __user *l)
1887 struct file_lock *file_lock = locks_alloc_lock();
1888 struct flock64 flock;
1889 struct inode *inode;
1890 struct file *f;
1891 int error;
1893 if (file_lock == NULL)
1894 return -ENOLCK;
1897 * This might block, so we do it before checking the inode.
1899 error = -EFAULT;
1900 if (copy_from_user(&flock, l, sizeof(flock)))
1901 goto out;
1903 inode = filp->f_path.dentry->d_inode;
1905 /* Don't allow mandatory locks on files that may be memory mapped
1906 * and shared.
1908 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
1909 error = -EAGAIN;
1910 goto out;
1913 again:
1914 error = flock64_to_posix_lock(filp, file_lock, &flock);
1915 if (error)
1916 goto out;
1917 if (cmd == F_SETLKW64) {
1918 file_lock->fl_flags |= FL_SLEEP;
1921 error = -EBADF;
1922 switch (flock.l_type) {
1923 case F_RDLCK:
1924 if (!(filp->f_mode & FMODE_READ))
1925 goto out;
1926 break;
1927 case F_WRLCK:
1928 if (!(filp->f_mode & FMODE_WRITE))
1929 goto out;
1930 break;
1931 case F_UNLCK:
1932 break;
1933 default:
1934 error = -EINVAL;
1935 goto out;
1938 error = security_file_lock(filp, file_lock->fl_type);
1939 if (error)
1940 goto out;
1942 if (filp->f_op && filp->f_op->lock != NULL)
1943 error = filp->f_op->lock(filp, cmd, file_lock);
1944 else {
1945 for (;;) {
1946 error = posix_lock_file(filp, file_lock, NULL);
1947 if (error != -EAGAIN || cmd == F_SETLK64)
1948 break;
1949 error = wait_event_interruptible(file_lock->fl_wait,
1950 !file_lock->fl_next);
1951 if (!error)
1952 continue;
1954 locks_delete_block(file_lock);
1955 break;
1960 * Attempt to detect a close/fcntl race and recover by
1961 * releasing the lock that was just acquired.
1963 spin_lock(&current->files->file_lock);
1964 f = fcheck(fd);
1965 spin_unlock(&current->files->file_lock);
1966 if (!error && f != filp && flock.l_type != F_UNLCK) {
1967 flock.l_type = F_UNLCK;
1968 goto again;
1971 out:
1972 locks_free_lock(file_lock);
1973 return error;
1975 #endif /* BITS_PER_LONG == 32 */
1978 * This function is called when the file is being removed
1979 * from the task's fd array. POSIX locks belonging to this task
1980 * are deleted at this time.
1982 void locks_remove_posix(struct file *filp, fl_owner_t owner)
1984 struct file_lock lock;
1987 * If there are no locks held on this file, we don't need to call
1988 * posix_lock_file(). Another process could be setting a lock on this
1989 * file at the same time, but we wouldn't remove that lock anyway.
1991 if (!filp->f_path.dentry->d_inode->i_flock)
1992 return;
1994 lock.fl_type = F_UNLCK;
1995 lock.fl_flags = FL_POSIX | FL_CLOSE;
1996 lock.fl_start = 0;
1997 lock.fl_end = OFFSET_MAX;
1998 lock.fl_owner = owner;
1999 lock.fl_pid = current->tgid;
2000 lock.fl_file = filp;
2001 lock.fl_ops = NULL;
2002 lock.fl_lmops = NULL;
2004 vfs_lock_file(filp, F_SETLK, &lock, NULL);
2006 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2007 lock.fl_ops->fl_release_private(&lock);
2010 EXPORT_SYMBOL(locks_remove_posix);
2013 * This function is called on the last close of an open file.
2015 void locks_remove_flock(struct file *filp)
2017 struct inode * inode = filp->f_path.dentry->d_inode;
2018 struct file_lock *fl;
2019 struct file_lock **before;
2021 if (!inode->i_flock)
2022 return;
2024 if (filp->f_op && filp->f_op->flock) {
2025 struct file_lock fl = {
2026 .fl_pid = current->tgid,
2027 .fl_file = filp,
2028 .fl_flags = FL_FLOCK,
2029 .fl_type = F_UNLCK,
2030 .fl_end = OFFSET_MAX,
2032 filp->f_op->flock(filp, F_SETLKW, &fl);
2033 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2034 fl.fl_ops->fl_release_private(&fl);
2037 lock_kernel();
2038 before = &inode->i_flock;
2040 while ((fl = *before) != NULL) {
2041 if (fl->fl_file == filp) {
2042 if (IS_FLOCK(fl)) {
2043 locks_delete_lock(before);
2044 continue;
2046 if (IS_LEASE(fl)) {
2047 lease_modify(before, F_UNLCK);
2048 continue;
2050 /* What? */
2051 BUG();
2053 before = &fl->fl_next;
2055 unlock_kernel();
2059 * posix_unblock_lock - stop waiting for a file lock
2060 * @filp: how the file was opened
2061 * @waiter: the lock which was waiting
2063 * lockd needs to block waiting for locks.
2066 posix_unblock_lock(struct file *filp, struct file_lock *waiter)
2068 int status = 0;
2070 lock_kernel();
2071 if (waiter->fl_next)
2072 __locks_delete_block(waiter);
2073 else
2074 status = -ENOENT;
2075 unlock_kernel();
2076 return status;
2079 EXPORT_SYMBOL(posix_unblock_lock);
2082 * vfs_cancel_lock - file byte range unblock lock
2083 * @filp: The file to apply the unblock to
2084 * @fl: The lock to be unblocked
2086 * Used by lock managers to cancel blocked requests
2088 int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2090 if (filp->f_op && filp->f_op->lock)
2091 return filp->f_op->lock(filp, F_CANCELLK, fl);
2092 return 0;
2095 EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2097 #ifdef CONFIG_PROC_FS
2098 #include <linux/seq_file.h>
2100 static void lock_get_status(struct seq_file *f, struct file_lock *fl,
2101 int id, char *pfx)
2103 struct inode *inode = NULL;
2104 unsigned int fl_pid;
2106 if (fl->fl_nspid)
2107 fl_pid = pid_vnr(fl->fl_nspid);
2108 else
2109 fl_pid = fl->fl_pid;
2111 if (fl->fl_file != NULL)
2112 inode = fl->fl_file->f_path.dentry->d_inode;
2114 seq_printf(f, "%d:%s ", id, pfx);
2115 if (IS_POSIX(fl)) {
2116 seq_printf(f, "%6s %s ",
2117 (fl->fl_flags & FL_ACCESS) ? "ACCESS" : "POSIX ",
2118 (inode == NULL) ? "*NOINODE*" :
2119 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
2120 } else if (IS_FLOCK(fl)) {
2121 if (fl->fl_type & LOCK_MAND) {
2122 seq_printf(f, "FLOCK MSNFS ");
2123 } else {
2124 seq_printf(f, "FLOCK ADVISORY ");
2126 } else if (IS_LEASE(fl)) {
2127 seq_printf(f, "LEASE ");
2128 if (fl->fl_type & F_INPROGRESS)
2129 seq_printf(f, "BREAKING ");
2130 else if (fl->fl_file)
2131 seq_printf(f, "ACTIVE ");
2132 else
2133 seq_printf(f, "BREAKER ");
2134 } else {
2135 seq_printf(f, "UNKNOWN UNKNOWN ");
2137 if (fl->fl_type & LOCK_MAND) {
2138 seq_printf(f, "%s ",
2139 (fl->fl_type & LOCK_READ)
2140 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2141 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2142 } else {
2143 seq_printf(f, "%s ",
2144 (fl->fl_type & F_INPROGRESS)
2145 ? (fl->fl_type & F_UNLCK) ? "UNLCK" : "READ "
2146 : (fl->fl_type & F_WRLCK) ? "WRITE" : "READ ");
2148 if (inode) {
2149 #ifdef WE_CAN_BREAK_LSLK_NOW
2150 seq_printf(f, "%d %s:%ld ", fl_pid,
2151 inode->i_sb->s_id, inode->i_ino);
2152 #else
2153 /* userspace relies on this representation of dev_t ;-( */
2154 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
2155 MAJOR(inode->i_sb->s_dev),
2156 MINOR(inode->i_sb->s_dev), inode->i_ino);
2157 #endif
2158 } else {
2159 seq_printf(f, "%d <none>:0 ", fl_pid);
2161 if (IS_POSIX(fl)) {
2162 if (fl->fl_end == OFFSET_MAX)
2163 seq_printf(f, "%Ld EOF\n", fl->fl_start);
2164 else
2165 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
2166 } else {
2167 seq_printf(f, "0 EOF\n");
2171 static int locks_show(struct seq_file *f, void *v)
2173 struct file_lock *fl, *bfl;
2175 fl = list_entry(v, struct file_lock, fl_link);
2177 lock_get_status(f, fl, (long)f->private, "");
2179 list_for_each_entry(bfl, &fl->fl_block, fl_block)
2180 lock_get_status(f, bfl, (long)f->private, " ->");
2182 f->private++;
2183 return 0;
2186 static void *locks_start(struct seq_file *f, loff_t *pos)
2188 lock_kernel();
2189 f->private = (void *)1;
2190 return seq_list_start(&file_lock_list, *pos);
2193 static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2195 return seq_list_next(v, &file_lock_list, pos);
2198 static void locks_stop(struct seq_file *f, void *v)
2200 unlock_kernel();
2203 struct seq_operations locks_seq_operations = {
2204 .start = locks_start,
2205 .next = locks_next,
2206 .stop = locks_stop,
2207 .show = locks_show,
2209 #endif
2212 * lock_may_read - checks that the region is free of locks
2213 * @inode: the inode that is being read
2214 * @start: the first byte to read
2215 * @len: the number of bytes to read
2217 * Emulates Windows locking requirements. Whole-file
2218 * mandatory locks (share modes) can prohibit a read and
2219 * byte-range POSIX locks can prohibit a read if they overlap.
2221 * N.B. this function is only ever called
2222 * from knfsd and ownership of locks is never checked.
2224 int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2226 struct file_lock *fl;
2227 int result = 1;
2228 lock_kernel();
2229 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2230 if (IS_POSIX(fl)) {
2231 if (fl->fl_type == F_RDLCK)
2232 continue;
2233 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2234 continue;
2235 } else if (IS_FLOCK(fl)) {
2236 if (!(fl->fl_type & LOCK_MAND))
2237 continue;
2238 if (fl->fl_type & LOCK_READ)
2239 continue;
2240 } else
2241 continue;
2242 result = 0;
2243 break;
2245 unlock_kernel();
2246 return result;
2249 EXPORT_SYMBOL(lock_may_read);
2252 * lock_may_write - checks that the region is free of locks
2253 * @inode: the inode that is being written
2254 * @start: the first byte to write
2255 * @len: the number of bytes to write
2257 * Emulates Windows locking requirements. Whole-file
2258 * mandatory locks (share modes) can prohibit a write and
2259 * byte-range POSIX locks can prohibit a write if they overlap.
2261 * N.B. this function is only ever called
2262 * from knfsd and ownership of locks is never checked.
2264 int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2266 struct file_lock *fl;
2267 int result = 1;
2268 lock_kernel();
2269 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2270 if (IS_POSIX(fl)) {
2271 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2272 continue;
2273 } else if (IS_FLOCK(fl)) {
2274 if (!(fl->fl_type & LOCK_MAND))
2275 continue;
2276 if (fl->fl_type & LOCK_WRITE)
2277 continue;
2278 } else
2279 continue;
2280 result = 0;
2281 break;
2283 unlock_kernel();
2284 return result;
2287 EXPORT_SYMBOL(lock_may_write);
2289 static int __init filelock_init(void)
2291 filelock_cache = kmem_cache_create("file_lock_cache",
2292 sizeof(struct file_lock), 0, SLAB_PANIC,
2293 init_once);
2294 return 0;
2297 core_initcall(filelock_init);