4e8cf5da28689907b4b5c8b356325e4d7e498309
[cascardo/linux.git] / fs / locks.c
1 /*
2  *  linux/fs/locks.c
3  *
4  *  Provide support for fcntl()'s F_GETLK, F_SETLK, and F_SETLKW calls.
5  *  Doug Evans (dje@spiff.uucp), August 07, 1992
6  *
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.
11  *
12  *  Miscellaneous edits, and a total rewrite of posix_lock_file() code.
13  *  Kai Petzke (wpp@marie.physik.tu-berlin.de), 1994
14  *  
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
18  * 
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
26  *
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
30  *
31  *  Implemented two lock personalities - FL_FLOCK and FL_POSIX.
32  *
33  *  FL_POSIX locks are created with calls to fcntl() and lockf() through the
34  *  fcntl() system call. They have the semantics described above.
35  *
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.
39  *
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). 
45  *
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
51  *
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.
55  *
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.
60  *
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.
65  *
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.
71  *
72  *  Tidied up block list handling. Added '/proc/locks' interface.
73  *  Andy Walker (andy@lysaker.kvaerner.no), April 24, 1996.
74  *
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.
78  *
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.
84  *
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.
88  *
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.
93  *
94  *  Made the block list a circular list to minimise searching in the list.
95  *  Andy Walker (andy@lysaker.kvaerner.no), Sep 25, 1996.
96  *
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.
100  *
101  *  Some adaptations for NFS support.
102  *  Olaf Kirch (okir@monad.swb.de), Dec 1996,
103  *
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.
106  *
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.
111  *
112  *  Leases and LOCK_MAND
113  *  Matthew Wilcox <willy@debian.org>, June, 2000.
114  *  Stephen Rothwell <sfr@canb.auug.org.au>, June, 2000.
115  */
116
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/module.h>
123 #include <linux/security.h>
124 #include <linux/slab.h>
125 #include <linux/syscalls.h>
126 #include <linux/time.h>
127 #include <linux/rcupdate.h>
128 #include <linux/pid_namespace.h>
129 #include <linux/hashtable.h>
130 #include <linux/percpu.h>
131 #include <linux/lglock.h>
132
133 #define CREATE_TRACE_POINTS
134 #include <trace/events/filelock.h>
135
136 #include <asm/uaccess.h>
137
138 #define IS_POSIX(fl)    (fl->fl_flags & FL_POSIX)
139 #define IS_FLOCK(fl)    (fl->fl_flags & FL_FLOCK)
140 #define IS_LEASE(fl)    (fl->fl_flags & (FL_LEASE|FL_DELEG))
141 #define IS_OFDLCK(fl)   (fl->fl_flags & FL_OFDLCK)
142
143 static bool lease_breaking(struct file_lock *fl)
144 {
145         return fl->fl_flags & (FL_UNLOCK_PENDING | FL_DOWNGRADE_PENDING);
146 }
147
148 static int target_leasetype(struct file_lock *fl)
149 {
150         if (fl->fl_flags & FL_UNLOCK_PENDING)
151                 return F_UNLCK;
152         if (fl->fl_flags & FL_DOWNGRADE_PENDING)
153                 return F_RDLCK;
154         return fl->fl_type;
155 }
156
157 int leases_enable = 1;
158 int lease_break_time = 45;
159
160 #define for_each_lock(inode, lockp) \
161         for (lockp = &inode->i_flock; *lockp != NULL; lockp = &(*lockp)->fl_next)
162
163 /*
164  * The global file_lock_list is only used for displaying /proc/locks, so we
165  * keep a list on each CPU, with each list protected by its own spinlock via
166  * the file_lock_lglock. Note that alterations to the list also require that
167  * the relevant i_lock is held.
168  */
169 DEFINE_STATIC_LGLOCK(file_lock_lglock);
170 static DEFINE_PER_CPU(struct hlist_head, file_lock_list);
171
172 /*
173  * The blocked_hash is used to find POSIX lock loops for deadlock detection.
174  * It is protected by blocked_lock_lock.
175  *
176  * We hash locks by lockowner in order to optimize searching for the lock a
177  * particular lockowner is waiting on.
178  *
179  * FIXME: make this value scale via some heuristic? We generally will want more
180  * buckets when we have more lockowners holding locks, but that's a little
181  * difficult to determine without knowing what the workload will look like.
182  */
183 #define BLOCKED_HASH_BITS       7
184 static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
185
186 /*
187  * This lock protects the blocked_hash. Generally, if you're accessing it, you
188  * want to be holding this lock.
189  *
190  * In addition, it also protects the fl->fl_block list, and the fl->fl_next
191  * pointer for file_lock structures that are acting as lock requests (in
192  * contrast to those that are acting as records of acquired locks).
193  *
194  * Note that when we acquire this lock in order to change the above fields,
195  * we often hold the i_lock as well. In certain cases, when reading the fields
196  * protected by this lock, we can skip acquiring it iff we already hold the
197  * i_lock.
198  *
199  * In particular, adding an entry to the fl_block list requires that you hold
200  * both the i_lock and the blocked_lock_lock (acquired in that order). Deleting
201  * an entry from the list however only requires the file_lock_lock.
202  */
203 static DEFINE_SPINLOCK(blocked_lock_lock);
204
205 static struct kmem_cache *filelock_cache __read_mostly;
206
207 static void locks_init_lock_heads(struct file_lock *fl)
208 {
209         INIT_HLIST_NODE(&fl->fl_link);
210         INIT_LIST_HEAD(&fl->fl_block);
211         init_waitqueue_head(&fl->fl_wait);
212 }
213
214 /* Allocate an empty lock structure. */
215 struct file_lock *locks_alloc_lock(void)
216 {
217         struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
218
219         if (fl)
220                 locks_init_lock_heads(fl);
221
222         return fl;
223 }
224 EXPORT_SYMBOL_GPL(locks_alloc_lock);
225
226 void locks_release_private(struct file_lock *fl)
227 {
228         if (fl->fl_ops) {
229                 if (fl->fl_ops->fl_release_private)
230                         fl->fl_ops->fl_release_private(fl);
231                 fl->fl_ops = NULL;
232         }
233
234         if (fl->fl_lmops) {
235                 if (fl->fl_lmops->lm_put_owner)
236                         fl->fl_lmops->lm_put_owner(fl);
237                 fl->fl_lmops = NULL;
238         }
239 }
240 EXPORT_SYMBOL_GPL(locks_release_private);
241
242 /* Free a lock which is not in use. */
243 void locks_free_lock(struct file_lock *fl)
244 {
245         BUG_ON(waitqueue_active(&fl->fl_wait));
246         BUG_ON(!list_empty(&fl->fl_block));
247         BUG_ON(!hlist_unhashed(&fl->fl_link));
248
249         locks_release_private(fl);
250         kmem_cache_free(filelock_cache, fl);
251 }
252 EXPORT_SYMBOL(locks_free_lock);
253
254 static void
255 locks_dispose_list(struct list_head *dispose)
256 {
257         struct file_lock *fl;
258
259         while (!list_empty(dispose)) {
260                 fl = list_first_entry(dispose, struct file_lock, fl_block);
261                 list_del_init(&fl->fl_block);
262                 locks_free_lock(fl);
263         }
264 }
265
266 void locks_init_lock(struct file_lock *fl)
267 {
268         memset(fl, 0, sizeof(struct file_lock));
269         locks_init_lock_heads(fl);
270 }
271
272 EXPORT_SYMBOL(locks_init_lock);
273
274 /*
275  * Initialize a new lock from an existing file_lock structure.
276  */
277 void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
278 {
279         new->fl_owner = fl->fl_owner;
280         new->fl_pid = fl->fl_pid;
281         new->fl_file = NULL;
282         new->fl_flags = fl->fl_flags;
283         new->fl_type = fl->fl_type;
284         new->fl_start = fl->fl_start;
285         new->fl_end = fl->fl_end;
286         new->fl_lmops = fl->fl_lmops;
287         new->fl_ops = NULL;
288
289         if (fl->fl_lmops) {
290                 if (fl->fl_lmops->lm_get_owner)
291                         fl->fl_lmops->lm_get_owner(new, fl);
292         }
293 }
294 EXPORT_SYMBOL(locks_copy_conflock);
295
296 void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
297 {
298         /* "new" must be a freshly-initialized lock */
299         WARN_ON_ONCE(new->fl_ops);
300
301         locks_copy_conflock(new, fl);
302
303         new->fl_file = fl->fl_file;
304         new->fl_ops = fl->fl_ops;
305
306         if (fl->fl_ops) {
307                 if (fl->fl_ops->fl_copy_lock)
308                         fl->fl_ops->fl_copy_lock(new, fl);
309         }
310 }
311
312 EXPORT_SYMBOL(locks_copy_lock);
313
314 static inline int flock_translate_cmd(int cmd) {
315         if (cmd & LOCK_MAND)
316                 return cmd & (LOCK_MAND | LOCK_RW);
317         switch (cmd) {
318         case LOCK_SH:
319                 return F_RDLCK;
320         case LOCK_EX:
321                 return F_WRLCK;
322         case LOCK_UN:
323                 return F_UNLCK;
324         }
325         return -EINVAL;
326 }
327
328 /* Fill in a file_lock structure with an appropriate FLOCK lock. */
329 static int flock_make_lock(struct file *filp, struct file_lock **lock,
330                 unsigned int cmd)
331 {
332         struct file_lock *fl;
333         int type = flock_translate_cmd(cmd);
334         if (type < 0)
335                 return type;
336         
337         fl = locks_alloc_lock();
338         if (fl == NULL)
339                 return -ENOMEM;
340
341         fl->fl_file = filp;
342         fl->fl_owner = filp;
343         fl->fl_pid = current->tgid;
344         fl->fl_flags = FL_FLOCK;
345         fl->fl_type = type;
346         fl->fl_end = OFFSET_MAX;
347         
348         *lock = fl;
349         return 0;
350 }
351
352 static int assign_type(struct file_lock *fl, long type)
353 {
354         switch (type) {
355         case F_RDLCK:
356         case F_WRLCK:
357         case F_UNLCK:
358                 fl->fl_type = type;
359                 break;
360         default:
361                 return -EINVAL;
362         }
363         return 0;
364 }
365
366 static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
367                                  struct flock64 *l)
368 {
369         switch (l->l_whence) {
370         case SEEK_SET:
371                 fl->fl_start = 0;
372                 break;
373         case SEEK_CUR:
374                 fl->fl_start = filp->f_pos;
375                 break;
376         case SEEK_END:
377                 fl->fl_start = i_size_read(file_inode(filp));
378                 break;
379         default:
380                 return -EINVAL;
381         }
382         if (l->l_start > OFFSET_MAX - fl->fl_start)
383                 return -EOVERFLOW;
384         fl->fl_start += l->l_start;
385         if (fl->fl_start < 0)
386                 return -EINVAL;
387
388         /* POSIX-1996 leaves the case l->l_len < 0 undefined;
389            POSIX-2001 defines it. */
390         if (l->l_len > 0) {
391                 if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
392                         return -EOVERFLOW;
393                 fl->fl_end = fl->fl_start + l->l_len - 1;
394
395         } else if (l->l_len < 0) {
396                 if (fl->fl_start + l->l_len < 0)
397                         return -EINVAL;
398                 fl->fl_end = fl->fl_start - 1;
399                 fl->fl_start += l->l_len;
400         } else
401                 fl->fl_end = OFFSET_MAX;
402
403         fl->fl_owner = current->files;
404         fl->fl_pid = current->tgid;
405         fl->fl_file = filp;
406         fl->fl_flags = FL_POSIX;
407         fl->fl_ops = NULL;
408         fl->fl_lmops = NULL;
409
410         return assign_type(fl, l->l_type);
411 }
412
413 /* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
414  * style lock.
415  */
416 static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
417                                struct flock *l)
418 {
419         struct flock64 ll = {
420                 .l_type = l->l_type,
421                 .l_whence = l->l_whence,
422                 .l_start = l->l_start,
423                 .l_len = l->l_len,
424         };
425
426         return flock64_to_posix_lock(filp, fl, &ll);
427 }
428
429 /* default lease lock manager operations */
430 static void lease_break_callback(struct file_lock *fl)
431 {
432         kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
433 }
434
435 static void
436 lease_setup(struct file_lock *fl, void **priv)
437 {
438         struct file *filp = fl->fl_file;
439         struct fasync_struct *fa = *priv;
440
441         /*
442          * fasync_insert_entry() returns the old entry if any. If there was no
443          * old entry, then it used "priv" and inserted it into the fasync list.
444          * Clear the pointer to indicate that it shouldn't be freed.
445          */
446         if (!fasync_insert_entry(fa->fa_fd, filp, &fl->fl_fasync, fa))
447                 *priv = NULL;
448
449         __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
450 }
451
452 static const struct lock_manager_operations lease_manager_ops = {
453         .lm_break = lease_break_callback,
454         .lm_change = lease_modify,
455         .lm_setup = lease_setup,
456 };
457
458 /*
459  * Initialize a lease, use the default lock manager operations
460  */
461 static int lease_init(struct file *filp, long type, struct file_lock *fl)
462  {
463         if (assign_type(fl, type) != 0)
464                 return -EINVAL;
465
466         fl->fl_owner = current->files;
467         fl->fl_pid = current->tgid;
468
469         fl->fl_file = filp;
470         fl->fl_flags = FL_LEASE;
471         fl->fl_start = 0;
472         fl->fl_end = OFFSET_MAX;
473         fl->fl_ops = NULL;
474         fl->fl_lmops = &lease_manager_ops;
475         return 0;
476 }
477
478 /* Allocate a file_lock initialised to this type of lease */
479 static struct file_lock *lease_alloc(struct file *filp, long type)
480 {
481         struct file_lock *fl = locks_alloc_lock();
482         int error = -ENOMEM;
483
484         if (fl == NULL)
485                 return ERR_PTR(error);
486
487         error = lease_init(filp, type, fl);
488         if (error) {
489                 locks_free_lock(fl);
490                 return ERR_PTR(error);
491         }
492         return fl;
493 }
494
495 /* Check if two locks overlap each other.
496  */
497 static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
498 {
499         return ((fl1->fl_end >= fl2->fl_start) &&
500                 (fl2->fl_end >= fl1->fl_start));
501 }
502
503 /*
504  * Check whether two locks have the same owner.
505  */
506 static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
507 {
508         if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
509                 return fl2->fl_lmops == fl1->fl_lmops &&
510                         fl1->fl_lmops->lm_compare_owner(fl1, fl2);
511         return fl1->fl_owner == fl2->fl_owner;
512 }
513
514 /* Must be called with the i_lock held! */
515 static void locks_insert_global_locks(struct file_lock *fl)
516 {
517         lg_local_lock(&file_lock_lglock);
518         fl->fl_link_cpu = smp_processor_id();
519         hlist_add_head(&fl->fl_link, this_cpu_ptr(&file_lock_list));
520         lg_local_unlock(&file_lock_lglock);
521 }
522
523 /* Must be called with the i_lock held! */
524 static void locks_delete_global_locks(struct file_lock *fl)
525 {
526         /*
527          * Avoid taking lock if already unhashed. This is safe since this check
528          * is done while holding the i_lock, and new insertions into the list
529          * also require that it be held.
530          */
531         if (hlist_unhashed(&fl->fl_link))
532                 return;
533         lg_local_lock_cpu(&file_lock_lglock, fl->fl_link_cpu);
534         hlist_del_init(&fl->fl_link);
535         lg_local_unlock_cpu(&file_lock_lglock, fl->fl_link_cpu);
536 }
537
538 static unsigned long
539 posix_owner_key(struct file_lock *fl)
540 {
541         if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
542                 return fl->fl_lmops->lm_owner_key(fl);
543         return (unsigned long)fl->fl_owner;
544 }
545
546 static void locks_insert_global_blocked(struct file_lock *waiter)
547 {
548         hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
549 }
550
551 static void locks_delete_global_blocked(struct file_lock *waiter)
552 {
553         hash_del(&waiter->fl_link);
554 }
555
556 /* Remove waiter from blocker's block list.
557  * When blocker ends up pointing to itself then the list is empty.
558  *
559  * Must be called with blocked_lock_lock held.
560  */
561 static void __locks_delete_block(struct file_lock *waiter)
562 {
563         locks_delete_global_blocked(waiter);
564         list_del_init(&waiter->fl_block);
565         waiter->fl_next = NULL;
566 }
567
568 static void locks_delete_block(struct file_lock *waiter)
569 {
570         spin_lock(&blocked_lock_lock);
571         __locks_delete_block(waiter);
572         spin_unlock(&blocked_lock_lock);
573 }
574
575 /* Insert waiter into blocker's block list.
576  * We use a circular list so that processes can be easily woken up in
577  * the order they blocked. The documentation doesn't require this but
578  * it seems like the reasonable thing to do.
579  *
580  * Must be called with both the i_lock and blocked_lock_lock held. The fl_block
581  * list itself is protected by the blocked_lock_lock, but by ensuring that the
582  * i_lock is also held on insertions we can avoid taking the blocked_lock_lock
583  * in some cases when we see that the fl_block list is empty.
584  */
585 static void __locks_insert_block(struct file_lock *blocker,
586                                         struct file_lock *waiter)
587 {
588         BUG_ON(!list_empty(&waiter->fl_block));
589         waiter->fl_next = blocker;
590         list_add_tail(&waiter->fl_block, &blocker->fl_block);
591         if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
592                 locks_insert_global_blocked(waiter);
593 }
594
595 /* Must be called with i_lock held. */
596 static void locks_insert_block(struct file_lock *blocker,
597                                         struct file_lock *waiter)
598 {
599         spin_lock(&blocked_lock_lock);
600         __locks_insert_block(blocker, waiter);
601         spin_unlock(&blocked_lock_lock);
602 }
603
604 /*
605  * Wake up processes blocked waiting for blocker.
606  *
607  * Must be called with the inode->i_lock held!
608  */
609 static void locks_wake_up_blocks(struct file_lock *blocker)
610 {
611         /*
612          * Avoid taking global lock if list is empty. This is safe since new
613          * blocked requests are only added to the list under the i_lock, and
614          * the i_lock is always held here. Note that removal from the fl_block
615          * list does not require the i_lock, so we must recheck list_empty()
616          * after acquiring the blocked_lock_lock.
617          */
618         if (list_empty(&blocker->fl_block))
619                 return;
620
621         spin_lock(&blocked_lock_lock);
622         while (!list_empty(&blocker->fl_block)) {
623                 struct file_lock *waiter;
624
625                 waiter = list_first_entry(&blocker->fl_block,
626                                 struct file_lock, fl_block);
627                 __locks_delete_block(waiter);
628                 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
629                         waiter->fl_lmops->lm_notify(waiter);
630                 else
631                         wake_up(&waiter->fl_wait);
632         }
633         spin_unlock(&blocked_lock_lock);
634 }
635
636 /* Insert file lock fl into an inode's lock list at the position indicated
637  * by pos. At the same time add the lock to the global file lock list.
638  *
639  * Must be called with the i_lock held!
640  */
641 static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
642 {
643         fl->fl_nspid = get_pid(task_tgid(current));
644
645         /* insert into file's list */
646         fl->fl_next = *pos;
647         *pos = fl;
648
649         locks_insert_global_locks(fl);
650 }
651
652 /**
653  * locks_delete_lock - Delete a lock and then free it.
654  * @thisfl_p: pointer that points to the fl_next field of the previous
655  *            inode->i_flock list entry
656  *
657  * Unlink a lock from all lists and free the namespace reference, but don't
658  * free it yet. Wake up processes that are blocked waiting for this lock and
659  * notify the FS that the lock has been cleared.
660  *
661  * Must be called with the i_lock held!
662  */
663 static void locks_unlink_lock(struct file_lock **thisfl_p)
664 {
665         struct file_lock *fl = *thisfl_p;
666
667         locks_delete_global_locks(fl);
668
669         *thisfl_p = fl->fl_next;
670         fl->fl_next = NULL;
671
672         if (fl->fl_nspid) {
673                 put_pid(fl->fl_nspid);
674                 fl->fl_nspid = NULL;
675         }
676
677         locks_wake_up_blocks(fl);
678 }
679
680 /*
681  * Unlink a lock from all lists and free it.
682  *
683  * Must be called with i_lock held!
684  */
685 static void locks_delete_lock(struct file_lock **thisfl_p,
686                               struct list_head *dispose)
687 {
688         struct file_lock *fl = *thisfl_p;
689
690         locks_unlink_lock(thisfl_p);
691         if (dispose)
692                 list_add(&fl->fl_block, dispose);
693         else
694                 locks_free_lock(fl);
695 }
696
697 /* Determine if lock sys_fl blocks lock caller_fl. Common functionality
698  * checks for shared/exclusive status of overlapping locks.
699  */
700 static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
701 {
702         if (sys_fl->fl_type == F_WRLCK)
703                 return 1;
704         if (caller_fl->fl_type == F_WRLCK)
705                 return 1;
706         return 0;
707 }
708
709 /* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
710  * checking before calling the locks_conflict().
711  */
712 static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
713 {
714         /* POSIX locks owned by the same process do not conflict with
715          * each other.
716          */
717         if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
718                 return (0);
719
720         /* Check whether they overlap */
721         if (!locks_overlap(caller_fl, sys_fl))
722                 return 0;
723
724         return (locks_conflict(caller_fl, sys_fl));
725 }
726
727 /* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
728  * checking before calling the locks_conflict().
729  */
730 static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
731 {
732         /* FLOCK locks referring to the same filp do not conflict with
733          * each other.
734          */
735         if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
736                 return (0);
737         if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
738                 return 0;
739
740         return (locks_conflict(caller_fl, sys_fl));
741 }
742
743 void
744 posix_test_lock(struct file *filp, struct file_lock *fl)
745 {
746         struct file_lock *cfl;
747         struct inode *inode = file_inode(filp);
748
749         spin_lock(&inode->i_lock);
750         for (cfl = file_inode(filp)->i_flock; cfl; cfl = cfl->fl_next) {
751                 if (!IS_POSIX(cfl))
752                         continue;
753                 if (posix_locks_conflict(fl, cfl))
754                         break;
755         }
756         if (cfl) {
757                 locks_copy_conflock(fl, cfl);
758                 if (cfl->fl_nspid)
759                         fl->fl_pid = pid_vnr(cfl->fl_nspid);
760         } else
761                 fl->fl_type = F_UNLCK;
762         spin_unlock(&inode->i_lock);
763         return;
764 }
765 EXPORT_SYMBOL(posix_test_lock);
766
767 /*
768  * Deadlock detection:
769  *
770  * We attempt to detect deadlocks that are due purely to posix file
771  * locks.
772  *
773  * We assume that a task can be waiting for at most one lock at a time.
774  * So for any acquired lock, the process holding that lock may be
775  * waiting on at most one other lock.  That lock in turns may be held by
776  * someone waiting for at most one other lock.  Given a requested lock
777  * caller_fl which is about to wait for a conflicting lock block_fl, we
778  * follow this chain of waiters to ensure we are not about to create a
779  * cycle.
780  *
781  * Since we do this before we ever put a process to sleep on a lock, we
782  * are ensured that there is never a cycle; that is what guarantees that
783  * the while() loop in posix_locks_deadlock() eventually completes.
784  *
785  * Note: the above assumption may not be true when handling lock
786  * requests from a broken NFS client. It may also fail in the presence
787  * of tasks (such as posix threads) sharing the same open file table.
788  * To handle those cases, we just bail out after a few iterations.
789  *
790  * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
791  * Because the owner is not even nominally tied to a thread of
792  * execution, the deadlock detection below can't reasonably work well. Just
793  * skip it for those.
794  *
795  * In principle, we could do a more limited deadlock detection on FL_OFDLCK
796  * locks that just checks for the case where two tasks are attempting to
797  * upgrade from read to write locks on the same inode.
798  */
799
800 #define MAX_DEADLK_ITERATIONS 10
801
802 /* Find a lock that the owner of the given block_fl is blocking on. */
803 static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
804 {
805         struct file_lock *fl;
806
807         hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
808                 if (posix_same_owner(fl, block_fl))
809                         return fl->fl_next;
810         }
811         return NULL;
812 }
813
814 /* Must be called with the blocked_lock_lock held! */
815 static int posix_locks_deadlock(struct file_lock *caller_fl,
816                                 struct file_lock *block_fl)
817 {
818         int i = 0;
819
820         /*
821          * This deadlock detector can't reasonably detect deadlocks with
822          * FL_OFDLCK locks, since they aren't owned by a process, per-se.
823          */
824         if (IS_OFDLCK(caller_fl))
825                 return 0;
826
827         while ((block_fl = what_owner_is_waiting_for(block_fl))) {
828                 if (i++ > MAX_DEADLK_ITERATIONS)
829                         return 0;
830                 if (posix_same_owner(caller_fl, block_fl))
831                         return 1;
832         }
833         return 0;
834 }
835
836 /* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
837  * after any leases, but before any posix locks.
838  *
839  * Note that if called with an FL_EXISTS argument, the caller may determine
840  * whether or not a lock was successfully freed by testing the return
841  * value for -ENOENT.
842  */
843 static int flock_lock_file(struct file *filp, struct file_lock *request)
844 {
845         struct file_lock *new_fl = NULL;
846         struct file_lock **before;
847         struct inode * inode = file_inode(filp);
848         int error = 0;
849         int found = 0;
850         LIST_HEAD(dispose);
851
852         if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
853                 new_fl = locks_alloc_lock();
854                 if (!new_fl)
855                         return -ENOMEM;
856         }
857
858         spin_lock(&inode->i_lock);
859         if (request->fl_flags & FL_ACCESS)
860                 goto find_conflict;
861
862         for_each_lock(inode, before) {
863                 struct file_lock *fl = *before;
864                 if (IS_POSIX(fl))
865                         break;
866                 if (IS_LEASE(fl))
867                         continue;
868                 if (filp != fl->fl_file)
869                         continue;
870                 if (request->fl_type == fl->fl_type)
871                         goto out;
872                 found = 1;
873                 locks_delete_lock(before, &dispose);
874                 break;
875         }
876
877         if (request->fl_type == F_UNLCK) {
878                 if ((request->fl_flags & FL_EXISTS) && !found)
879                         error = -ENOENT;
880                 goto out;
881         }
882
883         /*
884          * If a higher-priority process was blocked on the old file lock,
885          * give it the opportunity to lock the file.
886          */
887         if (found) {
888                 spin_unlock(&inode->i_lock);
889                 cond_resched();
890                 spin_lock(&inode->i_lock);
891         }
892
893 find_conflict:
894         for_each_lock(inode, before) {
895                 struct file_lock *fl = *before;
896                 if (IS_POSIX(fl))
897                         break;
898                 if (IS_LEASE(fl))
899                         continue;
900                 if (!flock_locks_conflict(request, fl))
901                         continue;
902                 error = -EAGAIN;
903                 if (!(request->fl_flags & FL_SLEEP))
904                         goto out;
905                 error = FILE_LOCK_DEFERRED;
906                 locks_insert_block(fl, request);
907                 goto out;
908         }
909         if (request->fl_flags & FL_ACCESS)
910                 goto out;
911         locks_copy_lock(new_fl, request);
912         locks_insert_lock(before, new_fl);
913         new_fl = NULL;
914         error = 0;
915
916 out:
917         spin_unlock(&inode->i_lock);
918         if (new_fl)
919                 locks_free_lock(new_fl);
920         locks_dispose_list(&dispose);
921         return error;
922 }
923
924 static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
925 {
926         struct file_lock *fl;
927         struct file_lock *new_fl = NULL;
928         struct file_lock *new_fl2 = NULL;
929         struct file_lock *left = NULL;
930         struct file_lock *right = NULL;
931         struct file_lock **before;
932         int error;
933         bool added = false;
934         LIST_HEAD(dispose);
935
936         /*
937          * We may need two file_lock structures for this operation,
938          * so we get them in advance to avoid races.
939          *
940          * In some cases we can be sure, that no new locks will be needed
941          */
942         if (!(request->fl_flags & FL_ACCESS) &&
943             (request->fl_type != F_UNLCK ||
944              request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
945                 new_fl = locks_alloc_lock();
946                 new_fl2 = locks_alloc_lock();
947         }
948
949         spin_lock(&inode->i_lock);
950         /*
951          * New lock request. Walk all POSIX locks and look for conflicts. If
952          * there are any, either return error or put the request on the
953          * blocker's list of waiters and the global blocked_hash.
954          */
955         if (request->fl_type != F_UNLCK) {
956                 for_each_lock(inode, before) {
957                         fl = *before;
958                         if (!IS_POSIX(fl))
959                                 continue;
960                         if (!posix_locks_conflict(request, fl))
961                                 continue;
962                         if (conflock)
963                                 locks_copy_conflock(conflock, fl);
964                         error = -EAGAIN;
965                         if (!(request->fl_flags & FL_SLEEP))
966                                 goto out;
967                         /*
968                          * Deadlock detection and insertion into the blocked
969                          * locks list must be done while holding the same lock!
970                          */
971                         error = -EDEADLK;
972                         spin_lock(&blocked_lock_lock);
973                         if (likely(!posix_locks_deadlock(request, fl))) {
974                                 error = FILE_LOCK_DEFERRED;
975                                 __locks_insert_block(fl, request);
976                         }
977                         spin_unlock(&blocked_lock_lock);
978                         goto out;
979                 }
980         }
981
982         /* If we're just looking for a conflict, we're done. */
983         error = 0;
984         if (request->fl_flags & FL_ACCESS)
985                 goto out;
986
987         /*
988          * Find the first old lock with the same owner as the new lock.
989          */
990         
991         before = &inode->i_flock;
992
993         /* First skip locks owned by other processes.  */
994         while ((fl = *before) && (!IS_POSIX(fl) ||
995                                   !posix_same_owner(request, fl))) {
996                 before = &fl->fl_next;
997         }
998
999         /* Process locks with this owner. */
1000         while ((fl = *before) && posix_same_owner(request, fl)) {
1001                 /* Detect adjacent or overlapping regions (if same lock type)
1002                  */
1003                 if (request->fl_type == fl->fl_type) {
1004                         /* In all comparisons of start vs end, use
1005                          * "start - 1" rather than "end + 1". If end
1006                          * is OFFSET_MAX, end + 1 will become negative.
1007                          */
1008                         if (fl->fl_end < request->fl_start - 1)
1009                                 goto next_lock;
1010                         /* If the next lock in the list has entirely bigger
1011                          * addresses than the new one, insert the lock here.
1012                          */
1013                         if (fl->fl_start - 1 > request->fl_end)
1014                                 break;
1015
1016                         /* If we come here, the new and old lock are of the
1017                          * same type and adjacent or overlapping. Make one
1018                          * lock yielding from the lower start address of both
1019                          * locks to the higher end address.
1020                          */
1021                         if (fl->fl_start > request->fl_start)
1022                                 fl->fl_start = request->fl_start;
1023                         else
1024                                 request->fl_start = fl->fl_start;
1025                         if (fl->fl_end < request->fl_end)
1026                                 fl->fl_end = request->fl_end;
1027                         else
1028                                 request->fl_end = fl->fl_end;
1029                         if (added) {
1030                                 locks_delete_lock(before, &dispose);
1031                                 continue;
1032                         }
1033                         request = fl;
1034                         added = true;
1035                 }
1036                 else {
1037                         /* Processing for different lock types is a bit
1038                          * more complex.
1039                          */
1040                         if (fl->fl_end < request->fl_start)
1041                                 goto next_lock;
1042                         if (fl->fl_start > request->fl_end)
1043                                 break;
1044                         if (request->fl_type == F_UNLCK)
1045                                 added = true;
1046                         if (fl->fl_start < request->fl_start)
1047                                 left = fl;
1048                         /* If the next lock in the list has a higher end
1049                          * address than the new one, insert the new one here.
1050                          */
1051                         if (fl->fl_end > request->fl_end) {
1052                                 right = fl;
1053                                 break;
1054                         }
1055                         if (fl->fl_start >= request->fl_start) {
1056                                 /* The new lock completely replaces an old
1057                                  * one (This may happen several times).
1058                                  */
1059                                 if (added) {
1060                                         locks_delete_lock(before, &dispose);
1061                                         continue;
1062                                 }
1063                                 /*
1064                                  * Replace the old lock with new_fl, and
1065                                  * remove the old one. It's safe to do the
1066                                  * insert here since we know that we won't be
1067                                  * using new_fl later, and that the lock is
1068                                  * just replacing an existing lock.
1069                                  */
1070                                 error = -ENOLCK;
1071                                 if (!new_fl)
1072                                         goto out;
1073                                 locks_copy_lock(new_fl, request);
1074                                 request = new_fl;
1075                                 new_fl = NULL;
1076                                 locks_delete_lock(before, &dispose);
1077                                 locks_insert_lock(before, request);
1078                                 added = true;
1079                         }
1080                 }
1081                 /* Go on to next lock.
1082                  */
1083         next_lock:
1084                 before = &fl->fl_next;
1085         }
1086
1087         /*
1088          * The above code only modifies existing locks in case of merging or
1089          * replacing. If new lock(s) need to be inserted all modifications are
1090          * done below this, so it's safe yet to bail out.
1091          */
1092         error = -ENOLCK; /* "no luck" */
1093         if (right && left == right && !new_fl2)
1094                 goto out;
1095
1096         error = 0;
1097         if (!added) {
1098                 if (request->fl_type == F_UNLCK) {
1099                         if (request->fl_flags & FL_EXISTS)
1100                                 error = -ENOENT;
1101                         goto out;
1102                 }
1103
1104                 if (!new_fl) {
1105                         error = -ENOLCK;
1106                         goto out;
1107                 }
1108                 locks_copy_lock(new_fl, request);
1109                 locks_insert_lock(before, new_fl);
1110                 new_fl = NULL;
1111         }
1112         if (right) {
1113                 if (left == right) {
1114                         /* The new lock breaks the old one in two pieces,
1115                          * so we have to use the second new lock.
1116                          */
1117                         left = new_fl2;
1118                         new_fl2 = NULL;
1119                         locks_copy_lock(left, right);
1120                         locks_insert_lock(before, left);
1121                 }
1122                 right->fl_start = request->fl_end + 1;
1123                 locks_wake_up_blocks(right);
1124         }
1125         if (left) {
1126                 left->fl_end = request->fl_start - 1;
1127                 locks_wake_up_blocks(left);
1128         }
1129  out:
1130         spin_unlock(&inode->i_lock);
1131         /*
1132          * Free any unused locks.
1133          */
1134         if (new_fl)
1135                 locks_free_lock(new_fl);
1136         if (new_fl2)
1137                 locks_free_lock(new_fl2);
1138         locks_dispose_list(&dispose);
1139         return error;
1140 }
1141
1142 /**
1143  * posix_lock_file - Apply a POSIX-style lock to a file
1144  * @filp: The file to apply the lock to
1145  * @fl: The lock to be applied
1146  * @conflock: Place to return a copy of the conflicting lock, if found.
1147  *
1148  * Add a POSIX style lock to a file.
1149  * We merge adjacent & overlapping locks whenever possible.
1150  * POSIX locks are sorted by owner task, then by starting address
1151  *
1152  * Note that if called with an FL_EXISTS argument, the caller may determine
1153  * whether or not a lock was successfully freed by testing the return
1154  * value for -ENOENT.
1155  */
1156 int posix_lock_file(struct file *filp, struct file_lock *fl,
1157                         struct file_lock *conflock)
1158 {
1159         return __posix_lock_file(file_inode(filp), fl, conflock);
1160 }
1161 EXPORT_SYMBOL(posix_lock_file);
1162
1163 /**
1164  * posix_lock_file_wait - Apply a POSIX-style lock to a file
1165  * @filp: The file to apply the lock to
1166  * @fl: The lock to be applied
1167  *
1168  * Add a POSIX style lock to a file.
1169  * We merge adjacent & overlapping locks whenever possible.
1170  * POSIX locks are sorted by owner task, then by starting address
1171  */
1172 int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1173 {
1174         int error;
1175         might_sleep ();
1176         for (;;) {
1177                 error = posix_lock_file(filp, fl, NULL);
1178                 if (error != FILE_LOCK_DEFERRED)
1179                         break;
1180                 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1181                 if (!error)
1182                         continue;
1183
1184                 locks_delete_block(fl);
1185                 break;
1186         }
1187         return error;
1188 }
1189 EXPORT_SYMBOL(posix_lock_file_wait);
1190
1191 /**
1192  * locks_mandatory_locked - Check for an active lock
1193  * @file: the file to check
1194  *
1195  * Searches the inode's list of locks to find any POSIX locks which conflict.
1196  * This function is called from locks_verify_locked() only.
1197  */
1198 int locks_mandatory_locked(struct file *file)
1199 {
1200         struct inode *inode = file_inode(file);
1201         struct file_lock *fl;
1202
1203         /*
1204          * Search the lock list for this inode for any POSIX locks.
1205          */
1206         spin_lock(&inode->i_lock);
1207         for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1208                 if (!IS_POSIX(fl))
1209                         continue;
1210                 if (fl->fl_owner != current->files &&
1211                     fl->fl_owner != file)
1212                         break;
1213         }
1214         spin_unlock(&inode->i_lock);
1215         return fl ? -EAGAIN : 0;
1216 }
1217
1218 /**
1219  * locks_mandatory_area - Check for a conflicting lock
1220  * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1221  *              for shared
1222  * @inode:      the file to check
1223  * @filp:       how the file was opened (if it was)
1224  * @offset:     start of area to check
1225  * @count:      length of area to check
1226  *
1227  * Searches the inode's list of locks to find any POSIX locks which conflict.
1228  * This function is called from rw_verify_area() and
1229  * locks_verify_truncate().
1230  */
1231 int locks_mandatory_area(int read_write, struct inode *inode,
1232                          struct file *filp, loff_t offset,
1233                          size_t count)
1234 {
1235         struct file_lock fl;
1236         int error;
1237         bool sleep = false;
1238
1239         locks_init_lock(&fl);
1240         fl.fl_pid = current->tgid;
1241         fl.fl_file = filp;
1242         fl.fl_flags = FL_POSIX | FL_ACCESS;
1243         if (filp && !(filp->f_flags & O_NONBLOCK))
1244                 sleep = true;
1245         fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1246         fl.fl_start = offset;
1247         fl.fl_end = offset + count - 1;
1248
1249         for (;;) {
1250                 if (filp) {
1251                         fl.fl_owner = filp;
1252                         fl.fl_flags &= ~FL_SLEEP;
1253                         error = __posix_lock_file(inode, &fl, NULL);
1254                         if (!error)
1255                                 break;
1256                 }
1257
1258                 if (sleep)
1259                         fl.fl_flags |= FL_SLEEP;
1260                 fl.fl_owner = current->files;
1261                 error = __posix_lock_file(inode, &fl, NULL);
1262                 if (error != FILE_LOCK_DEFERRED)
1263                         break;
1264                 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1265                 if (!error) {
1266                         /*
1267                          * If we've been sleeping someone might have
1268                          * changed the permissions behind our back.
1269                          */
1270                         if (__mandatory_lock(inode))
1271                                 continue;
1272                 }
1273
1274                 locks_delete_block(&fl);
1275                 break;
1276         }
1277
1278         return error;
1279 }
1280
1281 EXPORT_SYMBOL(locks_mandatory_area);
1282
1283 static void lease_clear_pending(struct file_lock *fl, int arg)
1284 {
1285         switch (arg) {
1286         case F_UNLCK:
1287                 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1288                 /* fall through: */
1289         case F_RDLCK:
1290                 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1291         }
1292 }
1293
1294 /* We already had a lease on this file; just change its type */
1295 int lease_modify(struct file_lock **before, int arg, struct list_head *dispose)
1296 {
1297         struct file_lock *fl = *before;
1298         int error = assign_type(fl, arg);
1299
1300         if (error)
1301                 return error;
1302         lease_clear_pending(fl, arg);
1303         locks_wake_up_blocks(fl);
1304         if (arg == F_UNLCK) {
1305                 struct file *filp = fl->fl_file;
1306
1307                 f_delown(filp);
1308                 filp->f_owner.signum = 0;
1309                 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1310                 if (fl->fl_fasync != NULL) {
1311                         printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1312                         fl->fl_fasync = NULL;
1313                 }
1314                 locks_delete_lock(before, dispose);
1315         }
1316         return 0;
1317 }
1318 EXPORT_SYMBOL(lease_modify);
1319
1320 static bool past_time(unsigned long then)
1321 {
1322         if (!then)
1323                 /* 0 is a special value meaning "this never expires": */
1324                 return false;
1325         return time_after(jiffies, then);
1326 }
1327
1328 static void time_out_leases(struct inode *inode, struct list_head *dispose)
1329 {
1330         struct file_lock **before;
1331         struct file_lock *fl;
1332
1333         lockdep_assert_held(&inode->i_lock);
1334
1335         before = &inode->i_flock;
1336         while ((fl = *before) && IS_LEASE(fl) && lease_breaking(fl)) {
1337                 trace_time_out_leases(inode, fl);
1338                 if (past_time(fl->fl_downgrade_time))
1339                         lease_modify(before, F_RDLCK, dispose);
1340                 if (past_time(fl->fl_break_time))
1341                         lease_modify(before, F_UNLCK, dispose);
1342                 if (fl == *before)      /* lease_modify may have freed fl */
1343                         before = &fl->fl_next;
1344         }
1345 }
1346
1347 static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1348 {
1349         if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1350                 return false;
1351         return locks_conflict(breaker, lease);
1352 }
1353
1354 /**
1355  *      __break_lease   -       revoke all outstanding leases on file
1356  *      @inode: the inode of the file to return
1357  *      @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1358  *          break all leases
1359  *      @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1360  *          only delegations
1361  *
1362  *      break_lease (inlined for speed) has checked there already is at least
1363  *      some kind of lock (maybe a lease) on this file.  Leases are broken on
1364  *      a call to open() or truncate().  This function can sleep unless you
1365  *      specified %O_NONBLOCK to your open().
1366  */
1367 int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1368 {
1369         int error = 0;
1370         struct file_lock *new_fl, *flock;
1371         struct file_lock *fl;
1372         unsigned long break_time;
1373         bool lease_conflict = false;
1374         int want_write = (mode & O_ACCMODE) != O_RDONLY;
1375         LIST_HEAD(dispose);
1376
1377         new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
1378         if (IS_ERR(new_fl))
1379                 return PTR_ERR(new_fl);
1380         new_fl->fl_flags = type;
1381
1382         spin_lock(&inode->i_lock);
1383
1384         time_out_leases(inode, &dispose);
1385
1386         flock = inode->i_flock;
1387         if ((flock == NULL) || !IS_LEASE(flock))
1388                 goto out;
1389
1390         for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1391                 if (leases_conflict(fl, new_fl)) {
1392                         lease_conflict = true;
1393                         break;
1394                 }
1395         }
1396         if (!lease_conflict)
1397                 goto out;
1398
1399         break_time = 0;
1400         if (lease_break_time > 0) {
1401                 break_time = jiffies + lease_break_time * HZ;
1402                 if (break_time == 0)
1403                         break_time++;   /* so that 0 means no break time */
1404         }
1405
1406         for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1407                 if (!leases_conflict(fl, new_fl))
1408                         continue;
1409                 if (want_write) {
1410                         if (fl->fl_flags & FL_UNLOCK_PENDING)
1411                                 continue;
1412                         fl->fl_flags |= FL_UNLOCK_PENDING;
1413                         fl->fl_break_time = break_time;
1414                 } else {
1415                         if (lease_breaking(flock))
1416                                 continue;
1417                         fl->fl_flags |= FL_DOWNGRADE_PENDING;
1418                         fl->fl_downgrade_time = break_time;
1419                 }
1420                 fl->fl_lmops->lm_break(fl);
1421         }
1422
1423         if (mode & O_NONBLOCK) {
1424                 trace_break_lease_noblock(inode, new_fl);
1425                 error = -EWOULDBLOCK;
1426                 goto out;
1427         }
1428
1429 restart:
1430         break_time = flock->fl_break_time;
1431         if (break_time != 0)
1432                 break_time -= jiffies;
1433         if (break_time == 0)
1434                 break_time++;
1435         locks_insert_block(flock, new_fl);
1436         trace_break_lease_block(inode, new_fl);
1437         spin_unlock(&inode->i_lock);
1438         locks_dispose_list(&dispose);
1439         error = wait_event_interruptible_timeout(new_fl->fl_wait,
1440                                                 !new_fl->fl_next, break_time);
1441         spin_lock(&inode->i_lock);
1442         trace_break_lease_unblock(inode, new_fl);
1443         locks_delete_block(new_fl);
1444         if (error >= 0) {
1445                 if (error == 0)
1446                         time_out_leases(inode, &dispose);
1447                 /*
1448                  * Wait for the next conflicting lease that has not been
1449                  * broken yet
1450                  */
1451                 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1452                                 flock = flock->fl_next) {
1453                         if (leases_conflict(new_fl, flock))
1454                                 goto restart;
1455                 }
1456                 error = 0;
1457         }
1458
1459 out:
1460         spin_unlock(&inode->i_lock);
1461         locks_dispose_list(&dispose);
1462         locks_free_lock(new_fl);
1463         return error;
1464 }
1465
1466 EXPORT_SYMBOL(__break_lease);
1467
1468 /**
1469  *      lease_get_mtime - get the last modified time of an inode
1470  *      @inode: the inode
1471  *      @time:  pointer to a timespec which will contain the last modified time
1472  *
1473  * This is to force NFS clients to flush their caches for files with
1474  * exclusive leases.  The justification is that if someone has an
1475  * exclusive lease, then they could be modifying it.
1476  */
1477 void lease_get_mtime(struct inode *inode, struct timespec *time)
1478 {
1479         bool has_lease = false;
1480         struct file_lock *flock;
1481
1482         if (inode->i_flock) {
1483                 spin_lock(&inode->i_lock);
1484                 flock = inode->i_flock;
1485                 if (flock && IS_LEASE(flock) && (flock->fl_type == F_WRLCK))
1486                         has_lease = true;
1487                 spin_unlock(&inode->i_lock);
1488         }
1489
1490         if (has_lease)
1491                 *time = current_fs_time(inode->i_sb);
1492         else
1493                 *time = inode->i_mtime;
1494 }
1495
1496 EXPORT_SYMBOL(lease_get_mtime);
1497
1498 /**
1499  *      fcntl_getlease - Enquire what lease is currently active
1500  *      @filp: the file
1501  *
1502  *      The value returned by this function will be one of
1503  *      (if no lease break is pending):
1504  *
1505  *      %F_RDLCK to indicate a shared lease is held.
1506  *
1507  *      %F_WRLCK to indicate an exclusive lease is held.
1508  *
1509  *      %F_UNLCK to indicate no lease is held.
1510  *
1511  *      (if a lease break is pending):
1512  *
1513  *      %F_RDLCK to indicate an exclusive lease needs to be
1514  *              changed to a shared lease (or removed).
1515  *
1516  *      %F_UNLCK to indicate the lease needs to be removed.
1517  *
1518  *      XXX: sfr & willy disagree over whether F_INPROGRESS
1519  *      should be returned to userspace.
1520  */
1521 int fcntl_getlease(struct file *filp)
1522 {
1523         struct file_lock *fl;
1524         struct inode *inode = file_inode(filp);
1525         int type = F_UNLCK;
1526         LIST_HEAD(dispose);
1527
1528         spin_lock(&inode->i_lock);
1529         time_out_leases(file_inode(filp), &dispose);
1530         for (fl = file_inode(filp)->i_flock; fl && IS_LEASE(fl);
1531                         fl = fl->fl_next) {
1532                 if (fl->fl_file == filp) {
1533                         type = target_leasetype(fl);
1534                         break;
1535                 }
1536         }
1537         spin_unlock(&inode->i_lock);
1538         locks_dispose_list(&dispose);
1539         return type;
1540 }
1541
1542 /**
1543  * check_conflicting_open - see if the given dentry points to a file that has
1544  *                          an existing open that would conflict with the
1545  *                          desired lease.
1546  * @dentry:     dentry to check
1547  * @arg:        type of lease that we're trying to acquire
1548  *
1549  * Check to see if there's an existing open fd on this file that would
1550  * conflict with the lease we're trying to set.
1551  */
1552 static int
1553 check_conflicting_open(const struct dentry *dentry, const long arg)
1554 {
1555         int ret = 0;
1556         struct inode *inode = dentry->d_inode;
1557
1558         if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1559                 return -EAGAIN;
1560
1561         if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1562             (atomic_read(&inode->i_count) > 1)))
1563                 ret = -EAGAIN;
1564
1565         return ret;
1566 }
1567
1568 static int
1569 generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
1570 {
1571         struct file_lock *fl, **before, **my_before = NULL, *lease;
1572         struct dentry *dentry = filp->f_path.dentry;
1573         struct inode *inode = dentry->d_inode;
1574         bool is_deleg = (*flp)->fl_flags & FL_DELEG;
1575         int error;
1576         LIST_HEAD(dispose);
1577
1578         lease = *flp;
1579         trace_generic_add_lease(inode, lease);
1580
1581         /*
1582          * In the delegation case we need mutual exclusion with
1583          * a number of operations that take the i_mutex.  We trylock
1584          * because delegations are an optional optimization, and if
1585          * there's some chance of a conflict--we'd rather not
1586          * bother, maybe that's a sign this just isn't a good file to
1587          * hand out a delegation on.
1588          */
1589         if (is_deleg && !mutex_trylock(&inode->i_mutex))
1590                 return -EAGAIN;
1591
1592         if (is_deleg && arg == F_WRLCK) {
1593                 /* Write delegations are not currently supported: */
1594                 mutex_unlock(&inode->i_mutex);
1595                 WARN_ON_ONCE(1);
1596                 return -EINVAL;
1597         }
1598
1599         spin_lock(&inode->i_lock);
1600         time_out_leases(inode, &dispose);
1601         error = check_conflicting_open(dentry, arg);
1602         if (error)
1603                 goto out;
1604
1605         /*
1606          * At this point, we know that if there is an exclusive
1607          * lease on this file, then we hold it on this filp
1608          * (otherwise our open of this file would have blocked).
1609          * And if we are trying to acquire an exclusive lease,
1610          * then the file is not open by anyone (including us)
1611          * except for this filp.
1612          */
1613         error = -EAGAIN;
1614         for (before = &inode->i_flock;
1615                         ((fl = *before) != NULL) && IS_LEASE(fl);
1616                         before = &fl->fl_next) {
1617                 if (fl->fl_file == filp) {
1618                         my_before = before;
1619                         continue;
1620                 }
1621                 /*
1622                  * No exclusive leases if someone else has a lease on
1623                  * this file:
1624                  */
1625                 if (arg == F_WRLCK)
1626                         goto out;
1627                 /*
1628                  * Modifying our existing lease is OK, but no getting a
1629                  * new lease if someone else is opening for write:
1630                  */
1631                 if (fl->fl_flags & FL_UNLOCK_PENDING)
1632                         goto out;
1633         }
1634
1635         if (my_before != NULL) {
1636                 lease = *my_before;
1637                 error = lease->fl_lmops->lm_change(my_before, arg, &dispose);
1638                 if (error)
1639                         goto out;
1640                 goto out_setup;
1641         }
1642
1643         error = -EINVAL;
1644         if (!leases_enable)
1645                 goto out;
1646
1647         locks_insert_lock(before, lease);
1648         /*
1649          * The check in break_lease() is lockless. It's possible for another
1650          * open to race in after we did the earlier check for a conflicting
1651          * open but before the lease was inserted. Check again for a
1652          * conflicting open and cancel the lease if there is one.
1653          *
1654          * We also add a barrier here to ensure that the insertion of the lock
1655          * precedes these checks.
1656          */
1657         smp_mb();
1658         error = check_conflicting_open(dentry, arg);
1659         if (error)
1660                 goto out_unlink;
1661
1662 out_setup:
1663         if (lease->fl_lmops->lm_setup)
1664                 lease->fl_lmops->lm_setup(lease, priv);
1665 out:
1666         spin_unlock(&inode->i_lock);
1667         locks_dispose_list(&dispose);
1668         if (is_deleg)
1669                 mutex_unlock(&inode->i_mutex);
1670         if (!error && !my_before)
1671                 *flp = NULL;
1672         return error;
1673 out_unlink:
1674         locks_unlink_lock(before);
1675         goto out;
1676 }
1677
1678 static int generic_delete_lease(struct file *filp)
1679 {
1680         int error = -EAGAIN;
1681         struct file_lock *fl, **before;
1682         struct dentry *dentry = filp->f_path.dentry;
1683         struct inode *inode = dentry->d_inode;
1684         LIST_HEAD(dispose);
1685
1686         spin_lock(&inode->i_lock);
1687         time_out_leases(inode, &dispose);
1688         for (before = &inode->i_flock;
1689                         ((fl = *before) != NULL) && IS_LEASE(fl);
1690                         before = &fl->fl_next) {
1691                 if (fl->fl_file == filp)
1692                         break;
1693         }
1694         trace_generic_delete_lease(inode, fl);
1695         if (fl)
1696                 error = fl->fl_lmops->lm_change(before, F_UNLCK, &dispose);
1697         spin_unlock(&inode->i_lock);
1698         locks_dispose_list(&dispose);
1699         return error;
1700 }
1701
1702 /**
1703  *      generic_setlease        -       sets a lease on an open file
1704  *      @filp:  file pointer
1705  *      @arg:   type of lease to obtain
1706  *      @flp:   input - file_lock to use, output - file_lock inserted
1707  *      @priv:  private data for lm_setup (may be NULL if lm_setup
1708  *              doesn't require it)
1709  *
1710  *      The (input) flp->fl_lmops->lm_break function is required
1711  *      by break_lease().
1712  */
1713 int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
1714                         void **priv)
1715 {
1716         struct dentry *dentry = filp->f_path.dentry;
1717         struct inode *inode = dentry->d_inode;
1718         int error;
1719
1720         if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
1721                 return -EACCES;
1722         if (!S_ISREG(inode->i_mode))
1723                 return -EINVAL;
1724         error = security_file_lock(filp, arg);
1725         if (error)
1726                 return error;
1727
1728         switch (arg) {
1729         case F_UNLCK:
1730                 return generic_delete_lease(filp);
1731         case F_RDLCK:
1732         case F_WRLCK:
1733                 if (!(*flp)->fl_lmops->lm_break) {
1734                         WARN_ON_ONCE(1);
1735                         return -ENOLCK;
1736                 }
1737                 return generic_add_lease(filp, arg, flp, priv);
1738         default:
1739                 return -EINVAL;
1740         }
1741 }
1742 EXPORT_SYMBOL(generic_setlease);
1743
1744 /**
1745  * vfs_setlease        -       sets a lease on an open file
1746  * @filp:       file pointer
1747  * @arg:        type of lease to obtain
1748  * @lease:      file_lock to use when adding a lease
1749  * @priv:       private info for lm_setup when adding a lease (may be
1750  *              NULL if lm_setup doesn't require it)
1751  *
1752  * Call this to establish a lease on the file. The "lease" argument is not
1753  * used for F_UNLCK requests and may be NULL. For commands that set or alter
1754  * an existing lease, the (*lease)->fl_lmops->lm_break operation must be set;
1755  * if not, this function will return -ENOLCK (and generate a scary-looking
1756  * stack trace).
1757  *
1758  * The "priv" pointer is passed directly to the lm_setup function as-is. It
1759  * may be NULL if the lm_setup operation doesn't require it.
1760  */
1761 int
1762 vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
1763 {
1764         if (filp->f_op->setlease)
1765                 return filp->f_op->setlease(filp, arg, lease, priv);
1766         else
1767                 return generic_setlease(filp, arg, lease, priv);
1768 }
1769 EXPORT_SYMBOL_GPL(vfs_setlease);
1770
1771 static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
1772 {
1773         struct file_lock *fl;
1774         struct fasync_struct *new;
1775         int error;
1776
1777         fl = lease_alloc(filp, arg);
1778         if (IS_ERR(fl))
1779                 return PTR_ERR(fl);
1780
1781         new = fasync_alloc();
1782         if (!new) {
1783                 locks_free_lock(fl);
1784                 return -ENOMEM;
1785         }
1786         new->fa_fd = fd;
1787
1788         error = vfs_setlease(filp, arg, &fl, (void **)&new);
1789         if (fl)
1790                 locks_free_lock(fl);
1791         if (new)
1792                 fasync_free(new);
1793         return error;
1794 }
1795
1796 /**
1797  *      fcntl_setlease  -       sets a lease on an open file
1798  *      @fd: open file descriptor
1799  *      @filp: file pointer
1800  *      @arg: type of lease to obtain
1801  *
1802  *      Call this fcntl to establish a lease on the file.
1803  *      Note that you also need to call %F_SETSIG to
1804  *      receive a signal when the lease is broken.
1805  */
1806 int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1807 {
1808         if (arg == F_UNLCK)
1809                 return vfs_setlease(filp, F_UNLCK, NULL, NULL);
1810         return do_fcntl_add_lease(fd, filp, arg);
1811 }
1812
1813 /**
1814  * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1815  * @filp: The file to apply the lock to
1816  * @fl: The lock to be applied
1817  *
1818  * Add a FLOCK style lock to a file.
1819  */
1820 int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1821 {
1822         int error;
1823         might_sleep();
1824         for (;;) {
1825                 error = flock_lock_file(filp, fl);
1826                 if (error != FILE_LOCK_DEFERRED)
1827                         break;
1828                 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1829                 if (!error)
1830                         continue;
1831
1832                 locks_delete_block(fl);
1833                 break;
1834         }
1835         return error;
1836 }
1837
1838 EXPORT_SYMBOL(flock_lock_file_wait);
1839
1840 /**
1841  *      sys_flock: - flock() system call.
1842  *      @fd: the file descriptor to lock.
1843  *      @cmd: the type of lock to apply.
1844  *
1845  *      Apply a %FL_FLOCK style lock to an open file descriptor.
1846  *      The @cmd can be one of
1847  *
1848  *      %LOCK_SH -- a shared lock.
1849  *
1850  *      %LOCK_EX -- an exclusive lock.
1851  *
1852  *      %LOCK_UN -- remove an existing lock.
1853  *
1854  *      %LOCK_MAND -- a `mandatory' flock.  This exists to emulate Windows Share Modes.
1855  *
1856  *      %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1857  *      processes read and write access respectively.
1858  */
1859 SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
1860 {
1861         struct fd f = fdget(fd);
1862         struct file_lock *lock;
1863         int can_sleep, unlock;
1864         int error;
1865
1866         error = -EBADF;
1867         if (!f.file)
1868                 goto out;
1869
1870         can_sleep = !(cmd & LOCK_NB);
1871         cmd &= ~LOCK_NB;
1872         unlock = (cmd == LOCK_UN);
1873
1874         if (!unlock && !(cmd & LOCK_MAND) &&
1875             !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
1876                 goto out_putf;
1877
1878         error = flock_make_lock(f.file, &lock, cmd);
1879         if (error)
1880                 goto out_putf;
1881         if (can_sleep)
1882                 lock->fl_flags |= FL_SLEEP;
1883
1884         error = security_file_lock(f.file, lock->fl_type);
1885         if (error)
1886                 goto out_free;
1887
1888         if (f.file->f_op->flock)
1889                 error = f.file->f_op->flock(f.file,
1890                                           (can_sleep) ? F_SETLKW : F_SETLK,
1891                                           lock);
1892         else
1893                 error = flock_lock_file_wait(f.file, lock);
1894
1895  out_free:
1896         locks_free_lock(lock);
1897
1898  out_putf:
1899         fdput(f);
1900  out:
1901         return error;
1902 }
1903
1904 /**
1905  * vfs_test_lock - test file byte range lock
1906  * @filp: The file to test lock for
1907  * @fl: The lock to test; also used to hold result
1908  *
1909  * Returns -ERRNO on failure.  Indicates presence of conflicting lock by
1910  * setting conf->fl_type to something other than F_UNLCK.
1911  */
1912 int vfs_test_lock(struct file *filp, struct file_lock *fl)
1913 {
1914         if (filp->f_op->lock)
1915                 return filp->f_op->lock(filp, F_GETLK, fl);
1916         posix_test_lock(filp, fl);
1917         return 0;
1918 }
1919 EXPORT_SYMBOL_GPL(vfs_test_lock);
1920
1921 static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1922 {
1923         flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
1924 #if BITS_PER_LONG == 32
1925         /*
1926          * Make sure we can represent the posix lock via
1927          * legacy 32bit flock.
1928          */
1929         if (fl->fl_start > OFFT_OFFSET_MAX)
1930                 return -EOVERFLOW;
1931         if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1932                 return -EOVERFLOW;
1933 #endif
1934         flock->l_start = fl->fl_start;
1935         flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1936                 fl->fl_end - fl->fl_start + 1;
1937         flock->l_whence = 0;
1938         flock->l_type = fl->fl_type;
1939         return 0;
1940 }
1941
1942 #if BITS_PER_LONG == 32
1943 static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1944 {
1945         flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
1946         flock->l_start = fl->fl_start;
1947         flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1948                 fl->fl_end - fl->fl_start + 1;
1949         flock->l_whence = 0;
1950         flock->l_type = fl->fl_type;
1951 }
1952 #endif
1953
1954 /* Report the first existing lock that would conflict with l.
1955  * This implements the F_GETLK command of fcntl().
1956  */
1957 int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock __user *l)
1958 {
1959         struct file_lock file_lock;
1960         struct flock flock;
1961         int error;
1962
1963         error = -EFAULT;
1964         if (copy_from_user(&flock, l, sizeof(flock)))
1965                 goto out;
1966         error = -EINVAL;
1967         if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1968                 goto out;
1969
1970         error = flock_to_posix_lock(filp, &file_lock, &flock);
1971         if (error)
1972                 goto out;
1973
1974         if (cmd == F_OFD_GETLK) {
1975                 error = -EINVAL;
1976                 if (flock.l_pid != 0)
1977                         goto out;
1978
1979                 cmd = F_GETLK;
1980                 file_lock.fl_flags |= FL_OFDLCK;
1981                 file_lock.fl_owner = filp;
1982         }
1983
1984         error = vfs_test_lock(filp, &file_lock);
1985         if (error)
1986                 goto out;
1987  
1988         flock.l_type = file_lock.fl_type;
1989         if (file_lock.fl_type != F_UNLCK) {
1990                 error = posix_lock_to_flock(&flock, &file_lock);
1991                 if (error)
1992                         goto rel_priv;
1993         }
1994         error = -EFAULT;
1995         if (!copy_to_user(l, &flock, sizeof(flock)))
1996                 error = 0;
1997 rel_priv:
1998         locks_release_private(&file_lock);
1999 out:
2000         return error;
2001 }
2002
2003 /**
2004  * vfs_lock_file - file byte range lock
2005  * @filp: The file to apply the lock to
2006  * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2007  * @fl: The lock to be applied
2008  * @conf: Place to return a copy of the conflicting lock, if found.
2009  *
2010  * A caller that doesn't care about the conflicting lock may pass NULL
2011  * as the final argument.
2012  *
2013  * If the filesystem defines a private ->lock() method, then @conf will
2014  * be left unchanged; so a caller that cares should initialize it to
2015  * some acceptable default.
2016  *
2017  * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2018  * locks, the ->lock() interface may return asynchronously, before the lock has
2019  * been granted or denied by the underlying filesystem, if (and only if)
2020  * lm_grant is set. Callers expecting ->lock() to return asynchronously
2021  * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2022  * the request is for a blocking lock. When ->lock() does return asynchronously,
2023  * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
2024  * request completes.
2025  * If the request is for non-blocking lock the file system should return
2026  * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2027  * with the result. If the request timed out the callback routine will return a
2028  * nonzero return code and the file system should release the lock. The file
2029  * system is also responsible to keep a corresponding posix lock when it
2030  * grants a lock so the VFS can find out which locks are locally held and do
2031  * the correct lock cleanup when required.
2032  * The underlying filesystem must not drop the kernel lock or call
2033  * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
2034  * return code.
2035  */
2036 int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
2037 {
2038         if (filp->f_op->lock)
2039                 return filp->f_op->lock(filp, cmd, fl);
2040         else
2041                 return posix_lock_file(filp, fl, conf);
2042 }
2043 EXPORT_SYMBOL_GPL(vfs_lock_file);
2044
2045 static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2046                              struct file_lock *fl)
2047 {
2048         int error;
2049
2050         error = security_file_lock(filp, fl->fl_type);
2051         if (error)
2052                 return error;
2053
2054         for (;;) {
2055                 error = vfs_lock_file(filp, cmd, fl, NULL);
2056                 if (error != FILE_LOCK_DEFERRED)
2057                         break;
2058                 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
2059                 if (!error)
2060                         continue;
2061
2062                 locks_delete_block(fl);
2063                 break;
2064         }
2065
2066         return error;
2067 }
2068
2069 /* Ensure that fl->fl_filp has compatible f_mode for F_SETLK calls */
2070 static int
2071 check_fmode_for_setlk(struct file_lock *fl)
2072 {
2073         switch (fl->fl_type) {
2074         case F_RDLCK:
2075                 if (!(fl->fl_file->f_mode & FMODE_READ))
2076                         return -EBADF;
2077                 break;
2078         case F_WRLCK:
2079                 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2080                         return -EBADF;
2081         }
2082         return 0;
2083 }
2084
2085 /* Apply the lock described by l to an open file descriptor.
2086  * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2087  */
2088 int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
2089                 struct flock __user *l)
2090 {
2091         struct file_lock *file_lock = locks_alloc_lock();
2092         struct flock flock;
2093         struct inode *inode;
2094         struct file *f;
2095         int error;
2096
2097         if (file_lock == NULL)
2098                 return -ENOLCK;
2099
2100         /*
2101          * This might block, so we do it before checking the inode.
2102          */
2103         error = -EFAULT;
2104         if (copy_from_user(&flock, l, sizeof(flock)))
2105                 goto out;
2106
2107         inode = file_inode(filp);
2108
2109         /* Don't allow mandatory locks on files that may be memory mapped
2110          * and shared.
2111          */
2112         if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
2113                 error = -EAGAIN;
2114                 goto out;
2115         }
2116
2117 again:
2118         error = flock_to_posix_lock(filp, file_lock, &flock);
2119         if (error)
2120                 goto out;
2121
2122         error = check_fmode_for_setlk(file_lock);
2123         if (error)
2124                 goto out;
2125
2126         /*
2127          * If the cmd is requesting file-private locks, then set the
2128          * FL_OFDLCK flag and override the owner.
2129          */
2130         switch (cmd) {
2131         case F_OFD_SETLK:
2132                 error = -EINVAL;
2133                 if (flock.l_pid != 0)
2134                         goto out;
2135
2136                 cmd = F_SETLK;
2137                 file_lock->fl_flags |= FL_OFDLCK;
2138                 file_lock->fl_owner = filp;
2139                 break;
2140         case F_OFD_SETLKW:
2141                 error = -EINVAL;
2142                 if (flock.l_pid != 0)
2143                         goto out;
2144
2145                 cmd = F_SETLKW;
2146                 file_lock->fl_flags |= FL_OFDLCK;
2147                 file_lock->fl_owner = filp;
2148                 /* Fallthrough */
2149         case F_SETLKW:
2150                 file_lock->fl_flags |= FL_SLEEP;
2151         }
2152
2153         error = do_lock_file_wait(filp, cmd, file_lock);
2154
2155         /*
2156          * Attempt to detect a close/fcntl race and recover by
2157          * releasing the lock that was just acquired.
2158          */
2159         /*
2160          * we need that spin_lock here - it prevents reordering between
2161          * update of inode->i_flock and check for it done in close().
2162          * rcu_read_lock() wouldn't do.
2163          */
2164         spin_lock(&current->files->file_lock);
2165         f = fcheck(fd);
2166         spin_unlock(&current->files->file_lock);
2167         if (!error && f != filp && flock.l_type != F_UNLCK) {
2168                 flock.l_type = F_UNLCK;
2169                 goto again;
2170         }
2171
2172 out:
2173         locks_free_lock(file_lock);
2174         return error;
2175 }
2176
2177 #if BITS_PER_LONG == 32
2178 /* Report the first existing lock that would conflict with l.
2179  * This implements the F_GETLK command of fcntl().
2180  */
2181 int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 __user *l)
2182 {
2183         struct file_lock file_lock;
2184         struct flock64 flock;
2185         int error;
2186
2187         error = -EFAULT;
2188         if (copy_from_user(&flock, l, sizeof(flock)))
2189                 goto out;
2190         error = -EINVAL;
2191         if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2192                 goto out;
2193
2194         error = flock64_to_posix_lock(filp, &file_lock, &flock);
2195         if (error)
2196                 goto out;
2197
2198         if (cmd == F_OFD_GETLK) {
2199                 error = -EINVAL;
2200                 if (flock.l_pid != 0)
2201                         goto out;
2202
2203                 cmd = F_GETLK64;
2204                 file_lock.fl_flags |= FL_OFDLCK;
2205                 file_lock.fl_owner = filp;
2206         }
2207
2208         error = vfs_test_lock(filp, &file_lock);
2209         if (error)
2210                 goto out;
2211
2212         flock.l_type = file_lock.fl_type;
2213         if (file_lock.fl_type != F_UNLCK)
2214                 posix_lock_to_flock64(&flock, &file_lock);
2215
2216         error = -EFAULT;
2217         if (!copy_to_user(l, &flock, sizeof(flock)))
2218                 error = 0;
2219
2220         locks_release_private(&file_lock);
2221 out:
2222         return error;
2223 }
2224
2225 /* Apply the lock described by l to an open file descriptor.
2226  * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2227  */
2228 int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2229                 struct flock64 __user *l)
2230 {
2231         struct file_lock *file_lock = locks_alloc_lock();
2232         struct flock64 flock;
2233         struct inode *inode;
2234         struct file *f;
2235         int error;
2236
2237         if (file_lock == NULL)
2238                 return -ENOLCK;
2239
2240         /*
2241          * This might block, so we do it before checking the inode.
2242          */
2243         error = -EFAULT;
2244         if (copy_from_user(&flock, l, sizeof(flock)))
2245                 goto out;
2246
2247         inode = file_inode(filp);
2248
2249         /* Don't allow mandatory locks on files that may be memory mapped
2250          * and shared.
2251          */
2252         if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
2253                 error = -EAGAIN;
2254                 goto out;
2255         }
2256
2257 again:
2258         error = flock64_to_posix_lock(filp, file_lock, &flock);
2259         if (error)
2260                 goto out;
2261
2262         error = check_fmode_for_setlk(file_lock);
2263         if (error)
2264                 goto out;
2265
2266         /*
2267          * If the cmd is requesting file-private locks, then set the
2268          * FL_OFDLCK flag and override the owner.
2269          */
2270         switch (cmd) {
2271         case F_OFD_SETLK:
2272                 error = -EINVAL;
2273                 if (flock.l_pid != 0)
2274                         goto out;
2275
2276                 cmd = F_SETLK64;
2277                 file_lock->fl_flags |= FL_OFDLCK;
2278                 file_lock->fl_owner = filp;
2279                 break;
2280         case F_OFD_SETLKW:
2281                 error = -EINVAL;
2282                 if (flock.l_pid != 0)
2283                         goto out;
2284
2285                 cmd = F_SETLKW64;
2286                 file_lock->fl_flags |= FL_OFDLCK;
2287                 file_lock->fl_owner = filp;
2288                 /* Fallthrough */
2289         case F_SETLKW64:
2290                 file_lock->fl_flags |= FL_SLEEP;
2291         }
2292
2293         error = do_lock_file_wait(filp, cmd, file_lock);
2294
2295         /*
2296          * Attempt to detect a close/fcntl race and recover by
2297          * releasing the lock that was just acquired.
2298          */
2299         spin_lock(&current->files->file_lock);
2300         f = fcheck(fd);
2301         spin_unlock(&current->files->file_lock);
2302         if (!error && f != filp && flock.l_type != F_UNLCK) {
2303                 flock.l_type = F_UNLCK;
2304                 goto again;
2305         }
2306
2307 out:
2308         locks_free_lock(file_lock);
2309         return error;
2310 }
2311 #endif /* BITS_PER_LONG == 32 */
2312
2313 /*
2314  * This function is called when the file is being removed
2315  * from the task's fd array.  POSIX locks belonging to this task
2316  * are deleted at this time.
2317  */
2318 void locks_remove_posix(struct file *filp, fl_owner_t owner)
2319 {
2320         struct file_lock lock;
2321
2322         /*
2323          * If there are no locks held on this file, we don't need to call
2324          * posix_lock_file().  Another process could be setting a lock on this
2325          * file at the same time, but we wouldn't remove that lock anyway.
2326          */
2327         if (!file_inode(filp)->i_flock)
2328                 return;
2329
2330         lock.fl_type = F_UNLCK;
2331         lock.fl_flags = FL_POSIX | FL_CLOSE;
2332         lock.fl_start = 0;
2333         lock.fl_end = OFFSET_MAX;
2334         lock.fl_owner = owner;
2335         lock.fl_pid = current->tgid;
2336         lock.fl_file = filp;
2337         lock.fl_ops = NULL;
2338         lock.fl_lmops = NULL;
2339
2340         vfs_lock_file(filp, F_SETLK, &lock, NULL);
2341
2342         if (lock.fl_ops && lock.fl_ops->fl_release_private)
2343                 lock.fl_ops->fl_release_private(&lock);
2344 }
2345
2346 EXPORT_SYMBOL(locks_remove_posix);
2347
2348 /*
2349  * This function is called on the last close of an open file.
2350  */
2351 void locks_remove_file(struct file *filp)
2352 {
2353         struct inode * inode = file_inode(filp);
2354         struct file_lock *fl;
2355         struct file_lock **before;
2356         LIST_HEAD(dispose);
2357
2358         if (!inode->i_flock)
2359                 return;
2360
2361         locks_remove_posix(filp, filp);
2362
2363         if (filp->f_op->flock) {
2364                 struct file_lock fl = {
2365                         .fl_owner = filp,
2366                         .fl_pid = current->tgid,
2367                         .fl_file = filp,
2368                         .fl_flags = FL_FLOCK,
2369                         .fl_type = F_UNLCK,
2370                         .fl_end = OFFSET_MAX,
2371                 };
2372                 filp->f_op->flock(filp, F_SETLKW, &fl);
2373                 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2374                         fl.fl_ops->fl_release_private(&fl);
2375         }
2376
2377         spin_lock(&inode->i_lock);
2378         before = &inode->i_flock;
2379
2380         while ((fl = *before) != NULL) {
2381                 if (fl->fl_file == filp) {
2382                         if (IS_LEASE(fl)) {
2383                                 lease_modify(before, F_UNLCK, &dispose);
2384                                 continue;
2385                         }
2386
2387                         /*
2388                          * There's a leftover lock on the list of a type that
2389                          * we didn't expect to see. Most likely a classic
2390                          * POSIX lock that ended up not getting released
2391                          * properly, or that raced onto the list somehow. Log
2392                          * some info about it and then just remove it from
2393                          * the list.
2394                          */
2395                         WARN(!IS_FLOCK(fl),
2396                                 "leftover lock: dev=%u:%u ino=%lu type=%hhd flags=0x%x start=%lld end=%lld\n",
2397                                 MAJOR(inode->i_sb->s_dev),
2398                                 MINOR(inode->i_sb->s_dev), inode->i_ino,
2399                                 fl->fl_type, fl->fl_flags,
2400                                 fl->fl_start, fl->fl_end);
2401
2402                         locks_delete_lock(before, &dispose);
2403                         continue;
2404                 }
2405                 before = &fl->fl_next;
2406         }
2407         spin_unlock(&inode->i_lock);
2408         locks_dispose_list(&dispose);
2409 }
2410
2411 /**
2412  *      posix_unblock_lock - stop waiting for a file lock
2413  *      @waiter: the lock which was waiting
2414  *
2415  *      lockd needs to block waiting for locks.
2416  */
2417 int
2418 posix_unblock_lock(struct file_lock *waiter)
2419 {
2420         int status = 0;
2421
2422         spin_lock(&blocked_lock_lock);
2423         if (waiter->fl_next)
2424                 __locks_delete_block(waiter);
2425         else
2426                 status = -ENOENT;
2427         spin_unlock(&blocked_lock_lock);
2428         return status;
2429 }
2430 EXPORT_SYMBOL(posix_unblock_lock);
2431
2432 /**
2433  * vfs_cancel_lock - file byte range unblock lock
2434  * @filp: The file to apply the unblock to
2435  * @fl: The lock to be unblocked
2436  *
2437  * Used by lock managers to cancel blocked requests
2438  */
2439 int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2440 {
2441         if (filp->f_op->lock)
2442                 return filp->f_op->lock(filp, F_CANCELLK, fl);
2443         return 0;
2444 }
2445
2446 EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2447
2448 #ifdef CONFIG_PROC_FS
2449 #include <linux/proc_fs.h>
2450 #include <linux/seq_file.h>
2451
2452 struct locks_iterator {
2453         int     li_cpu;
2454         loff_t  li_pos;
2455 };
2456
2457 static void lock_get_status(struct seq_file *f, struct file_lock *fl,
2458                             loff_t id, char *pfx)
2459 {
2460         struct inode *inode = NULL;
2461         unsigned int fl_pid;
2462
2463         if (fl->fl_nspid)
2464                 fl_pid = pid_vnr(fl->fl_nspid);
2465         else
2466                 fl_pid = fl->fl_pid;
2467
2468         if (fl->fl_file != NULL)
2469                 inode = file_inode(fl->fl_file);
2470
2471         seq_printf(f, "%lld:%s ", id, pfx);
2472         if (IS_POSIX(fl)) {
2473                 if (fl->fl_flags & FL_ACCESS)
2474                         seq_puts(f, "ACCESS");
2475                 else if (IS_OFDLCK(fl))
2476                         seq_puts(f, "OFDLCK");
2477                 else
2478                         seq_puts(f, "POSIX ");
2479
2480                 seq_printf(f, " %s ",
2481                              (inode == NULL) ? "*NOINODE*" :
2482                              mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
2483         } else if (IS_FLOCK(fl)) {
2484                 if (fl->fl_type & LOCK_MAND) {
2485                         seq_puts(f, "FLOCK  MSNFS     ");
2486                 } else {
2487                         seq_puts(f, "FLOCK  ADVISORY  ");
2488                 }
2489         } else if (IS_LEASE(fl)) {
2490                 if (fl->fl_flags & FL_DELEG)
2491                         seq_puts(f, "DELEG  ");
2492                 else
2493                         seq_puts(f, "LEASE  ");
2494
2495                 if (lease_breaking(fl))
2496                         seq_puts(f, "BREAKING  ");
2497                 else if (fl->fl_file)
2498                         seq_puts(f, "ACTIVE    ");
2499                 else
2500                         seq_puts(f, "BREAKER   ");
2501         } else {
2502                 seq_puts(f, "UNKNOWN UNKNOWN  ");
2503         }
2504         if (fl->fl_type & LOCK_MAND) {
2505                 seq_printf(f, "%s ",
2506                                (fl->fl_type & LOCK_READ)
2507                                ? (fl->fl_type & LOCK_WRITE) ? "RW   " : "READ "
2508                                : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2509         } else {
2510                 seq_printf(f, "%s ",
2511                                (lease_breaking(fl))
2512                                ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2513                                : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
2514         }
2515         if (inode) {
2516 #ifdef WE_CAN_BREAK_LSLK_NOW
2517                 seq_printf(f, "%d %s:%ld ", fl_pid,
2518                                 inode->i_sb->s_id, inode->i_ino);
2519 #else
2520                 /* userspace relies on this representation of dev_t ;-( */
2521                 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
2522                                 MAJOR(inode->i_sb->s_dev),
2523                                 MINOR(inode->i_sb->s_dev), inode->i_ino);
2524 #endif
2525         } else {
2526                 seq_printf(f, "%d <none>:0 ", fl_pid);
2527         }
2528         if (IS_POSIX(fl)) {
2529                 if (fl->fl_end == OFFSET_MAX)
2530                         seq_printf(f, "%Ld EOF\n", fl->fl_start);
2531                 else
2532                         seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
2533         } else {
2534                 seq_puts(f, "0 EOF\n");
2535         }
2536 }
2537
2538 static int locks_show(struct seq_file *f, void *v)
2539 {
2540         struct locks_iterator *iter = f->private;
2541         struct file_lock *fl, *bfl;
2542
2543         fl = hlist_entry(v, struct file_lock, fl_link);
2544
2545         lock_get_status(f, fl, iter->li_pos, "");
2546
2547         list_for_each_entry(bfl, &fl->fl_block, fl_block)
2548                 lock_get_status(f, bfl, iter->li_pos, " ->");
2549
2550         return 0;
2551 }
2552
2553 static void *locks_start(struct seq_file *f, loff_t *pos)
2554         __acquires(&blocked_lock_lock)
2555 {
2556         struct locks_iterator *iter = f->private;
2557
2558         iter->li_pos = *pos + 1;
2559         lg_global_lock(&file_lock_lglock);
2560         spin_lock(&blocked_lock_lock);
2561         return seq_hlist_start_percpu(&file_lock_list, &iter->li_cpu, *pos);
2562 }
2563
2564 static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2565 {
2566         struct locks_iterator *iter = f->private;
2567
2568         ++iter->li_pos;
2569         return seq_hlist_next_percpu(v, &file_lock_list, &iter->li_cpu, pos);
2570 }
2571
2572 static void locks_stop(struct seq_file *f, void *v)
2573         __releases(&blocked_lock_lock)
2574 {
2575         spin_unlock(&blocked_lock_lock);
2576         lg_global_unlock(&file_lock_lglock);
2577 }
2578
2579 static const struct seq_operations locks_seq_operations = {
2580         .start  = locks_start,
2581         .next   = locks_next,
2582         .stop   = locks_stop,
2583         .show   = locks_show,
2584 };
2585
2586 static int locks_open(struct inode *inode, struct file *filp)
2587 {
2588         return seq_open_private(filp, &locks_seq_operations,
2589                                         sizeof(struct locks_iterator));
2590 }
2591
2592 static const struct file_operations proc_locks_operations = {
2593         .open           = locks_open,
2594         .read           = seq_read,
2595         .llseek         = seq_lseek,
2596         .release        = seq_release_private,
2597 };
2598
2599 static int __init proc_locks_init(void)
2600 {
2601         proc_create("locks", 0, NULL, &proc_locks_operations);
2602         return 0;
2603 }
2604 module_init(proc_locks_init);
2605 #endif
2606
2607 static int __init filelock_init(void)
2608 {
2609         int i;
2610
2611         filelock_cache = kmem_cache_create("file_lock_cache",
2612                         sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2613
2614         lg_lock_init(&file_lock_lglock, "file_lock_lglock");
2615
2616         for_each_possible_cpu(i)
2617                 INIT_HLIST_HEAD(per_cpu_ptr(&file_lock_list, i));
2618
2619         return 0;
2620 }
2621
2622 core_initcall(filelock_init);