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