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