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