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