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