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