i386: sched.h inclusion from module.h is baack
[pv_ops_mirror.git] / fs / locks.c
blob671a034dc999fffdf88856401694fda0cef87147
1 /*
2 * linux/fs/locks.c
4 * Provide support for fcntl()'s F_GETLK, F_SETLK, and F_SETLKW calls.
5 * Doug Evans (dje@spiff.uucp), August 07, 1992
7 * Deadlock detection added.
8 * FIXME: one thing isn't handled yet:
9 * - mandatory locks (requires lots of changes elsewhere)
10 * Kelly Carmichael (kelly@[142.24.8.65]), September 17, 1994.
12 * Miscellaneous edits, and a total rewrite of posix_lock_file() code.
13 * Kai Petzke (wpp@marie.physik.tu-berlin.de), 1994
15 * Converted file_lock_table to a linked list from an array, which eliminates
16 * the limits on how many active file locks are open.
17 * Chad Page (pageone@netcom.com), November 27, 1994
19 * Removed dependency on file descriptors. dup()'ed file descriptors now
20 * get the same locks as the original file descriptors, and a close() on
21 * any file descriptor removes ALL the locks on the file for the current
22 * process. Since locks still depend on the process id, locks are inherited
23 * after an exec() but not after a fork(). This agrees with POSIX, and both
24 * BSD and SVR4 practice.
25 * Andy Walker (andy@lysaker.kvaerner.no), February 14, 1995
27 * Scrapped free list which is redundant now that we allocate locks
28 * dynamically with kmalloc()/kfree().
29 * Andy Walker (andy@lysaker.kvaerner.no), February 21, 1995
31 * Implemented two lock personalities - FL_FLOCK and FL_POSIX.
33 * FL_POSIX locks are created with calls to fcntl() and lockf() through the
34 * fcntl() system call. They have the semantics described above.
36 * FL_FLOCK locks are created with calls to flock(), through the flock()
37 * system call, which is new. Old C libraries implement flock() via fcntl()
38 * and will continue to use the old, broken implementation.
40 * FL_FLOCK locks follow the 4.4 BSD flock() semantics. They are associated
41 * with a file pointer (filp). As a result they can be shared by a parent
42 * process and its children after a fork(). They are removed when the last
43 * file descriptor referring to the file pointer is closed (unless explicitly
44 * unlocked).
46 * FL_FLOCK locks never deadlock, an existing lock is always removed before
47 * upgrading from shared to exclusive (or vice versa). When this happens
48 * any processes blocked by the current lock are woken up and allowed to
49 * run before the new lock is applied.
50 * Andy Walker (andy@lysaker.kvaerner.no), June 09, 1995
52 * Removed some race conditions in flock_lock_file(), marked other possible
53 * races. Just grep for FIXME to see them.
54 * Dmitry Gorodchanin (pgmdsg@ibi.com), February 09, 1996.
56 * Addressed Dmitry's concerns. Deadlock checking no longer recursive.
57 * Lock allocation changed to GFP_ATOMIC as we can't afford to sleep
58 * once we've checked for blocking and deadlocking.
59 * Andy Walker (andy@lysaker.kvaerner.no), April 03, 1996.
61 * Initial implementation of mandatory locks. SunOS turned out to be
62 * a rotten model, so I implemented the "obvious" semantics.
63 * See 'Documentation/mandatory.txt' for details.
64 * Andy Walker (andy@lysaker.kvaerner.no), April 06, 1996.
66 * Don't allow mandatory locks on mmap()'ed files. Added simple functions to
67 * check if a file has mandatory locks, used by mmap(), open() and creat() to
68 * see if system call should be rejected. Ref. HP-UX/SunOS/Solaris Reference
69 * Manual, Section 2.
70 * Andy Walker (andy@lysaker.kvaerner.no), April 09, 1996.
72 * Tidied up block list handling. Added '/proc/locks' interface.
73 * Andy Walker (andy@lysaker.kvaerner.no), April 24, 1996.
75 * Fixed deadlock condition for pathological code that mixes calls to
76 * flock() and fcntl().
77 * Andy Walker (andy@lysaker.kvaerner.no), April 29, 1996.
79 * Allow only one type of locking scheme (FL_POSIX or FL_FLOCK) to be in use
80 * for a given file at a time. Changed the CONFIG_LOCK_MANDATORY scheme to
81 * guarantee sensible behaviour in the case where file system modules might
82 * be compiled with different options than the kernel itself.
83 * Andy Walker (andy@lysaker.kvaerner.no), May 15, 1996.
85 * Added a couple of missing wake_up() calls. Thanks to Thomas Meckel
86 * (Thomas.Meckel@mni.fh-giessen.de) for spotting this.
87 * Andy Walker (andy@lysaker.kvaerner.no), May 15, 1996.
89 * Changed FL_POSIX locks to use the block list in the same way as FL_FLOCK
90 * locks. Changed process synchronisation to avoid dereferencing locks that
91 * have already been freed.
92 * Andy Walker (andy@lysaker.kvaerner.no), Sep 21, 1996.
94 * Made the block list a circular list to minimise searching in the list.
95 * Andy Walker (andy@lysaker.kvaerner.no), Sep 25, 1996.
97 * Made mandatory locking a mount option. Default is not to allow mandatory
98 * locking.
99 * Andy Walker (andy@lysaker.kvaerner.no), Oct 04, 1996.
101 * Some adaptations for NFS support.
102 * Olaf Kirch (okir@monad.swb.de), Dec 1996,
104 * Fixed /proc/locks interface so that we can't overrun the buffer we are handed.
105 * Andy Walker (andy@lysaker.kvaerner.no), May 12, 1997.
107 * Use slab allocator instead of kmalloc/kfree.
108 * Use generic list implementation from <linux/list.h>.
109 * Sped up posix_locks_deadlock by only considering blocked locks.
110 * Matthew Wilcox <willy@debian.org>, March, 2000.
112 * Leases and LOCK_MAND
113 * Matthew Wilcox <willy@debian.org>, June, 2000.
114 * Stephen Rothwell <sfr@canb.auug.org.au>, June, 2000.
117 #include <linux/capability.h>
118 #include <linux/file.h>
119 #include <linux/fs.h>
120 #include <linux/init.h>
121 #include <linux/module.h>
122 #include <linux/security.h>
123 #include <linux/slab.h>
124 #include <linux/smp_lock.h>
125 #include <linux/syscalls.h>
126 #include <linux/time.h>
127 #include <linux/rcupdate.h>
129 #include <asm/semaphore.h>
130 #include <asm/uaccess.h>
132 #define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
133 #define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
134 #define IS_LEASE(fl) (fl->fl_flags & FL_LEASE)
136 int leases_enable = 1;
137 int lease_break_time = 45;
139 #define for_each_lock(inode, lockp) \
140 for (lockp = &inode->i_flock; *lockp != NULL; lockp = &(*lockp)->fl_next)
142 static LIST_HEAD(file_lock_list);
143 static LIST_HEAD(blocked_list);
145 static struct kmem_cache *filelock_cache __read_mostly;
147 /* Allocate an empty lock structure. */
148 static struct file_lock *locks_alloc_lock(void)
150 return kmem_cache_alloc(filelock_cache, GFP_KERNEL);
153 static void locks_release_private(struct file_lock *fl)
155 if (fl->fl_ops) {
156 if (fl->fl_ops->fl_release_private)
157 fl->fl_ops->fl_release_private(fl);
158 fl->fl_ops = NULL;
160 if (fl->fl_lmops) {
161 if (fl->fl_lmops->fl_release_private)
162 fl->fl_lmops->fl_release_private(fl);
163 fl->fl_lmops = NULL;
168 /* Free a lock which is not in use. */
169 static void locks_free_lock(struct file_lock *fl)
171 BUG_ON(waitqueue_active(&fl->fl_wait));
172 BUG_ON(!list_empty(&fl->fl_block));
173 BUG_ON(!list_empty(&fl->fl_link));
175 locks_release_private(fl);
176 kmem_cache_free(filelock_cache, fl);
179 void locks_init_lock(struct file_lock *fl)
181 INIT_LIST_HEAD(&fl->fl_link);
182 INIT_LIST_HEAD(&fl->fl_block);
183 init_waitqueue_head(&fl->fl_wait);
184 fl->fl_next = NULL;
185 fl->fl_fasync = NULL;
186 fl->fl_owner = NULL;
187 fl->fl_pid = 0;
188 fl->fl_file = NULL;
189 fl->fl_flags = 0;
190 fl->fl_type = 0;
191 fl->fl_start = fl->fl_end = 0;
192 fl->fl_ops = NULL;
193 fl->fl_lmops = NULL;
196 EXPORT_SYMBOL(locks_init_lock);
199 * Initialises the fields of the file lock which are invariant for
200 * free file_locks.
202 static void init_once(void *foo, struct kmem_cache *cache, unsigned long flags)
204 struct file_lock *lock = (struct file_lock *) foo;
206 if (!(flags & SLAB_CTOR_CONSTRUCTOR))
207 return;
209 locks_init_lock(lock);
212 static void locks_copy_private(struct file_lock *new, struct file_lock *fl)
214 if (fl->fl_ops) {
215 if (fl->fl_ops->fl_copy_lock)
216 fl->fl_ops->fl_copy_lock(new, fl);
217 new->fl_ops = fl->fl_ops;
219 if (fl->fl_lmops) {
220 if (fl->fl_lmops->fl_copy_lock)
221 fl->fl_lmops->fl_copy_lock(new, fl);
222 new->fl_lmops = fl->fl_lmops;
227 * Initialize a new lock from an existing file_lock structure.
229 static void __locks_copy_lock(struct file_lock *new, const struct file_lock *fl)
231 new->fl_owner = fl->fl_owner;
232 new->fl_pid = fl->fl_pid;
233 new->fl_file = NULL;
234 new->fl_flags = fl->fl_flags;
235 new->fl_type = fl->fl_type;
236 new->fl_start = fl->fl_start;
237 new->fl_end = fl->fl_end;
238 new->fl_ops = NULL;
239 new->fl_lmops = NULL;
242 void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
244 locks_release_private(new);
246 __locks_copy_lock(new, fl);
247 new->fl_file = fl->fl_file;
248 new->fl_ops = fl->fl_ops;
249 new->fl_lmops = fl->fl_lmops;
251 locks_copy_private(new, fl);
254 EXPORT_SYMBOL(locks_copy_lock);
256 static inline int flock_translate_cmd(int cmd) {
257 if (cmd & LOCK_MAND)
258 return cmd & (LOCK_MAND | LOCK_RW);
259 switch (cmd) {
260 case LOCK_SH:
261 return F_RDLCK;
262 case LOCK_EX:
263 return F_WRLCK;
264 case LOCK_UN:
265 return F_UNLCK;
267 return -EINVAL;
270 /* Fill in a file_lock structure with an appropriate FLOCK lock. */
271 static int flock_make_lock(struct file *filp, struct file_lock **lock,
272 unsigned int cmd)
274 struct file_lock *fl;
275 int type = flock_translate_cmd(cmd);
276 if (type < 0)
277 return type;
279 fl = locks_alloc_lock();
280 if (fl == NULL)
281 return -ENOMEM;
283 fl->fl_file = filp;
284 fl->fl_pid = current->tgid;
285 fl->fl_flags = FL_FLOCK;
286 fl->fl_type = type;
287 fl->fl_end = OFFSET_MAX;
289 *lock = fl;
290 return 0;
293 static int assign_type(struct file_lock *fl, int type)
295 switch (type) {
296 case F_RDLCK:
297 case F_WRLCK:
298 case F_UNLCK:
299 fl->fl_type = type;
300 break;
301 default:
302 return -EINVAL;
304 return 0;
307 /* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
308 * style lock.
310 static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
311 struct flock *l)
313 off_t start, end;
315 switch (l->l_whence) {
316 case SEEK_SET:
317 start = 0;
318 break;
319 case SEEK_CUR:
320 start = filp->f_pos;
321 break;
322 case SEEK_END:
323 start = i_size_read(filp->f_path.dentry->d_inode);
324 break;
325 default:
326 return -EINVAL;
329 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
330 POSIX-2001 defines it. */
331 start += l->l_start;
332 if (start < 0)
333 return -EINVAL;
334 fl->fl_end = OFFSET_MAX;
335 if (l->l_len > 0) {
336 end = start + l->l_len - 1;
337 fl->fl_end = end;
338 } else if (l->l_len < 0) {
339 end = start - 1;
340 fl->fl_end = end;
341 start += l->l_len;
342 if (start < 0)
343 return -EINVAL;
345 fl->fl_start = start; /* we record the absolute position */
346 if (fl->fl_end < fl->fl_start)
347 return -EOVERFLOW;
349 fl->fl_owner = current->files;
350 fl->fl_pid = current->tgid;
351 fl->fl_file = filp;
352 fl->fl_flags = FL_POSIX;
353 fl->fl_ops = NULL;
354 fl->fl_lmops = NULL;
356 return assign_type(fl, l->l_type);
359 #if BITS_PER_LONG == 32
360 static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
361 struct flock64 *l)
363 loff_t start;
365 switch (l->l_whence) {
366 case SEEK_SET:
367 start = 0;
368 break;
369 case SEEK_CUR:
370 start = filp->f_pos;
371 break;
372 case SEEK_END:
373 start = i_size_read(filp->f_path.dentry->d_inode);
374 break;
375 default:
376 return -EINVAL;
379 start += l->l_start;
380 if (start < 0)
381 return -EINVAL;
382 fl->fl_end = OFFSET_MAX;
383 if (l->l_len > 0) {
384 fl->fl_end = start + l->l_len - 1;
385 } else if (l->l_len < 0) {
386 fl->fl_end = start - 1;
387 start += l->l_len;
388 if (start < 0)
389 return -EINVAL;
391 fl->fl_start = start; /* we record the absolute position */
392 if (fl->fl_end < fl->fl_start)
393 return -EOVERFLOW;
395 fl->fl_owner = current->files;
396 fl->fl_pid = current->tgid;
397 fl->fl_file = filp;
398 fl->fl_flags = FL_POSIX;
399 fl->fl_ops = NULL;
400 fl->fl_lmops = NULL;
402 switch (l->l_type) {
403 case F_RDLCK:
404 case F_WRLCK:
405 case F_UNLCK:
406 fl->fl_type = l->l_type;
407 break;
408 default:
409 return -EINVAL;
412 return (0);
414 #endif
416 /* default lease lock manager operations */
417 static void lease_break_callback(struct file_lock *fl)
419 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
422 static void lease_release_private_callback(struct file_lock *fl)
424 if (!fl->fl_file)
425 return;
427 f_delown(fl->fl_file);
428 fl->fl_file->f_owner.signum = 0;
431 static int lease_mylease_callback(struct file_lock *fl, struct file_lock *try)
433 return fl->fl_file == try->fl_file;
436 static struct lock_manager_operations lease_manager_ops = {
437 .fl_break = lease_break_callback,
438 .fl_release_private = lease_release_private_callback,
439 .fl_mylease = lease_mylease_callback,
440 .fl_change = lease_modify,
444 * Initialize a lease, use the default lock manager operations
446 static int lease_init(struct file *filp, int type, struct file_lock *fl)
448 if (assign_type(fl, type) != 0)
449 return -EINVAL;
451 fl->fl_owner = current->files;
452 fl->fl_pid = current->tgid;
454 fl->fl_file = filp;
455 fl->fl_flags = FL_LEASE;
456 fl->fl_start = 0;
457 fl->fl_end = OFFSET_MAX;
458 fl->fl_ops = NULL;
459 fl->fl_lmops = &lease_manager_ops;
460 return 0;
463 /* Allocate a file_lock initialised to this type of lease */
464 static int lease_alloc(struct file *filp, int type, struct file_lock **flp)
466 struct file_lock *fl = locks_alloc_lock();
467 int error = -ENOMEM;
469 if (fl == NULL)
470 goto out;
472 error = lease_init(filp, type, fl);
473 if (error) {
474 locks_free_lock(fl);
475 fl = NULL;
477 out:
478 *flp = fl;
479 return error;
482 /* Check if two locks overlap each other.
484 static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
486 return ((fl1->fl_end >= fl2->fl_start) &&
487 (fl2->fl_end >= fl1->fl_start));
491 * Check whether two locks have the same owner.
493 static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
495 if (fl1->fl_lmops && fl1->fl_lmops->fl_compare_owner)
496 return fl2->fl_lmops == fl1->fl_lmops &&
497 fl1->fl_lmops->fl_compare_owner(fl1, fl2);
498 return fl1->fl_owner == fl2->fl_owner;
501 /* Remove waiter from blocker's block list.
502 * When blocker ends up pointing to itself then the list is empty.
504 static void __locks_delete_block(struct file_lock *waiter)
506 list_del_init(&waiter->fl_block);
507 list_del_init(&waiter->fl_link);
508 waiter->fl_next = NULL;
513 static void locks_delete_block(struct file_lock *waiter)
515 lock_kernel();
516 __locks_delete_block(waiter);
517 unlock_kernel();
520 /* Insert waiter into blocker's block list.
521 * We use a circular list so that processes can be easily woken up in
522 * the order they blocked. The documentation doesn't require this but
523 * it seems like the reasonable thing to do.
525 static void locks_insert_block(struct file_lock *blocker,
526 struct file_lock *waiter)
528 BUG_ON(!list_empty(&waiter->fl_block));
529 list_add_tail(&waiter->fl_block, &blocker->fl_block);
530 waiter->fl_next = blocker;
531 if (IS_POSIX(blocker))
532 list_add(&waiter->fl_link, &blocked_list);
535 /* Wake up processes blocked waiting for blocker.
536 * If told to wait then schedule the processes until the block list
537 * is empty, otherwise empty the block list ourselves.
539 static void locks_wake_up_blocks(struct file_lock *blocker)
541 while (!list_empty(&blocker->fl_block)) {
542 struct file_lock *waiter = list_entry(blocker->fl_block.next,
543 struct file_lock, fl_block);
544 __locks_delete_block(waiter);
545 if (waiter->fl_lmops && waiter->fl_lmops->fl_notify)
546 waiter->fl_lmops->fl_notify(waiter);
547 else
548 wake_up(&waiter->fl_wait);
552 /* Insert file lock fl into an inode's lock list at the position indicated
553 * by pos. At the same time add the lock to the global file lock list.
555 static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
557 list_add(&fl->fl_link, &file_lock_list);
559 /* insert into file's list */
560 fl->fl_next = *pos;
561 *pos = fl;
563 if (fl->fl_ops && fl->fl_ops->fl_insert)
564 fl->fl_ops->fl_insert(fl);
568 * Delete a lock and then free it.
569 * Wake up processes that are blocked waiting for this lock,
570 * notify the FS that the lock has been cleared and
571 * finally free the lock.
573 static void locks_delete_lock(struct file_lock **thisfl_p)
575 struct file_lock *fl = *thisfl_p;
577 *thisfl_p = fl->fl_next;
578 fl->fl_next = NULL;
579 list_del_init(&fl->fl_link);
581 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
582 if (fl->fl_fasync != NULL) {
583 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
584 fl->fl_fasync = NULL;
587 if (fl->fl_ops && fl->fl_ops->fl_remove)
588 fl->fl_ops->fl_remove(fl);
590 locks_wake_up_blocks(fl);
591 locks_free_lock(fl);
594 /* Determine if lock sys_fl blocks lock caller_fl. Common functionality
595 * checks for shared/exclusive status of overlapping locks.
597 static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
599 if (sys_fl->fl_type == F_WRLCK)
600 return 1;
601 if (caller_fl->fl_type == F_WRLCK)
602 return 1;
603 return 0;
606 /* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
607 * checking before calling the locks_conflict().
609 static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
611 /* POSIX locks owned by the same process do not conflict with
612 * each other.
614 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
615 return (0);
617 /* Check whether they overlap */
618 if (!locks_overlap(caller_fl, sys_fl))
619 return 0;
621 return (locks_conflict(caller_fl, sys_fl));
624 /* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
625 * checking before calling the locks_conflict().
627 static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
629 /* FLOCK locks referring to the same filp do not conflict with
630 * each other.
632 if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
633 return (0);
634 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
635 return 0;
637 return (locks_conflict(caller_fl, sys_fl));
640 static int interruptible_sleep_on_locked(wait_queue_head_t *fl_wait, int timeout)
642 int result = 0;
643 DECLARE_WAITQUEUE(wait, current);
645 __set_current_state(TASK_INTERRUPTIBLE);
646 add_wait_queue(fl_wait, &wait);
647 if (timeout == 0)
648 schedule();
649 else
650 result = schedule_timeout(timeout);
651 if (signal_pending(current))
652 result = -ERESTARTSYS;
653 remove_wait_queue(fl_wait, &wait);
654 __set_current_state(TASK_RUNNING);
655 return result;
658 static int locks_block_on_timeout(struct file_lock *blocker, struct file_lock *waiter, int time)
660 int result;
661 locks_insert_block(blocker, waiter);
662 result = interruptible_sleep_on_locked(&waiter->fl_wait, time);
663 __locks_delete_block(waiter);
664 return result;
668 posix_test_lock(struct file *filp, struct file_lock *fl)
670 struct file_lock *cfl;
672 fl->fl_type = F_UNLCK;
673 lock_kernel();
674 for (cfl = filp->f_path.dentry->d_inode->i_flock; cfl; cfl = cfl->fl_next) {
675 if (!IS_POSIX(cfl))
676 continue;
677 if (posix_locks_conflict(cfl, fl))
678 break;
680 if (cfl) {
681 __locks_copy_lock(fl, cfl);
682 unlock_kernel();
683 return 1;
685 unlock_kernel();
686 return 0;
689 EXPORT_SYMBOL(posix_test_lock);
691 /* This function tests for deadlock condition before putting a process to
692 * sleep. The detection scheme is no longer recursive. Recursive was neat,
693 * but dangerous - we risked stack corruption if the lock data was bad, or
694 * if the recursion was too deep for any other reason.
696 * We rely on the fact that a task can only be on one lock's wait queue
697 * at a time. When we find blocked_task on a wait queue we can re-search
698 * with blocked_task equal to that queue's owner, until either blocked_task
699 * isn't found, or blocked_task is found on a queue owned by my_task.
701 * Note: the above assumption may not be true when handling lock requests
702 * from a broken NFS client. But broken NFS clients have a lot more to
703 * worry about than proper deadlock detection anyway... --okir
705 static int posix_locks_deadlock(struct file_lock *caller_fl,
706 struct file_lock *block_fl)
708 struct list_head *tmp;
710 next_task:
711 if (posix_same_owner(caller_fl, block_fl))
712 return 1;
713 list_for_each(tmp, &blocked_list) {
714 struct file_lock *fl = list_entry(tmp, struct file_lock, fl_link);
715 if (posix_same_owner(fl, block_fl)) {
716 fl = fl->fl_next;
717 block_fl = fl;
718 goto next_task;
721 return 0;
724 /* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
725 * at the head of the list, but that's secret knowledge known only to
726 * flock_lock_file and posix_lock_file.
728 * Note that if called with an FL_EXISTS argument, the caller may determine
729 * whether or not a lock was successfully freed by testing the return
730 * value for -ENOENT.
732 static int flock_lock_file(struct file *filp, struct file_lock *request)
734 struct file_lock *new_fl = NULL;
735 struct file_lock **before;
736 struct inode * inode = filp->f_path.dentry->d_inode;
737 int error = 0;
738 int found = 0;
740 lock_kernel();
741 if (request->fl_flags & FL_ACCESS)
742 goto find_conflict;
743 for_each_lock(inode, before) {
744 struct file_lock *fl = *before;
745 if (IS_POSIX(fl))
746 break;
747 if (IS_LEASE(fl))
748 continue;
749 if (filp != fl->fl_file)
750 continue;
751 if (request->fl_type == fl->fl_type)
752 goto out;
753 found = 1;
754 locks_delete_lock(before);
755 break;
758 if (request->fl_type == F_UNLCK) {
759 if ((request->fl_flags & FL_EXISTS) && !found)
760 error = -ENOENT;
761 goto out;
764 error = -ENOMEM;
765 new_fl = locks_alloc_lock();
766 if (new_fl == NULL)
767 goto out;
769 * If a higher-priority process was blocked on the old file lock,
770 * give it the opportunity to lock the file.
772 if (found)
773 cond_resched();
775 find_conflict:
776 for_each_lock(inode, before) {
777 struct file_lock *fl = *before;
778 if (IS_POSIX(fl))
779 break;
780 if (IS_LEASE(fl))
781 continue;
782 if (!flock_locks_conflict(request, fl))
783 continue;
784 error = -EAGAIN;
785 if (request->fl_flags & FL_SLEEP)
786 locks_insert_block(fl, request);
787 goto out;
789 if (request->fl_flags & FL_ACCESS)
790 goto out;
791 locks_copy_lock(new_fl, request);
792 locks_insert_lock(&inode->i_flock, new_fl);
793 new_fl = NULL;
794 error = 0;
796 out:
797 unlock_kernel();
798 if (new_fl)
799 locks_free_lock(new_fl);
800 return error;
803 static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
805 struct file_lock *fl;
806 struct file_lock *new_fl = NULL;
807 struct file_lock *new_fl2 = NULL;
808 struct file_lock *left = NULL;
809 struct file_lock *right = NULL;
810 struct file_lock **before;
811 int error, added = 0;
814 * We may need two file_lock structures for this operation,
815 * so we get them in advance to avoid races.
817 * In some cases we can be sure, that no new locks will be needed
819 if (!(request->fl_flags & FL_ACCESS) &&
820 (request->fl_type != F_UNLCK ||
821 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
822 new_fl = locks_alloc_lock();
823 new_fl2 = locks_alloc_lock();
826 lock_kernel();
827 if (request->fl_type != F_UNLCK) {
828 for_each_lock(inode, before) {
829 struct file_lock *fl = *before;
830 if (!IS_POSIX(fl))
831 continue;
832 if (!posix_locks_conflict(request, fl))
833 continue;
834 if (conflock)
835 locks_copy_lock(conflock, fl);
836 error = -EAGAIN;
837 if (!(request->fl_flags & FL_SLEEP))
838 goto out;
839 error = -EDEADLK;
840 if (posix_locks_deadlock(request, fl))
841 goto out;
842 error = -EAGAIN;
843 locks_insert_block(fl, request);
844 goto out;
848 /* If we're just looking for a conflict, we're done. */
849 error = 0;
850 if (request->fl_flags & FL_ACCESS)
851 goto out;
854 * Find the first old lock with the same owner as the new lock.
857 before = &inode->i_flock;
859 /* First skip locks owned by other processes. */
860 while ((fl = *before) && (!IS_POSIX(fl) ||
861 !posix_same_owner(request, fl))) {
862 before = &fl->fl_next;
865 /* Process locks with this owner. */
866 while ((fl = *before) && posix_same_owner(request, fl)) {
867 /* Detect adjacent or overlapping regions (if same lock type)
869 if (request->fl_type == fl->fl_type) {
870 /* In all comparisons of start vs end, use
871 * "start - 1" rather than "end + 1". If end
872 * is OFFSET_MAX, end + 1 will become negative.
874 if (fl->fl_end < request->fl_start - 1)
875 goto next_lock;
876 /* If the next lock in the list has entirely bigger
877 * addresses than the new one, insert the lock here.
879 if (fl->fl_start - 1 > request->fl_end)
880 break;
882 /* If we come here, the new and old lock are of the
883 * same type and adjacent or overlapping. Make one
884 * lock yielding from the lower start address of both
885 * locks to the higher end address.
887 if (fl->fl_start > request->fl_start)
888 fl->fl_start = request->fl_start;
889 else
890 request->fl_start = fl->fl_start;
891 if (fl->fl_end < request->fl_end)
892 fl->fl_end = request->fl_end;
893 else
894 request->fl_end = fl->fl_end;
895 if (added) {
896 locks_delete_lock(before);
897 continue;
899 request = fl;
900 added = 1;
902 else {
903 /* Processing for different lock types is a bit
904 * more complex.
906 if (fl->fl_end < request->fl_start)
907 goto next_lock;
908 if (fl->fl_start > request->fl_end)
909 break;
910 if (request->fl_type == F_UNLCK)
911 added = 1;
912 if (fl->fl_start < request->fl_start)
913 left = fl;
914 /* If the next lock in the list has a higher end
915 * address than the new one, insert the new one here.
917 if (fl->fl_end > request->fl_end) {
918 right = fl;
919 break;
921 if (fl->fl_start >= request->fl_start) {
922 /* The new lock completely replaces an old
923 * one (This may happen several times).
925 if (added) {
926 locks_delete_lock(before);
927 continue;
929 /* Replace the old lock with the new one.
930 * Wake up anybody waiting for the old one,
931 * as the change in lock type might satisfy
932 * their needs.
934 locks_wake_up_blocks(fl);
935 fl->fl_start = request->fl_start;
936 fl->fl_end = request->fl_end;
937 fl->fl_type = request->fl_type;
938 locks_release_private(fl);
939 locks_copy_private(fl, request);
940 request = fl;
941 added = 1;
944 /* Go on to next lock.
946 next_lock:
947 before = &fl->fl_next;
951 * The above code only modifies existing locks in case of
952 * merging or replacing. If new lock(s) need to be inserted
953 * all modifications are done bellow this, so it's safe yet to
954 * bail out.
956 error = -ENOLCK; /* "no luck" */
957 if (right && left == right && !new_fl2)
958 goto out;
960 error = 0;
961 if (!added) {
962 if (request->fl_type == F_UNLCK) {
963 if (request->fl_flags & FL_EXISTS)
964 error = -ENOENT;
965 goto out;
968 if (!new_fl) {
969 error = -ENOLCK;
970 goto out;
972 locks_copy_lock(new_fl, request);
973 locks_insert_lock(before, new_fl);
974 new_fl = NULL;
976 if (right) {
977 if (left == right) {
978 /* The new lock breaks the old one in two pieces,
979 * so we have to use the second new lock.
981 left = new_fl2;
982 new_fl2 = NULL;
983 locks_copy_lock(left, right);
984 locks_insert_lock(before, left);
986 right->fl_start = request->fl_end + 1;
987 locks_wake_up_blocks(right);
989 if (left) {
990 left->fl_end = request->fl_start - 1;
991 locks_wake_up_blocks(left);
993 out:
994 unlock_kernel();
996 * Free any unused locks.
998 if (new_fl)
999 locks_free_lock(new_fl);
1000 if (new_fl2)
1001 locks_free_lock(new_fl2);
1002 return error;
1006 * posix_lock_file - Apply a POSIX-style lock to a file
1007 * @filp: The file to apply the lock to
1008 * @fl: The lock to be applied
1009 * @conflock: Place to return a copy of the conflicting lock, if found.
1011 * Add a POSIX style lock to a file.
1012 * We merge adjacent & overlapping locks whenever possible.
1013 * POSIX locks are sorted by owner task, then by starting address
1015 * Note that if called with an FL_EXISTS argument, the caller may determine
1016 * whether or not a lock was successfully freed by testing the return
1017 * value for -ENOENT.
1019 int posix_lock_file(struct file *filp, struct file_lock *fl,
1020 struct file_lock *conflock)
1022 return __posix_lock_file(filp->f_path.dentry->d_inode, fl, conflock);
1024 EXPORT_SYMBOL(posix_lock_file);
1027 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1028 * @filp: The file to apply the lock to
1029 * @fl: The lock to be applied
1031 * Add a POSIX style lock to a file.
1032 * We merge adjacent & overlapping locks whenever possible.
1033 * POSIX locks are sorted by owner task, then by starting address
1035 int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1037 int error;
1038 might_sleep ();
1039 for (;;) {
1040 error = posix_lock_file(filp, fl, NULL);
1041 if ((error != -EAGAIN) || !(fl->fl_flags & FL_SLEEP))
1042 break;
1043 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1044 if (!error)
1045 continue;
1047 locks_delete_block(fl);
1048 break;
1050 return error;
1052 EXPORT_SYMBOL(posix_lock_file_wait);
1055 * locks_mandatory_locked - Check for an active lock
1056 * @inode: the file to check
1058 * Searches the inode's list of locks to find any POSIX locks which conflict.
1059 * This function is called from locks_verify_locked() only.
1061 int locks_mandatory_locked(struct inode *inode)
1063 fl_owner_t owner = current->files;
1064 struct file_lock *fl;
1067 * Search the lock list for this inode for any POSIX locks.
1069 lock_kernel();
1070 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1071 if (!IS_POSIX(fl))
1072 continue;
1073 if (fl->fl_owner != owner)
1074 break;
1076 unlock_kernel();
1077 return fl ? -EAGAIN : 0;
1081 * locks_mandatory_area - Check for a conflicting lock
1082 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1083 * for shared
1084 * @inode: the file to check
1085 * @filp: how the file was opened (if it was)
1086 * @offset: start of area to check
1087 * @count: length of area to check
1089 * Searches the inode's list of locks to find any POSIX locks which conflict.
1090 * This function is called from rw_verify_area() and
1091 * locks_verify_truncate().
1093 int locks_mandatory_area(int read_write, struct inode *inode,
1094 struct file *filp, loff_t offset,
1095 size_t count)
1097 struct file_lock fl;
1098 int error;
1100 locks_init_lock(&fl);
1101 fl.fl_owner = current->files;
1102 fl.fl_pid = current->tgid;
1103 fl.fl_file = filp;
1104 fl.fl_flags = FL_POSIX | FL_ACCESS;
1105 if (filp && !(filp->f_flags & O_NONBLOCK))
1106 fl.fl_flags |= FL_SLEEP;
1107 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1108 fl.fl_start = offset;
1109 fl.fl_end = offset + count - 1;
1111 for (;;) {
1112 error = __posix_lock_file(inode, &fl, NULL);
1113 if (error != -EAGAIN)
1114 break;
1115 if (!(fl.fl_flags & FL_SLEEP))
1116 break;
1117 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1118 if (!error) {
1120 * If we've been sleeping someone might have
1121 * changed the permissions behind our back.
1123 if ((inode->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID)
1124 continue;
1127 locks_delete_block(&fl);
1128 break;
1131 return error;
1134 EXPORT_SYMBOL(locks_mandatory_area);
1136 /* We already had a lease on this file; just change its type */
1137 int lease_modify(struct file_lock **before, int arg)
1139 struct file_lock *fl = *before;
1140 int error = assign_type(fl, arg);
1142 if (error)
1143 return error;
1144 locks_wake_up_blocks(fl);
1145 if (arg == F_UNLCK)
1146 locks_delete_lock(before);
1147 return 0;
1150 EXPORT_SYMBOL(lease_modify);
1152 static void time_out_leases(struct inode *inode)
1154 struct file_lock **before;
1155 struct file_lock *fl;
1157 before = &inode->i_flock;
1158 while ((fl = *before) && IS_LEASE(fl) && (fl->fl_type & F_INPROGRESS)) {
1159 if ((fl->fl_break_time == 0)
1160 || time_before(jiffies, fl->fl_break_time)) {
1161 before = &fl->fl_next;
1162 continue;
1164 lease_modify(before, fl->fl_type & ~F_INPROGRESS);
1165 if (fl == *before) /* lease_modify may have freed fl */
1166 before = &fl->fl_next;
1171 * __break_lease - revoke all outstanding leases on file
1172 * @inode: the inode of the file to return
1173 * @mode: the open mode (read or write)
1175 * break_lease (inlined for speed) has checked there already
1176 * is a lease on this file. Leases are broken on a call to open()
1177 * or truncate(). This function can sleep unless you
1178 * specified %O_NONBLOCK to your open().
1180 int __break_lease(struct inode *inode, unsigned int mode)
1182 int error = 0, future;
1183 struct file_lock *new_fl, *flock;
1184 struct file_lock *fl;
1185 int alloc_err;
1186 unsigned long break_time;
1187 int i_have_this_lease = 0;
1189 alloc_err = lease_alloc(NULL, mode & FMODE_WRITE ? F_WRLCK : F_RDLCK,
1190 &new_fl);
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 (alloc_err && !i_have_this_lease && ((mode & O_NONBLOCK) == 0)) {
1219 error = alloc_err;
1220 goto out;
1223 break_time = 0;
1224 if (lease_break_time > 0) {
1225 break_time = jiffies + lease_break_time * HZ;
1226 if (break_time == 0)
1227 break_time++; /* so that 0 means no break time */
1230 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1231 if (fl->fl_type != future) {
1232 fl->fl_type = future;
1233 fl->fl_break_time = break_time;
1234 /* lease must have lmops break callback */
1235 fl->fl_lmops->fl_break(fl);
1239 if (i_have_this_lease || (mode & O_NONBLOCK)) {
1240 error = -EWOULDBLOCK;
1241 goto out;
1244 restart:
1245 break_time = flock->fl_break_time;
1246 if (break_time != 0) {
1247 break_time -= jiffies;
1248 if (break_time == 0)
1249 break_time++;
1251 error = locks_block_on_timeout(flock, new_fl, break_time);
1252 if (error >= 0) {
1253 if (error == 0)
1254 time_out_leases(inode);
1255 /* Wait for the next lease that has not been broken yet */
1256 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1257 flock = flock->fl_next) {
1258 if (flock->fl_type & F_INPROGRESS)
1259 goto restart;
1261 error = 0;
1264 out:
1265 unlock_kernel();
1266 if (!alloc_err)
1267 locks_free_lock(new_fl);
1268 return error;
1271 EXPORT_SYMBOL(__break_lease);
1274 * lease_get_mtime
1275 * @inode: the inode
1276 * @time: pointer to a timespec which will contain the last modified time
1278 * This is to force NFS clients to flush their caches for files with
1279 * exclusive leases. The justification is that if someone has an
1280 * exclusive lease, then they could be modifiying it.
1282 void lease_get_mtime(struct inode *inode, struct timespec *time)
1284 struct file_lock *flock = inode->i_flock;
1285 if (flock && IS_LEASE(flock) && (flock->fl_type & F_WRLCK))
1286 *time = current_fs_time(inode->i_sb);
1287 else
1288 *time = inode->i_mtime;
1291 EXPORT_SYMBOL(lease_get_mtime);
1294 * fcntl_getlease - Enquire what lease is currently active
1295 * @filp: the file
1297 * The value returned by this function will be one of
1298 * (if no lease break is pending):
1300 * %F_RDLCK to indicate a shared lease is held.
1302 * %F_WRLCK to indicate an exclusive lease is held.
1304 * %F_UNLCK to indicate no lease is held.
1306 * (if a lease break is pending):
1308 * %F_RDLCK to indicate an exclusive lease needs to be
1309 * changed to a shared lease (or removed).
1311 * %F_UNLCK to indicate the lease needs to be removed.
1313 * XXX: sfr & willy disagree over whether F_INPROGRESS
1314 * should be returned to userspace.
1316 int fcntl_getlease(struct file *filp)
1318 struct file_lock *fl;
1319 int type = F_UNLCK;
1321 lock_kernel();
1322 time_out_leases(filp->f_path.dentry->d_inode);
1323 for (fl = filp->f_path.dentry->d_inode->i_flock; fl && IS_LEASE(fl);
1324 fl = fl->fl_next) {
1325 if (fl->fl_file == filp) {
1326 type = fl->fl_type & ~F_INPROGRESS;
1327 break;
1330 unlock_kernel();
1331 return type;
1335 * __setlease - sets a lease on an open file
1336 * @filp: file pointer
1337 * @arg: type of lease to obtain
1338 * @flp: input - file_lock to use, output - file_lock inserted
1340 * The (input) flp->fl_lmops->fl_break function is required
1341 * by break_lease().
1343 * Called with kernel lock held.
1345 static int __setlease(struct file *filp, long arg, struct file_lock **flp)
1347 struct file_lock *fl, **before, **my_before = NULL, *lease;
1348 struct dentry *dentry = filp->f_path.dentry;
1349 struct inode *inode = dentry->d_inode;
1350 int error, rdlease_count = 0, wrlease_count = 0;
1352 time_out_leases(inode);
1354 error = -EINVAL;
1355 if (!flp || !(*flp) || !(*flp)->fl_lmops || !(*flp)->fl_lmops->fl_break)
1356 goto out;
1358 lease = *flp;
1360 error = -EAGAIN;
1361 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1362 goto out;
1363 if ((arg == F_WRLCK)
1364 && ((atomic_read(&dentry->d_count) > 1)
1365 || (atomic_read(&inode->i_count) > 1)))
1366 goto out;
1369 * At this point, we know that if there is an exclusive
1370 * lease on this file, then we hold it on this filp
1371 * (otherwise our open of this file would have blocked).
1372 * And if we are trying to acquire an exclusive lease,
1373 * then the file is not open by anyone (including us)
1374 * except for this filp.
1376 for (before = &inode->i_flock;
1377 ((fl = *before) != NULL) && IS_LEASE(fl);
1378 before = &fl->fl_next) {
1379 if (lease->fl_lmops->fl_mylease(fl, lease))
1380 my_before = before;
1381 else if (fl->fl_type == (F_INPROGRESS | F_UNLCK))
1383 * Someone is in the process of opening this
1384 * file for writing so we may not take an
1385 * exclusive lease on it.
1387 wrlease_count++;
1388 else
1389 rdlease_count++;
1392 if ((arg == F_RDLCK && (wrlease_count > 0)) ||
1393 (arg == F_WRLCK && ((rdlease_count + wrlease_count) > 0)))
1394 goto out;
1396 if (my_before != NULL) {
1397 *flp = *my_before;
1398 error = lease->fl_lmops->fl_change(my_before, arg);
1399 goto out;
1402 error = 0;
1403 if (arg == F_UNLCK)
1404 goto out;
1406 error = -EINVAL;
1407 if (!leases_enable)
1408 goto out;
1410 error = -ENOMEM;
1411 fl = locks_alloc_lock();
1412 if (fl == NULL)
1413 goto out;
1415 locks_copy_lock(fl, lease);
1417 locks_insert_lock(before, fl);
1419 *flp = fl;
1420 error = 0;
1421 out:
1422 return error;
1426 * setlease - sets a lease on an open file
1427 * @filp: file pointer
1428 * @arg: type of lease to obtain
1429 * @lease: file_lock to use
1431 * Call this to establish a lease on the file.
1432 * The fl_lmops fl_break function is required by break_lease
1435 int setlease(struct file *filp, long arg, struct file_lock **lease)
1437 struct dentry *dentry = filp->f_path.dentry;
1438 struct inode *inode = dentry->d_inode;
1439 int error;
1441 if ((current->fsuid != inode->i_uid) && !capable(CAP_LEASE))
1442 return -EACCES;
1443 if (!S_ISREG(inode->i_mode))
1444 return -EINVAL;
1445 error = security_file_lock(filp, arg);
1446 if (error)
1447 return error;
1449 lock_kernel();
1450 error = __setlease(filp, arg, lease);
1451 unlock_kernel();
1453 return error;
1456 EXPORT_SYMBOL(setlease);
1459 * fcntl_setlease - sets a lease on an open file
1460 * @fd: open file descriptor
1461 * @filp: file pointer
1462 * @arg: type of lease to obtain
1464 * Call this fcntl to establish a lease on the file.
1465 * Note that you also need to call %F_SETSIG to
1466 * receive a signal when the lease is broken.
1468 int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1470 struct file_lock fl, *flp = &fl;
1471 struct dentry *dentry = filp->f_path.dentry;
1472 struct inode *inode = dentry->d_inode;
1473 int error;
1475 if ((current->fsuid != inode->i_uid) && !capable(CAP_LEASE))
1476 return -EACCES;
1477 if (!S_ISREG(inode->i_mode))
1478 return -EINVAL;
1479 error = security_file_lock(filp, arg);
1480 if (error)
1481 return error;
1483 locks_init_lock(&fl);
1484 error = lease_init(filp, arg, &fl);
1485 if (error)
1486 return error;
1488 lock_kernel();
1490 error = __setlease(filp, arg, &flp);
1491 if (error || arg == F_UNLCK)
1492 goto out_unlock;
1494 error = fasync_helper(fd, filp, 1, &flp->fl_fasync);
1495 if (error < 0) {
1496 /* remove lease just inserted by __setlease */
1497 flp->fl_type = F_UNLCK | F_INPROGRESS;
1498 flp->fl_break_time = jiffies- 10;
1499 time_out_leases(inode);
1500 goto out_unlock;
1503 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
1504 out_unlock:
1505 unlock_kernel();
1506 return error;
1510 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1511 * @filp: The file to apply the lock to
1512 * @fl: The lock to be applied
1514 * Add a FLOCK style lock to a file.
1516 int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1518 int error;
1519 might_sleep();
1520 for (;;) {
1521 error = flock_lock_file(filp, fl);
1522 if ((error != -EAGAIN) || !(fl->fl_flags & FL_SLEEP))
1523 break;
1524 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1525 if (!error)
1526 continue;
1528 locks_delete_block(fl);
1529 break;
1531 return error;
1534 EXPORT_SYMBOL(flock_lock_file_wait);
1537 * sys_flock: - flock() system call.
1538 * @fd: the file descriptor to lock.
1539 * @cmd: the type of lock to apply.
1541 * Apply a %FL_FLOCK style lock to an open file descriptor.
1542 * The @cmd can be one of
1544 * %LOCK_SH -- a shared lock.
1546 * %LOCK_EX -- an exclusive lock.
1548 * %LOCK_UN -- remove an existing lock.
1550 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1552 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1553 * processes read and write access respectively.
1555 asmlinkage long sys_flock(unsigned int fd, unsigned int cmd)
1557 struct file *filp;
1558 struct file_lock *lock;
1559 int can_sleep, unlock;
1560 int error;
1562 error = -EBADF;
1563 filp = fget(fd);
1564 if (!filp)
1565 goto out;
1567 can_sleep = !(cmd & LOCK_NB);
1568 cmd &= ~LOCK_NB;
1569 unlock = (cmd == LOCK_UN);
1571 if (!unlock && !(cmd & LOCK_MAND) && !(filp->f_mode & 3))
1572 goto out_putf;
1574 error = flock_make_lock(filp, &lock, cmd);
1575 if (error)
1576 goto out_putf;
1577 if (can_sleep)
1578 lock->fl_flags |= FL_SLEEP;
1580 error = security_file_lock(filp, cmd);
1581 if (error)
1582 goto out_free;
1584 if (filp->f_op && filp->f_op->flock)
1585 error = filp->f_op->flock(filp,
1586 (can_sleep) ? F_SETLKW : F_SETLK,
1587 lock);
1588 else
1589 error = flock_lock_file_wait(filp, lock);
1591 out_free:
1592 locks_free_lock(lock);
1594 out_putf:
1595 fput(filp);
1596 out:
1597 return error;
1601 * vfs_test_lock - test file byte range lock
1602 * @filp: The file to test lock for
1603 * @fl: The lock to test
1604 * @conf: Place to return a copy of the conflicting lock, if found
1606 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1607 * setting conf->fl_type to something other than F_UNLCK.
1609 int vfs_test_lock(struct file *filp, struct file_lock *fl)
1611 if (filp->f_op && filp->f_op->lock)
1612 return filp->f_op->lock(filp, F_GETLK, fl);
1613 posix_test_lock(filp, fl);
1614 return 0;
1616 EXPORT_SYMBOL_GPL(vfs_test_lock);
1618 static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1620 flock->l_pid = fl->fl_pid;
1621 #if BITS_PER_LONG == 32
1623 * Make sure we can represent the posix lock via
1624 * legacy 32bit flock.
1626 if (fl->fl_start > OFFT_OFFSET_MAX)
1627 return -EOVERFLOW;
1628 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1629 return -EOVERFLOW;
1630 #endif
1631 flock->l_start = fl->fl_start;
1632 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1633 fl->fl_end - fl->fl_start + 1;
1634 flock->l_whence = 0;
1635 return 0;
1638 #if BITS_PER_LONG == 32
1639 static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1641 flock->l_pid = fl->fl_pid;
1642 flock->l_start = fl->fl_start;
1643 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1644 fl->fl_end - fl->fl_start + 1;
1645 flock->l_whence = 0;
1646 flock->l_type = fl->fl_type;
1648 #endif
1650 /* Report the first existing lock that would conflict with l.
1651 * This implements the F_GETLK command of fcntl().
1653 int fcntl_getlk(struct file *filp, struct flock __user *l)
1655 struct file_lock file_lock;
1656 struct flock flock;
1657 int error;
1659 error = -EFAULT;
1660 if (copy_from_user(&flock, l, sizeof(flock)))
1661 goto out;
1662 error = -EINVAL;
1663 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1664 goto out;
1666 error = flock_to_posix_lock(filp, &file_lock, &flock);
1667 if (error)
1668 goto out;
1670 error = vfs_test_lock(filp, &file_lock);
1671 if (error)
1672 goto out;
1674 flock.l_type = file_lock.fl_type;
1675 if (file_lock.fl_type != F_UNLCK) {
1676 error = posix_lock_to_flock(&flock, &file_lock);
1677 if (error)
1678 goto out;
1680 error = -EFAULT;
1681 if (!copy_to_user(l, &flock, sizeof(flock)))
1682 error = 0;
1683 out:
1684 return error;
1688 * vfs_lock_file - file byte range lock
1689 * @filp: The file to apply the lock to
1690 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1691 * @fl: The lock to be applied
1692 * @conf: Place to return a copy of the conflicting lock, if found.
1694 * A caller that doesn't care about the conflicting lock may pass NULL
1695 * as the final argument.
1697 * If the filesystem defines a private ->lock() method, then @conf will
1698 * be left unchanged; so a caller that cares should initialize it to
1699 * some acceptable default.
1701 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1702 * locks, the ->lock() interface may return asynchronously, before the lock has
1703 * been granted or denied by the underlying filesystem, if (and only if)
1704 * fl_grant is set. Callers expecting ->lock() to return asynchronously
1705 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1706 * the request is for a blocking lock. When ->lock() does return asynchronously,
1707 * it must return -EINPROGRESS, and call ->fl_grant() when the lock
1708 * request completes.
1709 * If the request is for non-blocking lock the file system should return
1710 * -EINPROGRESS then try to get the lock and call the callback routine with
1711 * the result. If the request timed out the callback routine will return a
1712 * nonzero return code and the file system should release the lock. The file
1713 * system is also responsible to keep a corresponding posix lock when it
1714 * grants a lock so the VFS can find out which locks are locally held and do
1715 * the correct lock cleanup when required.
1716 * The underlying filesystem must not drop the kernel lock or call
1717 * ->fl_grant() before returning to the caller with a -EINPROGRESS
1718 * return code.
1720 int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
1722 if (filp->f_op && filp->f_op->lock)
1723 return filp->f_op->lock(filp, cmd, fl);
1724 else
1725 return posix_lock_file(filp, fl, conf);
1727 EXPORT_SYMBOL_GPL(vfs_lock_file);
1729 /* Apply the lock described by l to an open file descriptor.
1730 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1732 int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
1733 struct flock __user *l)
1735 struct file_lock *file_lock = locks_alloc_lock();
1736 struct flock flock;
1737 struct inode *inode;
1738 int error;
1740 if (file_lock == NULL)
1741 return -ENOLCK;
1744 * This might block, so we do it before checking the inode.
1746 error = -EFAULT;
1747 if (copy_from_user(&flock, l, sizeof(flock)))
1748 goto out;
1750 inode = filp->f_path.dentry->d_inode;
1752 /* Don't allow mandatory locks on files that may be memory mapped
1753 * and shared.
1755 if (IS_MANDLOCK(inode) &&
1756 (inode->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID &&
1757 mapping_writably_mapped(filp->f_mapping)) {
1758 error = -EAGAIN;
1759 goto out;
1762 again:
1763 error = flock_to_posix_lock(filp, file_lock, &flock);
1764 if (error)
1765 goto out;
1766 if (cmd == F_SETLKW) {
1767 file_lock->fl_flags |= FL_SLEEP;
1770 error = -EBADF;
1771 switch (flock.l_type) {
1772 case F_RDLCK:
1773 if (!(filp->f_mode & FMODE_READ))
1774 goto out;
1775 break;
1776 case F_WRLCK:
1777 if (!(filp->f_mode & FMODE_WRITE))
1778 goto out;
1779 break;
1780 case F_UNLCK:
1781 break;
1782 default:
1783 error = -EINVAL;
1784 goto out;
1787 error = security_file_lock(filp, file_lock->fl_type);
1788 if (error)
1789 goto out;
1791 for (;;) {
1792 error = vfs_lock_file(filp, cmd, file_lock, NULL);
1793 if (error != -EAGAIN || cmd == F_SETLK)
1794 break;
1795 error = wait_event_interruptible(file_lock->fl_wait,
1796 !file_lock->fl_next);
1797 if (!error)
1798 continue;
1800 locks_delete_block(file_lock);
1801 break;
1805 * Attempt to detect a close/fcntl race and recover by
1806 * releasing the lock that was just acquired.
1808 if (!error && fcheck(fd) != filp && flock.l_type != F_UNLCK) {
1809 flock.l_type = F_UNLCK;
1810 goto again;
1813 out:
1814 locks_free_lock(file_lock);
1815 return error;
1818 #if BITS_PER_LONG == 32
1819 /* Report the first existing lock that would conflict with l.
1820 * This implements the F_GETLK command of fcntl().
1822 int fcntl_getlk64(struct file *filp, struct flock64 __user *l)
1824 struct file_lock file_lock;
1825 struct flock64 flock;
1826 int error;
1828 error = -EFAULT;
1829 if (copy_from_user(&flock, l, sizeof(flock)))
1830 goto out;
1831 error = -EINVAL;
1832 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1833 goto out;
1835 error = flock64_to_posix_lock(filp, &file_lock, &flock);
1836 if (error)
1837 goto out;
1839 error = vfs_test_lock(filp, &file_lock);
1840 if (error)
1841 goto out;
1843 flock.l_type = file_lock.fl_type;
1844 if (file_lock.fl_type != F_UNLCK)
1845 posix_lock_to_flock64(&flock, &file_lock);
1847 error = -EFAULT;
1848 if (!copy_to_user(l, &flock, sizeof(flock)))
1849 error = 0;
1851 out:
1852 return error;
1855 /* Apply the lock described by l to an open file descriptor.
1856 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1858 int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
1859 struct flock64 __user *l)
1861 struct file_lock *file_lock = locks_alloc_lock();
1862 struct flock64 flock;
1863 struct inode *inode;
1864 int error;
1866 if (file_lock == NULL)
1867 return -ENOLCK;
1870 * This might block, so we do it before checking the inode.
1872 error = -EFAULT;
1873 if (copy_from_user(&flock, l, sizeof(flock)))
1874 goto out;
1876 inode = filp->f_path.dentry->d_inode;
1878 /* Don't allow mandatory locks on files that may be memory mapped
1879 * and shared.
1881 if (IS_MANDLOCK(inode) &&
1882 (inode->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID &&
1883 mapping_writably_mapped(filp->f_mapping)) {
1884 error = -EAGAIN;
1885 goto out;
1888 again:
1889 error = flock64_to_posix_lock(filp, file_lock, &flock);
1890 if (error)
1891 goto out;
1892 if (cmd == F_SETLKW64) {
1893 file_lock->fl_flags |= FL_SLEEP;
1896 error = -EBADF;
1897 switch (flock.l_type) {
1898 case F_RDLCK:
1899 if (!(filp->f_mode & FMODE_READ))
1900 goto out;
1901 break;
1902 case F_WRLCK:
1903 if (!(filp->f_mode & FMODE_WRITE))
1904 goto out;
1905 break;
1906 case F_UNLCK:
1907 break;
1908 default:
1909 error = -EINVAL;
1910 goto out;
1913 error = security_file_lock(filp, file_lock->fl_type);
1914 if (error)
1915 goto out;
1917 for (;;) {
1918 error = vfs_lock_file(filp, cmd, file_lock, NULL);
1919 if (error != -EAGAIN || cmd == F_SETLK64)
1920 break;
1921 error = wait_event_interruptible(file_lock->fl_wait,
1922 !file_lock->fl_next);
1923 if (!error)
1924 continue;
1926 locks_delete_block(file_lock);
1927 break;
1931 * Attempt to detect a close/fcntl race and recover by
1932 * releasing the lock that was just acquired.
1934 if (!error && fcheck(fd) != filp && flock.l_type != F_UNLCK) {
1935 flock.l_type = F_UNLCK;
1936 goto again;
1939 out:
1940 locks_free_lock(file_lock);
1941 return error;
1943 #endif /* BITS_PER_LONG == 32 */
1946 * This function is called when the file is being removed
1947 * from the task's fd array. POSIX locks belonging to this task
1948 * are deleted at this time.
1950 void locks_remove_posix(struct file *filp, fl_owner_t owner)
1952 struct file_lock lock;
1955 * If there are no locks held on this file, we don't need to call
1956 * posix_lock_file(). Another process could be setting a lock on this
1957 * file at the same time, but we wouldn't remove that lock anyway.
1959 if (!filp->f_path.dentry->d_inode->i_flock)
1960 return;
1962 lock.fl_type = F_UNLCK;
1963 lock.fl_flags = FL_POSIX | FL_CLOSE;
1964 lock.fl_start = 0;
1965 lock.fl_end = OFFSET_MAX;
1966 lock.fl_owner = owner;
1967 lock.fl_pid = current->tgid;
1968 lock.fl_file = filp;
1969 lock.fl_ops = NULL;
1970 lock.fl_lmops = NULL;
1972 vfs_lock_file(filp, F_SETLK, &lock, NULL);
1974 if (lock.fl_ops && lock.fl_ops->fl_release_private)
1975 lock.fl_ops->fl_release_private(&lock);
1978 EXPORT_SYMBOL(locks_remove_posix);
1981 * This function is called on the last close of an open file.
1983 void locks_remove_flock(struct file *filp)
1985 struct inode * inode = filp->f_path.dentry->d_inode;
1986 struct file_lock *fl;
1987 struct file_lock **before;
1989 if (!inode->i_flock)
1990 return;
1992 if (filp->f_op && filp->f_op->flock) {
1993 struct file_lock fl = {
1994 .fl_pid = current->tgid,
1995 .fl_file = filp,
1996 .fl_flags = FL_FLOCK,
1997 .fl_type = F_UNLCK,
1998 .fl_end = OFFSET_MAX,
2000 filp->f_op->flock(filp, F_SETLKW, &fl);
2001 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2002 fl.fl_ops->fl_release_private(&fl);
2005 lock_kernel();
2006 before = &inode->i_flock;
2008 while ((fl = *before) != NULL) {
2009 if (fl->fl_file == filp) {
2010 if (IS_FLOCK(fl)) {
2011 locks_delete_lock(before);
2012 continue;
2014 if (IS_LEASE(fl)) {
2015 lease_modify(before, F_UNLCK);
2016 continue;
2018 /* What? */
2019 BUG();
2021 before = &fl->fl_next;
2023 unlock_kernel();
2027 * posix_unblock_lock - stop waiting for a file lock
2028 * @filp: how the file was opened
2029 * @waiter: the lock which was waiting
2031 * lockd needs to block waiting for locks.
2034 posix_unblock_lock(struct file *filp, struct file_lock *waiter)
2036 int status = 0;
2038 lock_kernel();
2039 if (waiter->fl_next)
2040 __locks_delete_block(waiter);
2041 else
2042 status = -ENOENT;
2043 unlock_kernel();
2044 return status;
2047 EXPORT_SYMBOL(posix_unblock_lock);
2050 * vfs_cancel_lock - file byte range unblock lock
2051 * @filp: The file to apply the unblock to
2052 * @fl: The lock to be unblocked
2054 * Used by lock managers to cancel blocked requests
2056 int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2058 if (filp->f_op && filp->f_op->lock)
2059 return filp->f_op->lock(filp, F_CANCELLK, fl);
2060 return 0;
2063 EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2065 static void lock_get_status(char* out, struct file_lock *fl, int id, char *pfx)
2067 struct inode *inode = NULL;
2069 if (fl->fl_file != NULL)
2070 inode = fl->fl_file->f_path.dentry->d_inode;
2072 out += sprintf(out, "%d:%s ", id, pfx);
2073 if (IS_POSIX(fl)) {
2074 out += sprintf(out, "%6s %s ",
2075 (fl->fl_flags & FL_ACCESS) ? "ACCESS" : "POSIX ",
2076 (inode == NULL) ? "*NOINODE*" :
2077 (IS_MANDLOCK(inode) &&
2078 (inode->i_mode & (S_IXGRP | S_ISGID)) == S_ISGID) ?
2079 "MANDATORY" : "ADVISORY ");
2080 } else if (IS_FLOCK(fl)) {
2081 if (fl->fl_type & LOCK_MAND) {
2082 out += sprintf(out, "FLOCK MSNFS ");
2083 } else {
2084 out += sprintf(out, "FLOCK ADVISORY ");
2086 } else if (IS_LEASE(fl)) {
2087 out += sprintf(out, "LEASE ");
2088 if (fl->fl_type & F_INPROGRESS)
2089 out += sprintf(out, "BREAKING ");
2090 else if (fl->fl_file)
2091 out += sprintf(out, "ACTIVE ");
2092 else
2093 out += sprintf(out, "BREAKER ");
2094 } else {
2095 out += sprintf(out, "UNKNOWN UNKNOWN ");
2097 if (fl->fl_type & LOCK_MAND) {
2098 out += sprintf(out, "%s ",
2099 (fl->fl_type & LOCK_READ)
2100 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2101 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2102 } else {
2103 out += sprintf(out, "%s ",
2104 (fl->fl_type & F_INPROGRESS)
2105 ? (fl->fl_type & F_UNLCK) ? "UNLCK" : "READ "
2106 : (fl->fl_type & F_WRLCK) ? "WRITE" : "READ ");
2108 if (inode) {
2109 #ifdef WE_CAN_BREAK_LSLK_NOW
2110 out += sprintf(out, "%d %s:%ld ", fl->fl_pid,
2111 inode->i_sb->s_id, inode->i_ino);
2112 #else
2113 /* userspace relies on this representation of dev_t ;-( */
2114 out += sprintf(out, "%d %02x:%02x:%ld ", fl->fl_pid,
2115 MAJOR(inode->i_sb->s_dev),
2116 MINOR(inode->i_sb->s_dev), inode->i_ino);
2117 #endif
2118 } else {
2119 out += sprintf(out, "%d <none>:0 ", fl->fl_pid);
2121 if (IS_POSIX(fl)) {
2122 if (fl->fl_end == OFFSET_MAX)
2123 out += sprintf(out, "%Ld EOF\n", fl->fl_start);
2124 else
2125 out += sprintf(out, "%Ld %Ld\n", fl->fl_start,
2126 fl->fl_end);
2127 } else {
2128 out += sprintf(out, "0 EOF\n");
2132 static void move_lock_status(char **p, off_t* pos, off_t offset)
2134 int len;
2135 len = strlen(*p);
2136 if(*pos >= offset) {
2137 /* the complete line is valid */
2138 *p += len;
2139 *pos += len;
2140 return;
2142 if(*pos+len > offset) {
2143 /* use the second part of the line */
2144 int i = offset-*pos;
2145 memmove(*p,*p+i,len-i);
2146 *p += len-i;
2147 *pos += len;
2148 return;
2150 /* discard the complete line */
2151 *pos += len;
2155 * get_locks_status - reports lock usage in /proc/locks
2156 * @buffer: address in userspace to write into
2157 * @start: ?
2158 * @offset: how far we are through the buffer
2159 * @length: how much to read
2162 int get_locks_status(char *buffer, char **start, off_t offset, int length)
2164 struct list_head *tmp;
2165 char *q = buffer;
2166 off_t pos = 0;
2167 int i = 0;
2169 lock_kernel();
2170 list_for_each(tmp, &file_lock_list) {
2171 struct list_head *btmp;
2172 struct file_lock *fl = list_entry(tmp, struct file_lock, fl_link);
2173 lock_get_status(q, fl, ++i, "");
2174 move_lock_status(&q, &pos, offset);
2176 if(pos >= offset+length)
2177 goto done;
2179 list_for_each(btmp, &fl->fl_block) {
2180 struct file_lock *bfl = list_entry(btmp,
2181 struct file_lock, fl_block);
2182 lock_get_status(q, bfl, i, " ->");
2183 move_lock_status(&q, &pos, offset);
2185 if(pos >= offset+length)
2186 goto done;
2189 done:
2190 unlock_kernel();
2191 *start = buffer;
2192 if(q-buffer < length)
2193 return (q-buffer);
2194 return length;
2198 * lock_may_read - checks that the region is free of locks
2199 * @inode: the inode that is being read
2200 * @start: the first byte to read
2201 * @len: the number of bytes to read
2203 * Emulates Windows locking requirements. Whole-file
2204 * mandatory locks (share modes) can prohibit a read and
2205 * byte-range POSIX locks can prohibit a read if they overlap.
2207 * N.B. this function is only ever called
2208 * from knfsd and ownership of locks is never checked.
2210 int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2212 struct file_lock *fl;
2213 int result = 1;
2214 lock_kernel();
2215 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2216 if (IS_POSIX(fl)) {
2217 if (fl->fl_type == F_RDLCK)
2218 continue;
2219 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2220 continue;
2221 } else if (IS_FLOCK(fl)) {
2222 if (!(fl->fl_type & LOCK_MAND))
2223 continue;
2224 if (fl->fl_type & LOCK_READ)
2225 continue;
2226 } else
2227 continue;
2228 result = 0;
2229 break;
2231 unlock_kernel();
2232 return result;
2235 EXPORT_SYMBOL(lock_may_read);
2238 * lock_may_write - checks that the region is free of locks
2239 * @inode: the inode that is being written
2240 * @start: the first byte to write
2241 * @len: the number of bytes to write
2243 * Emulates Windows locking requirements. Whole-file
2244 * mandatory locks (share modes) can prohibit a write and
2245 * byte-range POSIX locks can prohibit a write if they overlap.
2247 * N.B. this function is only ever called
2248 * from knfsd and ownership of locks is never checked.
2250 int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2252 struct file_lock *fl;
2253 int result = 1;
2254 lock_kernel();
2255 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2256 if (IS_POSIX(fl)) {
2257 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2258 continue;
2259 } else if (IS_FLOCK(fl)) {
2260 if (!(fl->fl_type & LOCK_MAND))
2261 continue;
2262 if (fl->fl_type & LOCK_WRITE)
2263 continue;
2264 } else
2265 continue;
2266 result = 0;
2267 break;
2269 unlock_kernel();
2270 return result;
2273 EXPORT_SYMBOL(lock_may_write);
2275 static int __init filelock_init(void)
2277 filelock_cache = kmem_cache_create("file_lock_cache",
2278 sizeof(struct file_lock), 0, SLAB_PANIC,
2279 init_once, NULL);
2280 return 0;
2283 core_initcall(filelock_init);