x86/mm: Create asm/invpcid.h
[linux/fpc-iii.git] / fs / locks.c
blob1bd71c4d663a8c0356c457905293b5e9e35f2c9a
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/filesystems/mandatory-locking.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/fdtable.h>
120 #include <linux/fs.h>
121 #include <linux/init.h>
122 #include <linux/security.h>
123 #include <linux/slab.h>
124 #include <linux/syscalls.h>
125 #include <linux/time.h>
126 #include <linux/rcupdate.h>
127 #include <linux/pid_namespace.h>
128 #include <linux/hashtable.h>
129 #include <linux/percpu.h>
131 #define CREATE_TRACE_POINTS
132 #include <trace/events/filelock.h>
134 #include <linux/uaccess.h>
136 #define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
137 #define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
138 #define IS_LEASE(fl) (fl->fl_flags & (FL_LEASE|FL_DELEG|FL_LAYOUT))
139 #define IS_OFDLCK(fl) (fl->fl_flags & FL_OFDLCK)
140 #define IS_REMOTELCK(fl) (fl->fl_pid <= 0)
142 static inline bool is_remote_lock(struct file *filp)
144 return likely(!(filp->f_path.dentry->d_sb->s_flags & MS_NOREMOTELOCK));
147 static bool lease_breaking(struct file_lock *fl)
149 return fl->fl_flags & (FL_UNLOCK_PENDING | FL_DOWNGRADE_PENDING);
152 static int target_leasetype(struct file_lock *fl)
154 if (fl->fl_flags & FL_UNLOCK_PENDING)
155 return F_UNLCK;
156 if (fl->fl_flags & FL_DOWNGRADE_PENDING)
157 return F_RDLCK;
158 return fl->fl_type;
161 int leases_enable = 1;
162 int lease_break_time = 45;
165 * The global file_lock_list is only used for displaying /proc/locks, so we
166 * keep a list on each CPU, with each list protected by its own spinlock.
167 * Global serialization is done using file_rwsem.
169 * Note that alterations to the list also require that the relevant flc_lock is
170 * held.
172 struct file_lock_list_struct {
173 spinlock_t lock;
174 struct hlist_head hlist;
176 static DEFINE_PER_CPU(struct file_lock_list_struct, file_lock_list);
177 DEFINE_STATIC_PERCPU_RWSEM(file_rwsem);
180 * The blocked_hash is used to find POSIX lock loops for deadlock detection.
181 * It is protected by blocked_lock_lock.
183 * We hash locks by lockowner in order to optimize searching for the lock a
184 * particular lockowner is waiting on.
186 * FIXME: make this value scale via some heuristic? We generally will want more
187 * buckets when we have more lockowners holding locks, but that's a little
188 * difficult to determine without knowing what the workload will look like.
190 #define BLOCKED_HASH_BITS 7
191 static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
194 * This lock protects the blocked_hash. Generally, if you're accessing it, you
195 * want to be holding this lock.
197 * In addition, it also protects the fl->fl_block list, and the fl->fl_next
198 * pointer for file_lock structures that are acting as lock requests (in
199 * contrast to those that are acting as records of acquired locks).
201 * Note that when we acquire this lock in order to change the above fields,
202 * we often hold the flc_lock as well. In certain cases, when reading the fields
203 * protected by this lock, we can skip acquiring it iff we already hold the
204 * flc_lock.
206 * In particular, adding an entry to the fl_block list requires that you hold
207 * both the flc_lock and the blocked_lock_lock (acquired in that order).
208 * Deleting an entry from the list however only requires the file_lock_lock.
210 static DEFINE_SPINLOCK(blocked_lock_lock);
212 static struct kmem_cache *flctx_cache __read_mostly;
213 static struct kmem_cache *filelock_cache __read_mostly;
215 static struct file_lock_context *
216 locks_get_lock_context(struct inode *inode, int type)
218 struct file_lock_context *ctx;
220 /* paired with cmpxchg() below */
221 ctx = smp_load_acquire(&inode->i_flctx);
222 if (likely(ctx) || type == F_UNLCK)
223 goto out;
225 ctx = kmem_cache_alloc(flctx_cache, GFP_KERNEL);
226 if (!ctx)
227 goto out;
229 spin_lock_init(&ctx->flc_lock);
230 INIT_LIST_HEAD(&ctx->flc_flock);
231 INIT_LIST_HEAD(&ctx->flc_posix);
232 INIT_LIST_HEAD(&ctx->flc_lease);
235 * Assign the pointer if it's not already assigned. If it is, then
236 * free the context we just allocated.
238 if (cmpxchg(&inode->i_flctx, NULL, ctx)) {
239 kmem_cache_free(flctx_cache, ctx);
240 ctx = smp_load_acquire(&inode->i_flctx);
242 out:
243 trace_locks_get_lock_context(inode, type, ctx);
244 return ctx;
247 static void
248 locks_dump_ctx_list(struct list_head *list, char *list_type)
250 struct file_lock *fl;
252 list_for_each_entry(fl, list, fl_list) {
253 pr_warn("%s: fl_owner=%p fl_flags=0x%x fl_type=0x%x fl_pid=%u\n", list_type, fl->fl_owner, fl->fl_flags, fl->fl_type, fl->fl_pid);
257 static void
258 locks_check_ctx_lists(struct inode *inode)
260 struct file_lock_context *ctx = inode->i_flctx;
262 if (unlikely(!list_empty(&ctx->flc_flock) ||
263 !list_empty(&ctx->flc_posix) ||
264 !list_empty(&ctx->flc_lease))) {
265 pr_warn("Leaked locks on dev=0x%x:0x%x ino=0x%lx:\n",
266 MAJOR(inode->i_sb->s_dev), MINOR(inode->i_sb->s_dev),
267 inode->i_ino);
268 locks_dump_ctx_list(&ctx->flc_flock, "FLOCK");
269 locks_dump_ctx_list(&ctx->flc_posix, "POSIX");
270 locks_dump_ctx_list(&ctx->flc_lease, "LEASE");
274 static void
275 locks_check_ctx_file_list(struct file *filp, struct list_head *list,
276 char *list_type)
278 struct file_lock *fl;
279 struct inode *inode = locks_inode(filp);
281 list_for_each_entry(fl, list, fl_list)
282 if (fl->fl_file == filp)
283 pr_warn("Leaked %s lock on dev=0x%x:0x%x ino=0x%lx "
284 " fl_owner=%p fl_flags=0x%x fl_type=0x%x fl_pid=%u\n",
285 list_type, MAJOR(inode->i_sb->s_dev),
286 MINOR(inode->i_sb->s_dev), inode->i_ino,
287 fl->fl_owner, fl->fl_flags, fl->fl_type, fl->fl_pid);
290 void
291 locks_free_lock_context(struct inode *inode)
293 struct file_lock_context *ctx = inode->i_flctx;
295 if (unlikely(ctx)) {
296 locks_check_ctx_lists(inode);
297 kmem_cache_free(flctx_cache, ctx);
301 static void locks_init_lock_heads(struct file_lock *fl)
303 INIT_HLIST_NODE(&fl->fl_link);
304 INIT_LIST_HEAD(&fl->fl_list);
305 INIT_LIST_HEAD(&fl->fl_block);
306 init_waitqueue_head(&fl->fl_wait);
309 /* Allocate an empty lock structure. */
310 struct file_lock *locks_alloc_lock(void)
312 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
314 if (fl)
315 locks_init_lock_heads(fl);
317 return fl;
319 EXPORT_SYMBOL_GPL(locks_alloc_lock);
321 void locks_release_private(struct file_lock *fl)
323 if (fl->fl_ops) {
324 if (fl->fl_ops->fl_release_private)
325 fl->fl_ops->fl_release_private(fl);
326 fl->fl_ops = NULL;
329 if (fl->fl_lmops) {
330 if (fl->fl_lmops->lm_put_owner) {
331 fl->fl_lmops->lm_put_owner(fl->fl_owner);
332 fl->fl_owner = NULL;
334 fl->fl_lmops = NULL;
337 EXPORT_SYMBOL_GPL(locks_release_private);
339 /* Free a lock which is not in use. */
340 void locks_free_lock(struct file_lock *fl)
342 BUG_ON(waitqueue_active(&fl->fl_wait));
343 BUG_ON(!list_empty(&fl->fl_list));
344 BUG_ON(!list_empty(&fl->fl_block));
345 BUG_ON(!hlist_unhashed(&fl->fl_link));
347 locks_release_private(fl);
348 kmem_cache_free(filelock_cache, fl);
350 EXPORT_SYMBOL(locks_free_lock);
352 static void
353 locks_dispose_list(struct list_head *dispose)
355 struct file_lock *fl;
357 while (!list_empty(dispose)) {
358 fl = list_first_entry(dispose, struct file_lock, fl_list);
359 list_del_init(&fl->fl_list);
360 locks_free_lock(fl);
364 void locks_init_lock(struct file_lock *fl)
366 memset(fl, 0, sizeof(struct file_lock));
367 locks_init_lock_heads(fl);
370 EXPORT_SYMBOL(locks_init_lock);
373 * Initialize a new lock from an existing file_lock structure.
375 void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
377 new->fl_owner = fl->fl_owner;
378 new->fl_pid = fl->fl_pid;
379 new->fl_file = NULL;
380 new->fl_flags = fl->fl_flags;
381 new->fl_type = fl->fl_type;
382 new->fl_start = fl->fl_start;
383 new->fl_end = fl->fl_end;
384 new->fl_lmops = fl->fl_lmops;
385 new->fl_ops = NULL;
387 if (fl->fl_lmops) {
388 if (fl->fl_lmops->lm_get_owner)
389 fl->fl_lmops->lm_get_owner(fl->fl_owner);
392 EXPORT_SYMBOL(locks_copy_conflock);
394 void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
396 /* "new" must be a freshly-initialized lock */
397 WARN_ON_ONCE(new->fl_ops);
399 locks_copy_conflock(new, fl);
401 new->fl_file = fl->fl_file;
402 new->fl_ops = fl->fl_ops;
404 if (fl->fl_ops) {
405 if (fl->fl_ops->fl_copy_lock)
406 fl->fl_ops->fl_copy_lock(new, fl);
410 EXPORT_SYMBOL(locks_copy_lock);
412 static inline int flock_translate_cmd(int cmd) {
413 if (cmd & LOCK_MAND)
414 return cmd & (LOCK_MAND | LOCK_RW);
415 switch (cmd) {
416 case LOCK_SH:
417 return F_RDLCK;
418 case LOCK_EX:
419 return F_WRLCK;
420 case LOCK_UN:
421 return F_UNLCK;
423 return -EINVAL;
426 /* Fill in a file_lock structure with an appropriate FLOCK lock. */
427 static struct file_lock *
428 flock_make_lock(struct file *filp, unsigned int cmd)
430 struct file_lock *fl;
431 int type = flock_translate_cmd(cmd);
433 if (type < 0)
434 return ERR_PTR(type);
436 fl = locks_alloc_lock();
437 if (fl == NULL)
438 return ERR_PTR(-ENOMEM);
440 fl->fl_file = filp;
441 fl->fl_owner = filp;
442 fl->fl_pid = current->tgid;
443 fl->fl_flags = FL_FLOCK;
444 fl->fl_type = type;
445 fl->fl_end = OFFSET_MAX;
447 return fl;
450 static int assign_type(struct file_lock *fl, long type)
452 switch (type) {
453 case F_RDLCK:
454 case F_WRLCK:
455 case F_UNLCK:
456 fl->fl_type = type;
457 break;
458 default:
459 return -EINVAL;
461 return 0;
464 static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
465 struct flock64 *l)
467 switch (l->l_whence) {
468 case SEEK_SET:
469 fl->fl_start = 0;
470 break;
471 case SEEK_CUR:
472 fl->fl_start = filp->f_pos;
473 break;
474 case SEEK_END:
475 fl->fl_start = i_size_read(file_inode(filp));
476 break;
477 default:
478 return -EINVAL;
480 if (l->l_start > OFFSET_MAX - fl->fl_start)
481 return -EOVERFLOW;
482 fl->fl_start += l->l_start;
483 if (fl->fl_start < 0)
484 return -EINVAL;
486 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
487 POSIX-2001 defines it. */
488 if (l->l_len > 0) {
489 if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
490 return -EOVERFLOW;
491 fl->fl_end = fl->fl_start + l->l_len - 1;
493 } else if (l->l_len < 0) {
494 if (fl->fl_start + l->l_len < 0)
495 return -EINVAL;
496 fl->fl_end = fl->fl_start - 1;
497 fl->fl_start += l->l_len;
498 } else
499 fl->fl_end = OFFSET_MAX;
501 fl->fl_owner = current->files;
502 fl->fl_pid = current->tgid;
503 fl->fl_file = filp;
504 fl->fl_flags = FL_POSIX;
505 fl->fl_ops = NULL;
506 fl->fl_lmops = NULL;
508 return assign_type(fl, l->l_type);
511 /* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
512 * style lock.
514 static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
515 struct flock *l)
517 struct flock64 ll = {
518 .l_type = l->l_type,
519 .l_whence = l->l_whence,
520 .l_start = l->l_start,
521 .l_len = l->l_len,
524 return flock64_to_posix_lock(filp, fl, &ll);
527 /* default lease lock manager operations */
528 static bool
529 lease_break_callback(struct file_lock *fl)
531 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
532 return false;
535 static void
536 lease_setup(struct file_lock *fl, void **priv)
538 struct file *filp = fl->fl_file;
539 struct fasync_struct *fa = *priv;
542 * fasync_insert_entry() returns the old entry if any. If there was no
543 * old entry, then it used "priv" and inserted it into the fasync list.
544 * Clear the pointer to indicate that it shouldn't be freed.
546 if (!fasync_insert_entry(fa->fa_fd, filp, &fl->fl_fasync, fa))
547 *priv = NULL;
549 __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
552 static const struct lock_manager_operations lease_manager_ops = {
553 .lm_break = lease_break_callback,
554 .lm_change = lease_modify,
555 .lm_setup = lease_setup,
559 * Initialize a lease, use the default lock manager operations
561 static int lease_init(struct file *filp, long type, struct file_lock *fl)
563 if (assign_type(fl, type) != 0)
564 return -EINVAL;
566 fl->fl_owner = filp;
567 fl->fl_pid = current->tgid;
569 fl->fl_file = filp;
570 fl->fl_flags = FL_LEASE;
571 fl->fl_start = 0;
572 fl->fl_end = OFFSET_MAX;
573 fl->fl_ops = NULL;
574 fl->fl_lmops = &lease_manager_ops;
575 return 0;
578 /* Allocate a file_lock initialised to this type of lease */
579 static struct file_lock *lease_alloc(struct file *filp, long type)
581 struct file_lock *fl = locks_alloc_lock();
582 int error = -ENOMEM;
584 if (fl == NULL)
585 return ERR_PTR(error);
587 error = lease_init(filp, type, fl);
588 if (error) {
589 locks_free_lock(fl);
590 return ERR_PTR(error);
592 return fl;
595 /* Check if two locks overlap each other.
597 static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
599 return ((fl1->fl_end >= fl2->fl_start) &&
600 (fl2->fl_end >= fl1->fl_start));
604 * Check whether two locks have the same owner.
606 static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
608 if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
609 return fl2->fl_lmops == fl1->fl_lmops &&
610 fl1->fl_lmops->lm_compare_owner(fl1, fl2);
611 return fl1->fl_owner == fl2->fl_owner;
614 /* Must be called with the flc_lock held! */
615 static void locks_insert_global_locks(struct file_lock *fl)
617 struct file_lock_list_struct *fll = this_cpu_ptr(&file_lock_list);
619 percpu_rwsem_assert_held(&file_rwsem);
621 spin_lock(&fll->lock);
622 fl->fl_link_cpu = smp_processor_id();
623 hlist_add_head(&fl->fl_link, &fll->hlist);
624 spin_unlock(&fll->lock);
627 /* Must be called with the flc_lock held! */
628 static void locks_delete_global_locks(struct file_lock *fl)
630 struct file_lock_list_struct *fll;
632 percpu_rwsem_assert_held(&file_rwsem);
635 * Avoid taking lock if already unhashed. This is safe since this check
636 * is done while holding the flc_lock, and new insertions into the list
637 * also require that it be held.
639 if (hlist_unhashed(&fl->fl_link))
640 return;
642 fll = per_cpu_ptr(&file_lock_list, fl->fl_link_cpu);
643 spin_lock(&fll->lock);
644 hlist_del_init(&fl->fl_link);
645 spin_unlock(&fll->lock);
648 static unsigned long
649 posix_owner_key(struct file_lock *fl)
651 if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
652 return fl->fl_lmops->lm_owner_key(fl);
653 return (unsigned long)fl->fl_owner;
656 static void locks_insert_global_blocked(struct file_lock *waiter)
658 lockdep_assert_held(&blocked_lock_lock);
660 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
663 static void locks_delete_global_blocked(struct file_lock *waiter)
665 lockdep_assert_held(&blocked_lock_lock);
667 hash_del(&waiter->fl_link);
670 /* Remove waiter from blocker's block list.
671 * When blocker ends up pointing to itself then the list is empty.
673 * Must be called with blocked_lock_lock held.
675 static void __locks_delete_block(struct file_lock *waiter)
677 locks_delete_global_blocked(waiter);
678 list_del_init(&waiter->fl_block);
679 waiter->fl_next = NULL;
682 static void locks_delete_block(struct file_lock *waiter)
684 spin_lock(&blocked_lock_lock);
685 __locks_delete_block(waiter);
686 spin_unlock(&blocked_lock_lock);
689 /* Insert waiter into blocker's block list.
690 * We use a circular list so that processes can be easily woken up in
691 * the order they blocked. The documentation doesn't require this but
692 * it seems like the reasonable thing to do.
694 * Must be called with both the flc_lock and blocked_lock_lock held. The
695 * fl_block list itself is protected by the blocked_lock_lock, but by ensuring
696 * that the flc_lock is also held on insertions we can avoid taking the
697 * blocked_lock_lock in some cases when we see that the fl_block list is empty.
699 static void __locks_insert_block(struct file_lock *blocker,
700 struct file_lock *waiter)
702 BUG_ON(!list_empty(&waiter->fl_block));
703 waiter->fl_next = blocker;
704 list_add_tail(&waiter->fl_block, &blocker->fl_block);
705 if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
706 locks_insert_global_blocked(waiter);
709 /* Must be called with flc_lock held. */
710 static void locks_insert_block(struct file_lock *blocker,
711 struct file_lock *waiter)
713 spin_lock(&blocked_lock_lock);
714 __locks_insert_block(blocker, waiter);
715 spin_unlock(&blocked_lock_lock);
719 * Wake up processes blocked waiting for blocker.
721 * Must be called with the inode->flc_lock held!
723 static void locks_wake_up_blocks(struct file_lock *blocker)
726 * Avoid taking global lock if list is empty. This is safe since new
727 * blocked requests are only added to the list under the flc_lock, and
728 * the flc_lock is always held here. Note that removal from the fl_block
729 * list does not require the flc_lock, so we must recheck list_empty()
730 * after acquiring the blocked_lock_lock.
732 if (list_empty(&blocker->fl_block))
733 return;
735 spin_lock(&blocked_lock_lock);
736 while (!list_empty(&blocker->fl_block)) {
737 struct file_lock *waiter;
739 waiter = list_first_entry(&blocker->fl_block,
740 struct file_lock, fl_block);
741 __locks_delete_block(waiter);
742 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
743 waiter->fl_lmops->lm_notify(waiter);
744 else
745 wake_up(&waiter->fl_wait);
747 spin_unlock(&blocked_lock_lock);
750 static void
751 locks_insert_lock_ctx(struct file_lock *fl, struct list_head *before)
753 list_add_tail(&fl->fl_list, before);
754 locks_insert_global_locks(fl);
757 static void
758 locks_unlink_lock_ctx(struct file_lock *fl)
760 locks_delete_global_locks(fl);
761 list_del_init(&fl->fl_list);
762 locks_wake_up_blocks(fl);
765 static void
766 locks_delete_lock_ctx(struct file_lock *fl, struct list_head *dispose)
768 locks_unlink_lock_ctx(fl);
769 if (dispose)
770 list_add(&fl->fl_list, dispose);
771 else
772 locks_free_lock(fl);
775 /* Determine if lock sys_fl blocks lock caller_fl. Common functionality
776 * checks for shared/exclusive status of overlapping locks.
778 static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
780 if (sys_fl->fl_type == F_WRLCK)
781 return 1;
782 if (caller_fl->fl_type == F_WRLCK)
783 return 1;
784 return 0;
787 /* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
788 * checking before calling the locks_conflict().
790 static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
792 /* POSIX locks owned by the same process do not conflict with
793 * each other.
795 if (posix_same_owner(caller_fl, sys_fl))
796 return (0);
798 /* Check whether they overlap */
799 if (!locks_overlap(caller_fl, sys_fl))
800 return 0;
802 return (locks_conflict(caller_fl, sys_fl));
805 /* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
806 * checking before calling the locks_conflict().
808 static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
810 /* FLOCK locks referring to the same filp do not conflict with
811 * each other.
813 if (caller_fl->fl_file == sys_fl->fl_file)
814 return (0);
815 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
816 return 0;
818 return (locks_conflict(caller_fl, sys_fl));
821 void
822 posix_test_lock(struct file *filp, struct file_lock *fl)
824 struct file_lock *cfl;
825 struct file_lock_context *ctx;
826 struct inode *inode = locks_inode(filp);
828 ctx = smp_load_acquire(&inode->i_flctx);
829 if (!ctx || list_empty_careful(&ctx->flc_posix)) {
830 fl->fl_type = F_UNLCK;
831 return;
834 spin_lock(&ctx->flc_lock);
835 list_for_each_entry(cfl, &ctx->flc_posix, fl_list) {
836 if (posix_locks_conflict(fl, cfl)) {
837 locks_copy_conflock(fl, cfl);
838 goto out;
841 fl->fl_type = F_UNLCK;
842 out:
843 spin_unlock(&ctx->flc_lock);
844 return;
846 EXPORT_SYMBOL(posix_test_lock);
849 * Deadlock detection:
851 * We attempt to detect deadlocks that are due purely to posix file
852 * locks.
854 * We assume that a task can be waiting for at most one lock at a time.
855 * So for any acquired lock, the process holding that lock may be
856 * waiting on at most one other lock. That lock in turns may be held by
857 * someone waiting for at most one other lock. Given a requested lock
858 * caller_fl which is about to wait for a conflicting lock block_fl, we
859 * follow this chain of waiters to ensure we are not about to create a
860 * cycle.
862 * Since we do this before we ever put a process to sleep on a lock, we
863 * are ensured that there is never a cycle; that is what guarantees that
864 * the while() loop in posix_locks_deadlock() eventually completes.
866 * Note: the above assumption may not be true when handling lock
867 * requests from a broken NFS client. It may also fail in the presence
868 * of tasks (such as posix threads) sharing the same open file table.
869 * To handle those cases, we just bail out after a few iterations.
871 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
872 * Because the owner is not even nominally tied to a thread of
873 * execution, the deadlock detection below can't reasonably work well. Just
874 * skip it for those.
876 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
877 * locks that just checks for the case where two tasks are attempting to
878 * upgrade from read to write locks on the same inode.
881 #define MAX_DEADLK_ITERATIONS 10
883 /* Find a lock that the owner of the given block_fl is blocking on. */
884 static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
886 struct file_lock *fl;
888 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
889 if (posix_same_owner(fl, block_fl))
890 return fl->fl_next;
892 return NULL;
895 /* Must be called with the blocked_lock_lock held! */
896 static int posix_locks_deadlock(struct file_lock *caller_fl,
897 struct file_lock *block_fl)
899 int i = 0;
901 lockdep_assert_held(&blocked_lock_lock);
904 * This deadlock detector can't reasonably detect deadlocks with
905 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
907 if (IS_OFDLCK(caller_fl))
908 return 0;
910 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
911 if (i++ > MAX_DEADLK_ITERATIONS)
912 return 0;
913 if (posix_same_owner(caller_fl, block_fl))
914 return 1;
916 return 0;
919 /* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
920 * after any leases, but before any posix locks.
922 * Note that if called with an FL_EXISTS argument, the caller may determine
923 * whether or not a lock was successfully freed by testing the return
924 * value for -ENOENT.
926 static int flock_lock_inode(struct inode *inode, struct file_lock *request)
928 struct file_lock *new_fl = NULL;
929 struct file_lock *fl;
930 struct file_lock_context *ctx;
931 int error = 0;
932 bool found = false;
933 LIST_HEAD(dispose);
935 ctx = locks_get_lock_context(inode, request->fl_type);
936 if (!ctx) {
937 if (request->fl_type != F_UNLCK)
938 return -ENOMEM;
939 return (request->fl_flags & FL_EXISTS) ? -ENOENT : 0;
942 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
943 new_fl = locks_alloc_lock();
944 if (!new_fl)
945 return -ENOMEM;
948 percpu_down_read_preempt_disable(&file_rwsem);
949 spin_lock(&ctx->flc_lock);
950 if (request->fl_flags & FL_ACCESS)
951 goto find_conflict;
953 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
954 if (request->fl_file != fl->fl_file)
955 continue;
956 if (request->fl_type == fl->fl_type)
957 goto out;
958 found = true;
959 locks_delete_lock_ctx(fl, &dispose);
960 break;
963 if (request->fl_type == F_UNLCK) {
964 if ((request->fl_flags & FL_EXISTS) && !found)
965 error = -ENOENT;
966 goto out;
969 find_conflict:
970 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
971 if (!flock_locks_conflict(request, fl))
972 continue;
973 error = -EAGAIN;
974 if (!(request->fl_flags & FL_SLEEP))
975 goto out;
976 error = FILE_LOCK_DEFERRED;
977 locks_insert_block(fl, request);
978 goto out;
980 if (request->fl_flags & FL_ACCESS)
981 goto out;
982 locks_copy_lock(new_fl, request);
983 locks_insert_lock_ctx(new_fl, &ctx->flc_flock);
984 new_fl = NULL;
985 error = 0;
987 out:
988 spin_unlock(&ctx->flc_lock);
989 percpu_up_read_preempt_enable(&file_rwsem);
990 if (new_fl)
991 locks_free_lock(new_fl);
992 locks_dispose_list(&dispose);
993 return error;
996 static int posix_lock_inode(struct inode *inode, struct file_lock *request,
997 struct file_lock *conflock)
999 struct file_lock *fl, *tmp;
1000 struct file_lock *new_fl = NULL;
1001 struct file_lock *new_fl2 = NULL;
1002 struct file_lock *left = NULL;
1003 struct file_lock *right = NULL;
1004 struct file_lock_context *ctx;
1005 int error;
1006 bool added = false;
1007 LIST_HEAD(dispose);
1009 ctx = locks_get_lock_context(inode, request->fl_type);
1010 if (!ctx)
1011 return (request->fl_type == F_UNLCK) ? 0 : -ENOMEM;
1014 * We may need two file_lock structures for this operation,
1015 * so we get them in advance to avoid races.
1017 * In some cases we can be sure, that no new locks will be needed
1019 if (!(request->fl_flags & FL_ACCESS) &&
1020 (request->fl_type != F_UNLCK ||
1021 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
1022 new_fl = locks_alloc_lock();
1023 new_fl2 = locks_alloc_lock();
1026 percpu_down_read_preempt_disable(&file_rwsem);
1027 spin_lock(&ctx->flc_lock);
1029 * New lock request. Walk all POSIX locks and look for conflicts. If
1030 * there are any, either return error or put the request on the
1031 * blocker's list of waiters and the global blocked_hash.
1033 if (request->fl_type != F_UNLCK) {
1034 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1035 if (!posix_locks_conflict(request, fl))
1036 continue;
1037 if (conflock)
1038 locks_copy_conflock(conflock, fl);
1039 error = -EAGAIN;
1040 if (!(request->fl_flags & FL_SLEEP))
1041 goto out;
1043 * Deadlock detection and insertion into the blocked
1044 * locks list must be done while holding the same lock!
1046 error = -EDEADLK;
1047 spin_lock(&blocked_lock_lock);
1048 if (likely(!posix_locks_deadlock(request, fl))) {
1049 error = FILE_LOCK_DEFERRED;
1050 __locks_insert_block(fl, request);
1052 spin_unlock(&blocked_lock_lock);
1053 goto out;
1057 /* If we're just looking for a conflict, we're done. */
1058 error = 0;
1059 if (request->fl_flags & FL_ACCESS)
1060 goto out;
1062 /* Find the first old lock with the same owner as the new lock */
1063 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1064 if (posix_same_owner(request, fl))
1065 break;
1068 /* Process locks with this owner. */
1069 list_for_each_entry_safe_from(fl, tmp, &ctx->flc_posix, fl_list) {
1070 if (!posix_same_owner(request, fl))
1071 break;
1073 /* Detect adjacent or overlapping regions (if same lock type) */
1074 if (request->fl_type == fl->fl_type) {
1075 /* In all comparisons of start vs end, use
1076 * "start - 1" rather than "end + 1". If end
1077 * is OFFSET_MAX, end + 1 will become negative.
1079 if (fl->fl_end < request->fl_start - 1)
1080 continue;
1081 /* If the next lock in the list has entirely bigger
1082 * addresses than the new one, insert the lock here.
1084 if (fl->fl_start - 1 > request->fl_end)
1085 break;
1087 /* If we come here, the new and old lock are of the
1088 * same type and adjacent or overlapping. Make one
1089 * lock yielding from the lower start address of both
1090 * locks to the higher end address.
1092 if (fl->fl_start > request->fl_start)
1093 fl->fl_start = request->fl_start;
1094 else
1095 request->fl_start = fl->fl_start;
1096 if (fl->fl_end < request->fl_end)
1097 fl->fl_end = request->fl_end;
1098 else
1099 request->fl_end = fl->fl_end;
1100 if (added) {
1101 locks_delete_lock_ctx(fl, &dispose);
1102 continue;
1104 request = fl;
1105 added = true;
1106 } else {
1107 /* Processing for different lock types is a bit
1108 * more complex.
1110 if (fl->fl_end < request->fl_start)
1111 continue;
1112 if (fl->fl_start > request->fl_end)
1113 break;
1114 if (request->fl_type == F_UNLCK)
1115 added = true;
1116 if (fl->fl_start < request->fl_start)
1117 left = fl;
1118 /* If the next lock in the list has a higher end
1119 * address than the new one, insert the new one here.
1121 if (fl->fl_end > request->fl_end) {
1122 right = fl;
1123 break;
1125 if (fl->fl_start >= request->fl_start) {
1126 /* The new lock completely replaces an old
1127 * one (This may happen several times).
1129 if (added) {
1130 locks_delete_lock_ctx(fl, &dispose);
1131 continue;
1134 * Replace the old lock with new_fl, and
1135 * remove the old one. It's safe to do the
1136 * insert here since we know that we won't be
1137 * using new_fl later, and that the lock is
1138 * just replacing an existing lock.
1140 error = -ENOLCK;
1141 if (!new_fl)
1142 goto out;
1143 locks_copy_lock(new_fl, request);
1144 request = new_fl;
1145 new_fl = NULL;
1146 locks_insert_lock_ctx(request, &fl->fl_list);
1147 locks_delete_lock_ctx(fl, &dispose);
1148 added = true;
1154 * The above code only modifies existing locks in case of merging or
1155 * replacing. If new lock(s) need to be inserted all modifications are
1156 * done below this, so it's safe yet to bail out.
1158 error = -ENOLCK; /* "no luck" */
1159 if (right && left == right && !new_fl2)
1160 goto out;
1162 error = 0;
1163 if (!added) {
1164 if (request->fl_type == F_UNLCK) {
1165 if (request->fl_flags & FL_EXISTS)
1166 error = -ENOENT;
1167 goto out;
1170 if (!new_fl) {
1171 error = -ENOLCK;
1172 goto out;
1174 locks_copy_lock(new_fl, request);
1175 locks_insert_lock_ctx(new_fl, &fl->fl_list);
1176 fl = new_fl;
1177 new_fl = NULL;
1179 if (right) {
1180 if (left == right) {
1181 /* The new lock breaks the old one in two pieces,
1182 * so we have to use the second new lock.
1184 left = new_fl2;
1185 new_fl2 = NULL;
1186 locks_copy_lock(left, right);
1187 locks_insert_lock_ctx(left, &fl->fl_list);
1189 right->fl_start = request->fl_end + 1;
1190 locks_wake_up_blocks(right);
1192 if (left) {
1193 left->fl_end = request->fl_start - 1;
1194 locks_wake_up_blocks(left);
1196 out:
1197 spin_unlock(&ctx->flc_lock);
1198 percpu_up_read_preempt_enable(&file_rwsem);
1200 * Free any unused locks.
1202 if (new_fl)
1203 locks_free_lock(new_fl);
1204 if (new_fl2)
1205 locks_free_lock(new_fl2);
1206 locks_dispose_list(&dispose);
1207 trace_posix_lock_inode(inode, request, error);
1209 return error;
1213 * posix_lock_file - Apply a POSIX-style lock to a file
1214 * @filp: The file to apply the lock to
1215 * @fl: The lock to be applied
1216 * @conflock: Place to return a copy of the conflicting lock, if found.
1218 * Add a POSIX style lock to a file.
1219 * We merge adjacent & overlapping locks whenever possible.
1220 * POSIX locks are sorted by owner task, then by starting address
1222 * Note that if called with an FL_EXISTS argument, the caller may determine
1223 * whether or not a lock was successfully freed by testing the return
1224 * value for -ENOENT.
1226 int posix_lock_file(struct file *filp, struct file_lock *fl,
1227 struct file_lock *conflock)
1229 return posix_lock_inode(locks_inode(filp), fl, conflock);
1231 EXPORT_SYMBOL(posix_lock_file);
1234 * posix_lock_inode_wait - Apply a POSIX-style lock to a file
1235 * @inode: inode of file to which lock request should be applied
1236 * @fl: The lock to be applied
1238 * Apply a POSIX style lock request to an inode.
1240 static int posix_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1242 int error;
1243 might_sleep ();
1244 for (;;) {
1245 error = posix_lock_inode(inode, fl, NULL);
1246 if (error != FILE_LOCK_DEFERRED)
1247 break;
1248 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1249 if (!error)
1250 continue;
1252 locks_delete_block(fl);
1253 break;
1255 return error;
1258 #ifdef CONFIG_MANDATORY_FILE_LOCKING
1260 * locks_mandatory_locked - Check for an active lock
1261 * @file: the file to check
1263 * Searches the inode's list of locks to find any POSIX locks which conflict.
1264 * This function is called from locks_verify_locked() only.
1266 int locks_mandatory_locked(struct file *file)
1268 int ret;
1269 struct inode *inode = locks_inode(file);
1270 struct file_lock_context *ctx;
1271 struct file_lock *fl;
1273 ctx = smp_load_acquire(&inode->i_flctx);
1274 if (!ctx || list_empty_careful(&ctx->flc_posix))
1275 return 0;
1278 * Search the lock list for this inode for any POSIX locks.
1280 spin_lock(&ctx->flc_lock);
1281 ret = 0;
1282 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1283 if (fl->fl_owner != current->files &&
1284 fl->fl_owner != file) {
1285 ret = -EAGAIN;
1286 break;
1289 spin_unlock(&ctx->flc_lock);
1290 return ret;
1294 * locks_mandatory_area - Check for a conflicting lock
1295 * @inode: the file to check
1296 * @filp: how the file was opened (if it was)
1297 * @start: first byte in the file to check
1298 * @end: lastbyte in the file to check
1299 * @type: %F_WRLCK for a write lock, else %F_RDLCK
1301 * Searches the inode's list of locks to find any POSIX locks which conflict.
1303 int locks_mandatory_area(struct inode *inode, struct file *filp, loff_t start,
1304 loff_t end, unsigned char type)
1306 struct file_lock fl;
1307 int error;
1308 bool sleep = false;
1310 locks_init_lock(&fl);
1311 fl.fl_pid = current->tgid;
1312 fl.fl_file = filp;
1313 fl.fl_flags = FL_POSIX | FL_ACCESS;
1314 if (filp && !(filp->f_flags & O_NONBLOCK))
1315 sleep = true;
1316 fl.fl_type = type;
1317 fl.fl_start = start;
1318 fl.fl_end = end;
1320 for (;;) {
1321 if (filp) {
1322 fl.fl_owner = filp;
1323 fl.fl_flags &= ~FL_SLEEP;
1324 error = posix_lock_inode(inode, &fl, NULL);
1325 if (!error)
1326 break;
1329 if (sleep)
1330 fl.fl_flags |= FL_SLEEP;
1331 fl.fl_owner = current->files;
1332 error = posix_lock_inode(inode, &fl, NULL);
1333 if (error != FILE_LOCK_DEFERRED)
1334 break;
1335 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1336 if (!error) {
1338 * If we've been sleeping someone might have
1339 * changed the permissions behind our back.
1341 if (__mandatory_lock(inode))
1342 continue;
1345 locks_delete_block(&fl);
1346 break;
1349 return error;
1352 EXPORT_SYMBOL(locks_mandatory_area);
1353 #endif /* CONFIG_MANDATORY_FILE_LOCKING */
1355 static void lease_clear_pending(struct file_lock *fl, int arg)
1357 switch (arg) {
1358 case F_UNLCK:
1359 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1360 /* fall through: */
1361 case F_RDLCK:
1362 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1366 /* We already had a lease on this file; just change its type */
1367 int lease_modify(struct file_lock *fl, int arg, struct list_head *dispose)
1369 int error = assign_type(fl, arg);
1371 if (error)
1372 return error;
1373 lease_clear_pending(fl, arg);
1374 locks_wake_up_blocks(fl);
1375 if (arg == F_UNLCK) {
1376 struct file *filp = fl->fl_file;
1378 f_delown(filp);
1379 filp->f_owner.signum = 0;
1380 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1381 if (fl->fl_fasync != NULL) {
1382 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1383 fl->fl_fasync = NULL;
1385 locks_delete_lock_ctx(fl, dispose);
1387 return 0;
1389 EXPORT_SYMBOL(lease_modify);
1391 static bool past_time(unsigned long then)
1393 if (!then)
1394 /* 0 is a special value meaning "this never expires": */
1395 return false;
1396 return time_after(jiffies, then);
1399 static void time_out_leases(struct inode *inode, struct list_head *dispose)
1401 struct file_lock_context *ctx = inode->i_flctx;
1402 struct file_lock *fl, *tmp;
1404 lockdep_assert_held(&ctx->flc_lock);
1406 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
1407 trace_time_out_leases(inode, fl);
1408 if (past_time(fl->fl_downgrade_time))
1409 lease_modify(fl, F_RDLCK, dispose);
1410 if (past_time(fl->fl_break_time))
1411 lease_modify(fl, F_UNLCK, dispose);
1415 static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1417 if ((breaker->fl_flags & FL_LAYOUT) != (lease->fl_flags & FL_LAYOUT))
1418 return false;
1419 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1420 return false;
1421 return locks_conflict(breaker, lease);
1424 static bool
1425 any_leases_conflict(struct inode *inode, struct file_lock *breaker)
1427 struct file_lock_context *ctx = inode->i_flctx;
1428 struct file_lock *fl;
1430 lockdep_assert_held(&ctx->flc_lock);
1432 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1433 if (leases_conflict(fl, breaker))
1434 return true;
1436 return false;
1440 * __break_lease - revoke all outstanding leases on file
1441 * @inode: the inode of the file to return
1442 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1443 * break all leases
1444 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1445 * only delegations
1447 * break_lease (inlined for speed) has checked there already is at least
1448 * some kind of lock (maybe a lease) on this file. Leases are broken on
1449 * a call to open() or truncate(). This function can sleep unless you
1450 * specified %O_NONBLOCK to your open().
1452 int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1454 int error = 0;
1455 struct file_lock_context *ctx;
1456 struct file_lock *new_fl, *fl, *tmp;
1457 unsigned long break_time;
1458 int want_write = (mode & O_ACCMODE) != O_RDONLY;
1459 LIST_HEAD(dispose);
1461 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
1462 if (IS_ERR(new_fl))
1463 return PTR_ERR(new_fl);
1464 new_fl->fl_flags = type;
1466 /* typically we will check that ctx is non-NULL before calling */
1467 ctx = smp_load_acquire(&inode->i_flctx);
1468 if (!ctx) {
1469 WARN_ON_ONCE(1);
1470 return error;
1473 percpu_down_read_preempt_disable(&file_rwsem);
1474 spin_lock(&ctx->flc_lock);
1476 time_out_leases(inode, &dispose);
1478 if (!any_leases_conflict(inode, new_fl))
1479 goto out;
1481 break_time = 0;
1482 if (lease_break_time > 0) {
1483 break_time = jiffies + lease_break_time * HZ;
1484 if (break_time == 0)
1485 break_time++; /* so that 0 means no break time */
1488 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
1489 if (!leases_conflict(fl, new_fl))
1490 continue;
1491 if (want_write) {
1492 if (fl->fl_flags & FL_UNLOCK_PENDING)
1493 continue;
1494 fl->fl_flags |= FL_UNLOCK_PENDING;
1495 fl->fl_break_time = break_time;
1496 } else {
1497 if (lease_breaking(fl))
1498 continue;
1499 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1500 fl->fl_downgrade_time = break_time;
1502 if (fl->fl_lmops->lm_break(fl))
1503 locks_delete_lock_ctx(fl, &dispose);
1506 if (list_empty(&ctx->flc_lease))
1507 goto out;
1509 if (mode & O_NONBLOCK) {
1510 trace_break_lease_noblock(inode, new_fl);
1511 error = -EWOULDBLOCK;
1512 goto out;
1515 restart:
1516 fl = list_first_entry(&ctx->flc_lease, struct file_lock, fl_list);
1517 break_time = fl->fl_break_time;
1518 if (break_time != 0)
1519 break_time -= jiffies;
1520 if (break_time == 0)
1521 break_time++;
1522 locks_insert_block(fl, new_fl);
1523 trace_break_lease_block(inode, new_fl);
1524 spin_unlock(&ctx->flc_lock);
1525 percpu_up_read_preempt_enable(&file_rwsem);
1527 locks_dispose_list(&dispose);
1528 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1529 !new_fl->fl_next, break_time);
1531 percpu_down_read_preempt_disable(&file_rwsem);
1532 spin_lock(&ctx->flc_lock);
1533 trace_break_lease_unblock(inode, new_fl);
1534 locks_delete_block(new_fl);
1535 if (error >= 0) {
1537 * Wait for the next conflicting lease that has not been
1538 * broken yet
1540 if (error == 0)
1541 time_out_leases(inode, &dispose);
1542 if (any_leases_conflict(inode, new_fl))
1543 goto restart;
1544 error = 0;
1546 out:
1547 spin_unlock(&ctx->flc_lock);
1548 percpu_up_read_preempt_enable(&file_rwsem);
1549 locks_dispose_list(&dispose);
1550 locks_free_lock(new_fl);
1551 return error;
1554 EXPORT_SYMBOL(__break_lease);
1557 * lease_get_mtime - get the last modified time of an inode
1558 * @inode: the inode
1559 * @time: pointer to a timespec which will contain the last modified time
1561 * This is to force NFS clients to flush their caches for files with
1562 * exclusive leases. The justification is that if someone has an
1563 * exclusive lease, then they could be modifying it.
1565 void lease_get_mtime(struct inode *inode, struct timespec *time)
1567 bool has_lease = false;
1568 struct file_lock_context *ctx;
1569 struct file_lock *fl;
1571 ctx = smp_load_acquire(&inode->i_flctx);
1572 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
1573 spin_lock(&ctx->flc_lock);
1574 fl = list_first_entry_or_null(&ctx->flc_lease,
1575 struct file_lock, fl_list);
1576 if (fl && (fl->fl_type == F_WRLCK))
1577 has_lease = true;
1578 spin_unlock(&ctx->flc_lock);
1581 if (has_lease)
1582 *time = current_time(inode);
1583 else
1584 *time = inode->i_mtime;
1587 EXPORT_SYMBOL(lease_get_mtime);
1590 * fcntl_getlease - Enquire what lease is currently active
1591 * @filp: the file
1593 * The value returned by this function will be one of
1594 * (if no lease break is pending):
1596 * %F_RDLCK to indicate a shared lease is held.
1598 * %F_WRLCK to indicate an exclusive lease is held.
1600 * %F_UNLCK to indicate no lease is held.
1602 * (if a lease break is pending):
1604 * %F_RDLCK to indicate an exclusive lease needs to be
1605 * changed to a shared lease (or removed).
1607 * %F_UNLCK to indicate the lease needs to be removed.
1609 * XXX: sfr & willy disagree over whether F_INPROGRESS
1610 * should be returned to userspace.
1612 int fcntl_getlease(struct file *filp)
1614 struct file_lock *fl;
1615 struct inode *inode = locks_inode(filp);
1616 struct file_lock_context *ctx;
1617 int type = F_UNLCK;
1618 LIST_HEAD(dispose);
1620 ctx = smp_load_acquire(&inode->i_flctx);
1621 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
1622 percpu_down_read_preempt_disable(&file_rwsem);
1623 spin_lock(&ctx->flc_lock);
1624 time_out_leases(inode, &dispose);
1625 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1626 if (fl->fl_file != filp)
1627 continue;
1628 type = target_leasetype(fl);
1629 break;
1631 spin_unlock(&ctx->flc_lock);
1632 percpu_up_read_preempt_enable(&file_rwsem);
1634 locks_dispose_list(&dispose);
1636 return type;
1640 * check_conflicting_open - see if the given dentry points to a file that has
1641 * an existing open that would conflict with the
1642 * desired lease.
1643 * @dentry: dentry to check
1644 * @arg: type of lease that we're trying to acquire
1645 * @flags: current lock flags
1647 * Check to see if there's an existing open fd on this file that would
1648 * conflict with the lease we're trying to set.
1650 static int
1651 check_conflicting_open(const struct dentry *dentry, const long arg, int flags)
1653 int ret = 0;
1654 struct inode *inode = dentry->d_inode;
1656 if (flags & FL_LAYOUT)
1657 return 0;
1659 if ((arg == F_RDLCK) &&
1660 (atomic_read(&d_real_inode(dentry)->i_writecount) > 0))
1661 return -EAGAIN;
1663 if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1664 (atomic_read(&inode->i_count) > 1)))
1665 ret = -EAGAIN;
1667 return ret;
1670 static int
1671 generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
1673 struct file_lock *fl, *my_fl = NULL, *lease;
1674 struct dentry *dentry = filp->f_path.dentry;
1675 struct inode *inode = dentry->d_inode;
1676 struct file_lock_context *ctx;
1677 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
1678 int error;
1679 LIST_HEAD(dispose);
1681 lease = *flp;
1682 trace_generic_add_lease(inode, lease);
1684 /* Note that arg is never F_UNLCK here */
1685 ctx = locks_get_lock_context(inode, arg);
1686 if (!ctx)
1687 return -ENOMEM;
1690 * In the delegation case we need mutual exclusion with
1691 * a number of operations that take the i_mutex. We trylock
1692 * because delegations are an optional optimization, and if
1693 * there's some chance of a conflict--we'd rather not
1694 * bother, maybe that's a sign this just isn't a good file to
1695 * hand out a delegation on.
1697 if (is_deleg && !inode_trylock(inode))
1698 return -EAGAIN;
1700 if (is_deleg && arg == F_WRLCK) {
1701 /* Write delegations are not currently supported: */
1702 inode_unlock(inode);
1703 WARN_ON_ONCE(1);
1704 return -EINVAL;
1707 percpu_down_read_preempt_disable(&file_rwsem);
1708 spin_lock(&ctx->flc_lock);
1709 time_out_leases(inode, &dispose);
1710 error = check_conflicting_open(dentry, arg, lease->fl_flags);
1711 if (error)
1712 goto out;
1715 * At this point, we know that if there is an exclusive
1716 * lease on this file, then we hold it on this filp
1717 * (otherwise our open of this file would have blocked).
1718 * And if we are trying to acquire an exclusive lease,
1719 * then the file is not open by anyone (including us)
1720 * except for this filp.
1722 error = -EAGAIN;
1723 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1724 if (fl->fl_file == filp &&
1725 fl->fl_owner == lease->fl_owner) {
1726 my_fl = fl;
1727 continue;
1731 * No exclusive leases if someone else has a lease on
1732 * this file:
1734 if (arg == F_WRLCK)
1735 goto out;
1737 * Modifying our existing lease is OK, but no getting a
1738 * new lease if someone else is opening for write:
1740 if (fl->fl_flags & FL_UNLOCK_PENDING)
1741 goto out;
1744 if (my_fl != NULL) {
1745 lease = my_fl;
1746 error = lease->fl_lmops->lm_change(lease, arg, &dispose);
1747 if (error)
1748 goto out;
1749 goto out_setup;
1752 error = -EINVAL;
1753 if (!leases_enable)
1754 goto out;
1756 locks_insert_lock_ctx(lease, &ctx->flc_lease);
1758 * The check in break_lease() is lockless. It's possible for another
1759 * open to race in after we did the earlier check for a conflicting
1760 * open but before the lease was inserted. Check again for a
1761 * conflicting open and cancel the lease if there is one.
1763 * We also add a barrier here to ensure that the insertion of the lock
1764 * precedes these checks.
1766 smp_mb();
1767 error = check_conflicting_open(dentry, arg, lease->fl_flags);
1768 if (error) {
1769 locks_unlink_lock_ctx(lease);
1770 goto out;
1773 out_setup:
1774 if (lease->fl_lmops->lm_setup)
1775 lease->fl_lmops->lm_setup(lease, priv);
1776 out:
1777 spin_unlock(&ctx->flc_lock);
1778 percpu_up_read_preempt_enable(&file_rwsem);
1779 locks_dispose_list(&dispose);
1780 if (is_deleg)
1781 inode_unlock(inode);
1782 if (!error && !my_fl)
1783 *flp = NULL;
1784 return error;
1787 static int generic_delete_lease(struct file *filp, void *owner)
1789 int error = -EAGAIN;
1790 struct file_lock *fl, *victim = NULL;
1791 struct inode *inode = locks_inode(filp);
1792 struct file_lock_context *ctx;
1793 LIST_HEAD(dispose);
1795 ctx = smp_load_acquire(&inode->i_flctx);
1796 if (!ctx) {
1797 trace_generic_delete_lease(inode, NULL);
1798 return error;
1801 percpu_down_read_preempt_disable(&file_rwsem);
1802 spin_lock(&ctx->flc_lock);
1803 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1804 if (fl->fl_file == filp &&
1805 fl->fl_owner == owner) {
1806 victim = fl;
1807 break;
1810 trace_generic_delete_lease(inode, victim);
1811 if (victim)
1812 error = fl->fl_lmops->lm_change(victim, F_UNLCK, &dispose);
1813 spin_unlock(&ctx->flc_lock);
1814 percpu_up_read_preempt_enable(&file_rwsem);
1815 locks_dispose_list(&dispose);
1816 return error;
1820 * generic_setlease - sets a lease on an open file
1821 * @filp: file pointer
1822 * @arg: type of lease to obtain
1823 * @flp: input - file_lock to use, output - file_lock inserted
1824 * @priv: private data for lm_setup (may be NULL if lm_setup
1825 * doesn't require it)
1827 * The (input) flp->fl_lmops->lm_break function is required
1828 * by break_lease().
1830 int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
1831 void **priv)
1833 struct inode *inode = locks_inode(filp);
1834 int error;
1836 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
1837 return -EACCES;
1838 if (!S_ISREG(inode->i_mode))
1839 return -EINVAL;
1840 error = security_file_lock(filp, arg);
1841 if (error)
1842 return error;
1844 switch (arg) {
1845 case F_UNLCK:
1846 return generic_delete_lease(filp, *priv);
1847 case F_RDLCK:
1848 case F_WRLCK:
1849 if (!(*flp)->fl_lmops->lm_break) {
1850 WARN_ON_ONCE(1);
1851 return -ENOLCK;
1854 return generic_add_lease(filp, arg, flp, priv);
1855 default:
1856 return -EINVAL;
1859 EXPORT_SYMBOL(generic_setlease);
1862 * vfs_setlease - sets a lease on an open file
1863 * @filp: file pointer
1864 * @arg: type of lease to obtain
1865 * @lease: file_lock to use when adding a lease
1866 * @priv: private info for lm_setup when adding a lease (may be
1867 * NULL if lm_setup doesn't require it)
1869 * Call this to establish a lease on the file. The "lease" argument is not
1870 * used for F_UNLCK requests and may be NULL. For commands that set or alter
1871 * an existing lease, the ``(*lease)->fl_lmops->lm_break`` operation must be
1872 * set; if not, this function will return -ENOLCK (and generate a scary-looking
1873 * stack trace).
1875 * The "priv" pointer is passed directly to the lm_setup function as-is. It
1876 * may be NULL if the lm_setup operation doesn't require it.
1879 vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
1881 if (filp->f_op->setlease && is_remote_lock(filp))
1882 return filp->f_op->setlease(filp, arg, lease, priv);
1883 else
1884 return generic_setlease(filp, arg, lease, priv);
1886 EXPORT_SYMBOL_GPL(vfs_setlease);
1888 static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
1890 struct file_lock *fl;
1891 struct fasync_struct *new;
1892 int error;
1894 fl = lease_alloc(filp, arg);
1895 if (IS_ERR(fl))
1896 return PTR_ERR(fl);
1898 new = fasync_alloc();
1899 if (!new) {
1900 locks_free_lock(fl);
1901 return -ENOMEM;
1903 new->fa_fd = fd;
1905 error = vfs_setlease(filp, arg, &fl, (void **)&new);
1906 if (fl)
1907 locks_free_lock(fl);
1908 if (new)
1909 fasync_free(new);
1910 return error;
1914 * fcntl_setlease - sets a lease on an open file
1915 * @fd: open file descriptor
1916 * @filp: file pointer
1917 * @arg: type of lease to obtain
1919 * Call this fcntl to establish a lease on the file.
1920 * Note that you also need to call %F_SETSIG to
1921 * receive a signal when the lease is broken.
1923 int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1925 if (arg == F_UNLCK)
1926 return vfs_setlease(filp, F_UNLCK, NULL, (void **)&filp);
1927 return do_fcntl_add_lease(fd, filp, arg);
1931 * flock_lock_inode_wait - Apply a FLOCK-style lock to a file
1932 * @inode: inode of the file to apply to
1933 * @fl: The lock to be applied
1935 * Apply a FLOCK style lock request to an inode.
1937 static int flock_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1939 int error;
1940 might_sleep();
1941 for (;;) {
1942 error = flock_lock_inode(inode, fl);
1943 if (error != FILE_LOCK_DEFERRED)
1944 break;
1945 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1946 if (!error)
1947 continue;
1949 locks_delete_block(fl);
1950 break;
1952 return error;
1956 * locks_lock_inode_wait - Apply a lock to an inode
1957 * @inode: inode of the file to apply to
1958 * @fl: The lock to be applied
1960 * Apply a POSIX or FLOCK style lock request to an inode.
1962 int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1964 int res = 0;
1965 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
1966 case FL_POSIX:
1967 res = posix_lock_inode_wait(inode, fl);
1968 break;
1969 case FL_FLOCK:
1970 res = flock_lock_inode_wait(inode, fl);
1971 break;
1972 default:
1973 BUG();
1975 return res;
1977 EXPORT_SYMBOL(locks_lock_inode_wait);
1980 * sys_flock: - flock() system call.
1981 * @fd: the file descriptor to lock.
1982 * @cmd: the type of lock to apply.
1984 * Apply a %FL_FLOCK style lock to an open file descriptor.
1985 * The @cmd can be one of:
1987 * - %LOCK_SH -- a shared lock.
1988 * - %LOCK_EX -- an exclusive lock.
1989 * - %LOCK_UN -- remove an existing lock.
1990 * - %LOCK_MAND -- a 'mandatory' flock.
1991 * This exists to emulate Windows Share Modes.
1993 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1994 * processes read and write access respectively.
1996 SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
1998 struct fd f = fdget(fd);
1999 struct file_lock *lock;
2000 int can_sleep, unlock;
2001 int error;
2003 error = -EBADF;
2004 if (!f.file)
2005 goto out;
2007 can_sleep = !(cmd & LOCK_NB);
2008 cmd &= ~LOCK_NB;
2009 unlock = (cmd == LOCK_UN);
2011 if (!unlock && !(cmd & LOCK_MAND) &&
2012 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
2013 goto out_putf;
2015 lock = flock_make_lock(f.file, cmd);
2016 if (IS_ERR(lock)) {
2017 error = PTR_ERR(lock);
2018 goto out_putf;
2021 if (can_sleep)
2022 lock->fl_flags |= FL_SLEEP;
2024 error = security_file_lock(f.file, lock->fl_type);
2025 if (error)
2026 goto out_free;
2028 if (f.file->f_op->flock && is_remote_lock(f.file))
2029 error = f.file->f_op->flock(f.file,
2030 (can_sleep) ? F_SETLKW : F_SETLK,
2031 lock);
2032 else
2033 error = locks_lock_file_wait(f.file, lock);
2035 out_free:
2036 locks_free_lock(lock);
2038 out_putf:
2039 fdput(f);
2040 out:
2041 return error;
2045 * vfs_test_lock - test file byte range lock
2046 * @filp: The file to test lock for
2047 * @fl: The lock to test; also used to hold result
2049 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
2050 * setting conf->fl_type to something other than F_UNLCK.
2052 int vfs_test_lock(struct file *filp, struct file_lock *fl)
2054 if (filp->f_op->lock && is_remote_lock(filp))
2055 return filp->f_op->lock(filp, F_GETLK, fl);
2056 posix_test_lock(filp, fl);
2057 return 0;
2059 EXPORT_SYMBOL_GPL(vfs_test_lock);
2062 * locks_translate_pid - translate a file_lock's fl_pid number into a namespace
2063 * @fl: The file_lock who's fl_pid should be translated
2064 * @ns: The namespace into which the pid should be translated
2066 * Used to tranlate a fl_pid into a namespace virtual pid number
2068 static pid_t locks_translate_pid(struct file_lock *fl, struct pid_namespace *ns)
2070 pid_t vnr;
2071 struct pid *pid;
2073 if (IS_OFDLCK(fl))
2074 return -1;
2075 if (IS_REMOTELCK(fl))
2076 return fl->fl_pid;
2078 rcu_read_lock();
2079 pid = find_pid_ns(fl->fl_pid, &init_pid_ns);
2080 vnr = pid_nr_ns(pid, ns);
2081 rcu_read_unlock();
2082 return vnr;
2085 static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
2087 flock->l_pid = locks_translate_pid(fl, task_active_pid_ns(current));
2088 #if BITS_PER_LONG == 32
2090 * Make sure we can represent the posix lock via
2091 * legacy 32bit flock.
2093 if (fl->fl_start > OFFT_OFFSET_MAX)
2094 return -EOVERFLOW;
2095 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
2096 return -EOVERFLOW;
2097 #endif
2098 flock->l_start = fl->fl_start;
2099 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2100 fl->fl_end - fl->fl_start + 1;
2101 flock->l_whence = 0;
2102 flock->l_type = fl->fl_type;
2103 return 0;
2106 #if BITS_PER_LONG == 32
2107 static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
2109 flock->l_pid = locks_translate_pid(fl, task_active_pid_ns(current));
2110 flock->l_start = fl->fl_start;
2111 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2112 fl->fl_end - fl->fl_start + 1;
2113 flock->l_whence = 0;
2114 flock->l_type = fl->fl_type;
2116 #endif
2118 /* Report the first existing lock that would conflict with l.
2119 * This implements the F_GETLK command of fcntl().
2121 int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock *flock)
2123 struct file_lock *fl;
2124 int error;
2126 fl = locks_alloc_lock();
2127 if (fl == NULL)
2128 return -ENOMEM;
2129 error = -EINVAL;
2130 if (flock->l_type != F_RDLCK && flock->l_type != F_WRLCK)
2131 goto out;
2133 error = flock_to_posix_lock(filp, fl, flock);
2134 if (error)
2135 goto out;
2137 if (cmd == F_OFD_GETLK) {
2138 error = -EINVAL;
2139 if (flock->l_pid != 0)
2140 goto out;
2142 cmd = F_GETLK;
2143 fl->fl_flags |= FL_OFDLCK;
2144 fl->fl_owner = filp;
2147 error = vfs_test_lock(filp, fl);
2148 if (error)
2149 goto out;
2151 flock->l_type = fl->fl_type;
2152 if (fl->fl_type != F_UNLCK) {
2153 error = posix_lock_to_flock(flock, fl);
2154 if (error)
2155 goto out;
2157 out:
2158 locks_free_lock(fl);
2159 return error;
2163 * vfs_lock_file - file byte range lock
2164 * @filp: The file to apply the lock to
2165 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2166 * @fl: The lock to be applied
2167 * @conf: Place to return a copy of the conflicting lock, if found.
2169 * A caller that doesn't care about the conflicting lock may pass NULL
2170 * as the final argument.
2172 * If the filesystem defines a private ->lock() method, then @conf will
2173 * be left unchanged; so a caller that cares should initialize it to
2174 * some acceptable default.
2176 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2177 * locks, the ->lock() interface may return asynchronously, before the lock has
2178 * been granted or denied by the underlying filesystem, if (and only if)
2179 * lm_grant is set. Callers expecting ->lock() to return asynchronously
2180 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2181 * the request is for a blocking lock. When ->lock() does return asynchronously,
2182 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
2183 * request completes.
2184 * If the request is for non-blocking lock the file system should return
2185 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2186 * with the result. If the request timed out the callback routine will return a
2187 * nonzero return code and the file system should release the lock. The file
2188 * system is also responsible to keep a corresponding posix lock when it
2189 * grants a lock so the VFS can find out which locks are locally held and do
2190 * the correct lock cleanup when required.
2191 * The underlying filesystem must not drop the kernel lock or call
2192 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
2193 * return code.
2195 int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
2197 if (filp->f_op->lock && is_remote_lock(filp))
2198 return filp->f_op->lock(filp, cmd, fl);
2199 else
2200 return posix_lock_file(filp, fl, conf);
2202 EXPORT_SYMBOL_GPL(vfs_lock_file);
2204 static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2205 struct file_lock *fl)
2207 int error;
2209 error = security_file_lock(filp, fl->fl_type);
2210 if (error)
2211 return error;
2213 for (;;) {
2214 error = vfs_lock_file(filp, cmd, fl, NULL);
2215 if (error != FILE_LOCK_DEFERRED)
2216 break;
2217 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
2218 if (!error)
2219 continue;
2221 locks_delete_block(fl);
2222 break;
2225 return error;
2228 /* Ensure that fl->fl_file has compatible f_mode for F_SETLK calls */
2229 static int
2230 check_fmode_for_setlk(struct file_lock *fl)
2232 switch (fl->fl_type) {
2233 case F_RDLCK:
2234 if (!(fl->fl_file->f_mode & FMODE_READ))
2235 return -EBADF;
2236 break;
2237 case F_WRLCK:
2238 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2239 return -EBADF;
2241 return 0;
2244 /* Apply the lock described by l to an open file descriptor.
2245 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2247 int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
2248 struct flock *flock)
2250 struct file_lock *file_lock = locks_alloc_lock();
2251 struct inode *inode = locks_inode(filp);
2252 struct file *f;
2253 int error;
2255 if (file_lock == NULL)
2256 return -ENOLCK;
2258 /* Don't allow mandatory locks on files that may be memory mapped
2259 * and shared.
2261 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
2262 error = -EAGAIN;
2263 goto out;
2266 error = flock_to_posix_lock(filp, file_lock, flock);
2267 if (error)
2268 goto out;
2270 error = check_fmode_for_setlk(file_lock);
2271 if (error)
2272 goto out;
2275 * If the cmd is requesting file-private locks, then set the
2276 * FL_OFDLCK flag and override the owner.
2278 switch (cmd) {
2279 case F_OFD_SETLK:
2280 error = -EINVAL;
2281 if (flock->l_pid != 0)
2282 goto out;
2284 cmd = F_SETLK;
2285 file_lock->fl_flags |= FL_OFDLCK;
2286 file_lock->fl_owner = filp;
2287 break;
2288 case F_OFD_SETLKW:
2289 error = -EINVAL;
2290 if (flock->l_pid != 0)
2291 goto out;
2293 cmd = F_SETLKW;
2294 file_lock->fl_flags |= FL_OFDLCK;
2295 file_lock->fl_owner = filp;
2296 /* Fallthrough */
2297 case F_SETLKW:
2298 file_lock->fl_flags |= FL_SLEEP;
2301 error = do_lock_file_wait(filp, cmd, file_lock);
2304 * Attempt to detect a close/fcntl race and recover by releasing the
2305 * lock that was just acquired. There is no need to do that when we're
2306 * unlocking though, or for OFD locks.
2308 if (!error && file_lock->fl_type != F_UNLCK &&
2309 !(file_lock->fl_flags & FL_OFDLCK)) {
2311 * We need that spin_lock here - it prevents reordering between
2312 * update of i_flctx->flc_posix and check for it done in
2313 * close(). rcu_read_lock() wouldn't do.
2315 spin_lock(&current->files->file_lock);
2316 f = fcheck(fd);
2317 spin_unlock(&current->files->file_lock);
2318 if (f != filp) {
2319 file_lock->fl_type = F_UNLCK;
2320 error = do_lock_file_wait(filp, cmd, file_lock);
2321 WARN_ON_ONCE(error);
2322 error = -EBADF;
2325 out:
2326 trace_fcntl_setlk(inode, file_lock, error);
2327 locks_free_lock(file_lock);
2328 return error;
2331 #if BITS_PER_LONG == 32
2332 /* Report the first existing lock that would conflict with l.
2333 * This implements the F_GETLK command of fcntl().
2335 int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 *flock)
2337 struct file_lock *fl;
2338 int error;
2340 fl = locks_alloc_lock();
2341 if (fl == NULL)
2342 return -ENOMEM;
2344 error = -EINVAL;
2345 if (flock->l_type != F_RDLCK && flock->l_type != F_WRLCK)
2346 goto out;
2348 error = flock64_to_posix_lock(filp, fl, flock);
2349 if (error)
2350 goto out;
2352 if (cmd == F_OFD_GETLK) {
2353 error = -EINVAL;
2354 if (flock->l_pid != 0)
2355 goto out;
2357 cmd = F_GETLK64;
2358 fl->fl_flags |= FL_OFDLCK;
2359 fl->fl_owner = filp;
2362 error = vfs_test_lock(filp, fl);
2363 if (error)
2364 goto out;
2366 flock->l_type = fl->fl_type;
2367 if (fl->fl_type != F_UNLCK)
2368 posix_lock_to_flock64(flock, fl);
2370 out:
2371 locks_free_lock(fl);
2372 return error;
2375 /* Apply the lock described by l to an open file descriptor.
2376 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2378 int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2379 struct flock64 *flock)
2381 struct file_lock *file_lock = locks_alloc_lock();
2382 struct inode *inode = locks_inode(filp);
2383 struct file *f;
2384 int error;
2386 if (file_lock == NULL)
2387 return -ENOLCK;
2389 /* Don't allow mandatory locks on files that may be memory mapped
2390 * and shared.
2392 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
2393 error = -EAGAIN;
2394 goto out;
2397 error = flock64_to_posix_lock(filp, file_lock, flock);
2398 if (error)
2399 goto out;
2401 error = check_fmode_for_setlk(file_lock);
2402 if (error)
2403 goto out;
2406 * If the cmd is requesting file-private locks, then set the
2407 * FL_OFDLCK flag and override the owner.
2409 switch (cmd) {
2410 case F_OFD_SETLK:
2411 error = -EINVAL;
2412 if (flock->l_pid != 0)
2413 goto out;
2415 cmd = F_SETLK64;
2416 file_lock->fl_flags |= FL_OFDLCK;
2417 file_lock->fl_owner = filp;
2418 break;
2419 case F_OFD_SETLKW:
2420 error = -EINVAL;
2421 if (flock->l_pid != 0)
2422 goto out;
2424 cmd = F_SETLKW64;
2425 file_lock->fl_flags |= FL_OFDLCK;
2426 file_lock->fl_owner = filp;
2427 /* Fallthrough */
2428 case F_SETLKW64:
2429 file_lock->fl_flags |= FL_SLEEP;
2432 error = do_lock_file_wait(filp, cmd, file_lock);
2435 * Attempt to detect a close/fcntl race and recover by releasing the
2436 * lock that was just acquired. There is no need to do that when we're
2437 * unlocking though, or for OFD locks.
2439 if (!error && file_lock->fl_type != F_UNLCK &&
2440 !(file_lock->fl_flags & FL_OFDLCK)) {
2442 * We need that spin_lock here - it prevents reordering between
2443 * update of i_flctx->flc_posix and check for it done in
2444 * close(). rcu_read_lock() wouldn't do.
2446 spin_lock(&current->files->file_lock);
2447 f = fcheck(fd);
2448 spin_unlock(&current->files->file_lock);
2449 if (f != filp) {
2450 file_lock->fl_type = F_UNLCK;
2451 error = do_lock_file_wait(filp, cmd, file_lock);
2452 WARN_ON_ONCE(error);
2453 error = -EBADF;
2456 out:
2457 locks_free_lock(file_lock);
2458 return error;
2460 #endif /* BITS_PER_LONG == 32 */
2463 * This function is called when the file is being removed
2464 * from the task's fd array. POSIX locks belonging to this task
2465 * are deleted at this time.
2467 void locks_remove_posix(struct file *filp, fl_owner_t owner)
2469 int error;
2470 struct inode *inode = locks_inode(filp);
2471 struct file_lock lock;
2472 struct file_lock_context *ctx;
2475 * If there are no locks held on this file, we don't need to call
2476 * posix_lock_file(). Another process could be setting a lock on this
2477 * file at the same time, but we wouldn't remove that lock anyway.
2479 ctx = smp_load_acquire(&inode->i_flctx);
2480 if (!ctx || list_empty(&ctx->flc_posix))
2481 return;
2483 lock.fl_type = F_UNLCK;
2484 lock.fl_flags = FL_POSIX | FL_CLOSE;
2485 lock.fl_start = 0;
2486 lock.fl_end = OFFSET_MAX;
2487 lock.fl_owner = owner;
2488 lock.fl_pid = current->tgid;
2489 lock.fl_file = filp;
2490 lock.fl_ops = NULL;
2491 lock.fl_lmops = NULL;
2493 error = vfs_lock_file(filp, F_SETLK, &lock, NULL);
2495 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2496 lock.fl_ops->fl_release_private(&lock);
2497 trace_locks_remove_posix(inode, &lock, error);
2500 EXPORT_SYMBOL(locks_remove_posix);
2502 /* The i_flctx must be valid when calling into here */
2503 static void
2504 locks_remove_flock(struct file *filp, struct file_lock_context *flctx)
2506 struct file_lock fl = {
2507 .fl_owner = filp,
2508 .fl_pid = current->tgid,
2509 .fl_file = filp,
2510 .fl_flags = FL_FLOCK | FL_CLOSE,
2511 .fl_type = F_UNLCK,
2512 .fl_end = OFFSET_MAX,
2514 struct inode *inode = locks_inode(filp);
2516 if (list_empty(&flctx->flc_flock))
2517 return;
2519 if (filp->f_op->flock && is_remote_lock(filp))
2520 filp->f_op->flock(filp, F_SETLKW, &fl);
2521 else
2522 flock_lock_inode(inode, &fl);
2524 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2525 fl.fl_ops->fl_release_private(&fl);
2528 /* The i_flctx must be valid when calling into here */
2529 static void
2530 locks_remove_lease(struct file *filp, struct file_lock_context *ctx)
2532 struct file_lock *fl, *tmp;
2533 LIST_HEAD(dispose);
2535 if (list_empty(&ctx->flc_lease))
2536 return;
2538 percpu_down_read_preempt_disable(&file_rwsem);
2539 spin_lock(&ctx->flc_lock);
2540 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list)
2541 if (filp == fl->fl_file)
2542 lease_modify(fl, F_UNLCK, &dispose);
2543 spin_unlock(&ctx->flc_lock);
2544 percpu_up_read_preempt_enable(&file_rwsem);
2546 locks_dispose_list(&dispose);
2550 * This function is called on the last close of an open file.
2552 void locks_remove_file(struct file *filp)
2554 struct file_lock_context *ctx;
2556 ctx = smp_load_acquire(&locks_inode(filp)->i_flctx);
2557 if (!ctx)
2558 return;
2560 /* remove any OFD locks */
2561 locks_remove_posix(filp, filp);
2563 /* remove flock locks */
2564 locks_remove_flock(filp, ctx);
2566 /* remove any leases */
2567 locks_remove_lease(filp, ctx);
2569 spin_lock(&ctx->flc_lock);
2570 locks_check_ctx_file_list(filp, &ctx->flc_posix, "POSIX");
2571 locks_check_ctx_file_list(filp, &ctx->flc_flock, "FLOCK");
2572 locks_check_ctx_file_list(filp, &ctx->flc_lease, "LEASE");
2573 spin_unlock(&ctx->flc_lock);
2577 * posix_unblock_lock - stop waiting for a file lock
2578 * @waiter: the lock which was waiting
2580 * lockd needs to block waiting for locks.
2583 posix_unblock_lock(struct file_lock *waiter)
2585 int status = 0;
2587 spin_lock(&blocked_lock_lock);
2588 if (waiter->fl_next)
2589 __locks_delete_block(waiter);
2590 else
2591 status = -ENOENT;
2592 spin_unlock(&blocked_lock_lock);
2593 return status;
2595 EXPORT_SYMBOL(posix_unblock_lock);
2598 * vfs_cancel_lock - file byte range unblock lock
2599 * @filp: The file to apply the unblock to
2600 * @fl: The lock to be unblocked
2602 * Used by lock managers to cancel blocked requests
2604 int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2606 if (filp->f_op->lock && is_remote_lock(filp))
2607 return filp->f_op->lock(filp, F_CANCELLK, fl);
2608 return 0;
2611 EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2613 #ifdef CONFIG_PROC_FS
2614 #include <linux/proc_fs.h>
2615 #include <linux/seq_file.h>
2617 struct locks_iterator {
2618 int li_cpu;
2619 loff_t li_pos;
2622 static void lock_get_status(struct seq_file *f, struct file_lock *fl,
2623 loff_t id, char *pfx)
2625 struct inode *inode = NULL;
2626 unsigned int fl_pid;
2627 struct pid_namespace *proc_pidns = file_inode(f->file)->i_sb->s_fs_info;
2629 fl_pid = locks_translate_pid(fl, proc_pidns);
2631 * If there isn't a fl_pid don't display who is waiting on
2632 * the lock if we are called from locks_show, or if we are
2633 * called from __show_fd_info - skip lock entirely
2635 if (fl_pid == 0)
2636 return;
2638 if (fl->fl_file != NULL)
2639 inode = locks_inode(fl->fl_file);
2641 seq_printf(f, "%lld:%s ", id, pfx);
2642 if (IS_POSIX(fl)) {
2643 if (fl->fl_flags & FL_ACCESS)
2644 seq_puts(f, "ACCESS");
2645 else if (IS_OFDLCK(fl))
2646 seq_puts(f, "OFDLCK");
2647 else
2648 seq_puts(f, "POSIX ");
2650 seq_printf(f, " %s ",
2651 (inode == NULL) ? "*NOINODE*" :
2652 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
2653 } else if (IS_FLOCK(fl)) {
2654 if (fl->fl_type & LOCK_MAND) {
2655 seq_puts(f, "FLOCK MSNFS ");
2656 } else {
2657 seq_puts(f, "FLOCK ADVISORY ");
2659 } else if (IS_LEASE(fl)) {
2660 if (fl->fl_flags & FL_DELEG)
2661 seq_puts(f, "DELEG ");
2662 else
2663 seq_puts(f, "LEASE ");
2665 if (lease_breaking(fl))
2666 seq_puts(f, "BREAKING ");
2667 else if (fl->fl_file)
2668 seq_puts(f, "ACTIVE ");
2669 else
2670 seq_puts(f, "BREAKER ");
2671 } else {
2672 seq_puts(f, "UNKNOWN UNKNOWN ");
2674 if (fl->fl_type & LOCK_MAND) {
2675 seq_printf(f, "%s ",
2676 (fl->fl_type & LOCK_READ)
2677 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2678 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2679 } else {
2680 seq_printf(f, "%s ",
2681 (lease_breaking(fl))
2682 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2683 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
2685 if (inode) {
2686 /* userspace relies on this representation of dev_t */
2687 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
2688 MAJOR(inode->i_sb->s_dev),
2689 MINOR(inode->i_sb->s_dev), inode->i_ino);
2690 } else {
2691 seq_printf(f, "%d <none>:0 ", fl_pid);
2693 if (IS_POSIX(fl)) {
2694 if (fl->fl_end == OFFSET_MAX)
2695 seq_printf(f, "%Ld EOF\n", fl->fl_start);
2696 else
2697 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
2698 } else {
2699 seq_puts(f, "0 EOF\n");
2703 static int locks_show(struct seq_file *f, void *v)
2705 struct locks_iterator *iter = f->private;
2706 struct file_lock *fl, *bfl;
2707 struct pid_namespace *proc_pidns = file_inode(f->file)->i_sb->s_fs_info;
2709 fl = hlist_entry(v, struct file_lock, fl_link);
2711 if (locks_translate_pid(fl, proc_pidns) == 0)
2712 return 0;
2714 lock_get_status(f, fl, iter->li_pos, "");
2716 list_for_each_entry(bfl, &fl->fl_block, fl_block)
2717 lock_get_status(f, bfl, iter->li_pos, " ->");
2719 return 0;
2722 static void __show_fd_locks(struct seq_file *f,
2723 struct list_head *head, int *id,
2724 struct file *filp, struct files_struct *files)
2726 struct file_lock *fl;
2728 list_for_each_entry(fl, head, fl_list) {
2730 if (filp != fl->fl_file)
2731 continue;
2732 if (fl->fl_owner != files &&
2733 fl->fl_owner != filp)
2734 continue;
2736 (*id)++;
2737 seq_puts(f, "lock:\t");
2738 lock_get_status(f, fl, *id, "");
2742 void show_fd_locks(struct seq_file *f,
2743 struct file *filp, struct files_struct *files)
2745 struct inode *inode = locks_inode(filp);
2746 struct file_lock_context *ctx;
2747 int id = 0;
2749 ctx = smp_load_acquire(&inode->i_flctx);
2750 if (!ctx)
2751 return;
2753 spin_lock(&ctx->flc_lock);
2754 __show_fd_locks(f, &ctx->flc_flock, &id, filp, files);
2755 __show_fd_locks(f, &ctx->flc_posix, &id, filp, files);
2756 __show_fd_locks(f, &ctx->flc_lease, &id, filp, files);
2757 spin_unlock(&ctx->flc_lock);
2760 static void *locks_start(struct seq_file *f, loff_t *pos)
2761 __acquires(&blocked_lock_lock)
2763 struct locks_iterator *iter = f->private;
2765 iter->li_pos = *pos + 1;
2766 percpu_down_write(&file_rwsem);
2767 spin_lock(&blocked_lock_lock);
2768 return seq_hlist_start_percpu(&file_lock_list.hlist, &iter->li_cpu, *pos);
2771 static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2773 struct locks_iterator *iter = f->private;
2775 ++iter->li_pos;
2776 return seq_hlist_next_percpu(v, &file_lock_list.hlist, &iter->li_cpu, pos);
2779 static void locks_stop(struct seq_file *f, void *v)
2780 __releases(&blocked_lock_lock)
2782 spin_unlock(&blocked_lock_lock);
2783 percpu_up_write(&file_rwsem);
2786 static const struct seq_operations locks_seq_operations = {
2787 .start = locks_start,
2788 .next = locks_next,
2789 .stop = locks_stop,
2790 .show = locks_show,
2793 static int locks_open(struct inode *inode, struct file *filp)
2795 return seq_open_private(filp, &locks_seq_operations,
2796 sizeof(struct locks_iterator));
2799 static const struct file_operations proc_locks_operations = {
2800 .open = locks_open,
2801 .read = seq_read,
2802 .llseek = seq_lseek,
2803 .release = seq_release_private,
2806 static int __init proc_locks_init(void)
2808 proc_create("locks", 0, NULL, &proc_locks_operations);
2809 return 0;
2811 fs_initcall(proc_locks_init);
2812 #endif
2814 static int __init filelock_init(void)
2816 int i;
2818 flctx_cache = kmem_cache_create("file_lock_ctx",
2819 sizeof(struct file_lock_context), 0, SLAB_PANIC, NULL);
2821 filelock_cache = kmem_cache_create("file_lock_cache",
2822 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2825 for_each_possible_cpu(i) {
2826 struct file_lock_list_struct *fll = per_cpu_ptr(&file_lock_list, i);
2828 spin_lock_init(&fll->lock);
2829 INIT_HLIST_HEAD(&fll->hlist);
2832 return 0;
2835 core_initcall(filelock_init);