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