]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - fs/locks.c
locks: update comments that refer to inode->i_flock
[mirror_ubuntu-artful-kernel.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))
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, int *counter,
685 struct list_head *before)
686 {
687 fl->fl_nspid = get_pid(task_tgid(current));
688 list_add_tail(&fl->fl_list, before);
689 ++*counter;
690 locks_insert_global_locks(fl);
691 }
692
693 static void
694 locks_unlink_lock_ctx(struct file_lock *fl, int *counter)
695 {
696 locks_delete_global_locks(fl);
697 list_del_init(&fl->fl_list);
698 --*counter;
699 if (fl->fl_nspid) {
700 put_pid(fl->fl_nspid);
701 fl->fl_nspid = NULL;
702 }
703 locks_wake_up_blocks(fl);
704 }
705
706 static void
707 locks_delete_lock_ctx(struct file_lock *fl, int *counter,
708 struct list_head *dispose)
709 {
710 locks_unlink_lock_ctx(fl, counter);
711 if (dispose)
712 list_add(&fl->fl_list, dispose);
713 else
714 locks_free_lock(fl);
715 }
716
717 /* Determine if lock sys_fl blocks lock caller_fl. Common functionality
718 * checks for shared/exclusive status of overlapping locks.
719 */
720 static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
721 {
722 if (sys_fl->fl_type == F_WRLCK)
723 return 1;
724 if (caller_fl->fl_type == F_WRLCK)
725 return 1;
726 return 0;
727 }
728
729 /* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
730 * checking before calling the locks_conflict().
731 */
732 static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
733 {
734 /* POSIX locks owned by the same process do not conflict with
735 * each other.
736 */
737 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
738 return (0);
739
740 /* Check whether they overlap */
741 if (!locks_overlap(caller_fl, sys_fl))
742 return 0;
743
744 return (locks_conflict(caller_fl, sys_fl));
745 }
746
747 /* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
748 * checking before calling the locks_conflict().
749 */
750 static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
751 {
752 /* FLOCK locks referring to the same filp do not conflict with
753 * each other.
754 */
755 if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
756 return (0);
757 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
758 return 0;
759
760 return (locks_conflict(caller_fl, sys_fl));
761 }
762
763 void
764 posix_test_lock(struct file *filp, struct file_lock *fl)
765 {
766 struct file_lock *cfl;
767 struct file_lock_context *ctx;
768 struct inode *inode = file_inode(filp);
769
770 ctx = inode->i_flctx;
771 if (!ctx || list_empty_careful(&ctx->flc_posix)) {
772 fl->fl_type = F_UNLCK;
773 return;
774 }
775
776 spin_lock(&ctx->flc_lock);
777 list_for_each_entry(cfl, &ctx->flc_posix, fl_list) {
778 if (posix_locks_conflict(fl, cfl)) {
779 locks_copy_conflock(fl, cfl);
780 if (cfl->fl_nspid)
781 fl->fl_pid = pid_vnr(cfl->fl_nspid);
782 goto out;
783 }
784 }
785 fl->fl_type = F_UNLCK;
786 out:
787 spin_unlock(&ctx->flc_lock);
788 return;
789 }
790 EXPORT_SYMBOL(posix_test_lock);
791
792 /*
793 * Deadlock detection:
794 *
795 * We attempt to detect deadlocks that are due purely to posix file
796 * locks.
797 *
798 * We assume that a task can be waiting for at most one lock at a time.
799 * So for any acquired lock, the process holding that lock may be
800 * waiting on at most one other lock. That lock in turns may be held by
801 * someone waiting for at most one other lock. Given a requested lock
802 * caller_fl which is about to wait for a conflicting lock block_fl, we
803 * follow this chain of waiters to ensure we are not about to create a
804 * cycle.
805 *
806 * Since we do this before we ever put a process to sleep on a lock, we
807 * are ensured that there is never a cycle; that is what guarantees that
808 * the while() loop in posix_locks_deadlock() eventually completes.
809 *
810 * Note: the above assumption may not be true when handling lock
811 * requests from a broken NFS client. It may also fail in the presence
812 * of tasks (such as posix threads) sharing the same open file table.
813 * To handle those cases, we just bail out after a few iterations.
814 *
815 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
816 * Because the owner is not even nominally tied to a thread of
817 * execution, the deadlock detection below can't reasonably work well. Just
818 * skip it for those.
819 *
820 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
821 * locks that just checks for the case where two tasks are attempting to
822 * upgrade from read to write locks on the same inode.
823 */
824
825 #define MAX_DEADLK_ITERATIONS 10
826
827 /* Find a lock that the owner of the given block_fl is blocking on. */
828 static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
829 {
830 struct file_lock *fl;
831
832 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
833 if (posix_same_owner(fl, block_fl))
834 return fl->fl_next;
835 }
836 return NULL;
837 }
838
839 /* Must be called with the blocked_lock_lock held! */
840 static int posix_locks_deadlock(struct file_lock *caller_fl,
841 struct file_lock *block_fl)
842 {
843 int i = 0;
844
845 /*
846 * This deadlock detector can't reasonably detect deadlocks with
847 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
848 */
849 if (IS_OFDLCK(caller_fl))
850 return 0;
851
852 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
853 if (i++ > MAX_DEADLK_ITERATIONS)
854 return 0;
855 if (posix_same_owner(caller_fl, block_fl))
856 return 1;
857 }
858 return 0;
859 }
860
861 /* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
862 * after any leases, but before any posix locks.
863 *
864 * Note that if called with an FL_EXISTS argument, the caller may determine
865 * whether or not a lock was successfully freed by testing the return
866 * value for -ENOENT.
867 */
868 static int flock_lock_file(struct file *filp, struct file_lock *request)
869 {
870 struct file_lock *new_fl = NULL;
871 struct file_lock *fl;
872 struct file_lock_context *ctx;
873 struct inode *inode = file_inode(filp);
874 int error = 0;
875 bool found = false;
876 LIST_HEAD(dispose);
877
878 ctx = locks_get_lock_context(inode);
879 if (!ctx)
880 return -ENOMEM;
881
882 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
883 new_fl = locks_alloc_lock();
884 if (!new_fl)
885 return -ENOMEM;
886 }
887
888 spin_lock(&ctx->flc_lock);
889 if (request->fl_flags & FL_ACCESS)
890 goto find_conflict;
891
892 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
893 if (filp != fl->fl_file)
894 continue;
895 if (request->fl_type == fl->fl_type)
896 goto out;
897 found = true;
898 locks_delete_lock_ctx(fl, &ctx->flc_flock_cnt, &dispose);
899 break;
900 }
901
902 if (request->fl_type == F_UNLCK) {
903 if ((request->fl_flags & FL_EXISTS) && !found)
904 error = -ENOENT;
905 goto out;
906 }
907
908 /*
909 * If a higher-priority process was blocked on the old file lock,
910 * give it the opportunity to lock the file.
911 */
912 if (found) {
913 spin_unlock(&ctx->flc_lock);
914 cond_resched();
915 spin_lock(&ctx->flc_lock);
916 }
917
918 find_conflict:
919 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
920 if (!flock_locks_conflict(request, fl))
921 continue;
922 error = -EAGAIN;
923 if (!(request->fl_flags & FL_SLEEP))
924 goto out;
925 error = FILE_LOCK_DEFERRED;
926 locks_insert_block(fl, request);
927 goto out;
928 }
929 if (request->fl_flags & FL_ACCESS)
930 goto out;
931 locks_copy_lock(new_fl, request);
932 locks_insert_lock_ctx(new_fl, &ctx->flc_flock_cnt, &ctx->flc_flock);
933 new_fl = NULL;
934 error = 0;
935
936 out:
937 spin_unlock(&ctx->flc_lock);
938 if (new_fl)
939 locks_free_lock(new_fl);
940 locks_dispose_list(&dispose);
941 return error;
942 }
943
944 static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
945 {
946 struct file_lock *fl, *tmp;
947 struct file_lock *new_fl = NULL;
948 struct file_lock *new_fl2 = NULL;
949 struct file_lock *left = NULL;
950 struct file_lock *right = NULL;
951 struct file_lock_context *ctx;
952 int error;
953 bool added = false;
954 LIST_HEAD(dispose);
955
956 ctx = locks_get_lock_context(inode);
957 if (!ctx)
958 return -ENOMEM;
959
960 /*
961 * We may need two file_lock structures for this operation,
962 * so we get them in advance to avoid races.
963 *
964 * In some cases we can be sure, that no new locks will be needed
965 */
966 if (!(request->fl_flags & FL_ACCESS) &&
967 (request->fl_type != F_UNLCK ||
968 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
969 new_fl = locks_alloc_lock();
970 new_fl2 = locks_alloc_lock();
971 }
972
973 spin_lock(&ctx->flc_lock);
974 /*
975 * New lock request. Walk all POSIX locks and look for conflicts. If
976 * there are any, either return error or put the request on the
977 * blocker's list of waiters and the global blocked_hash.
978 */
979 if (request->fl_type != F_UNLCK) {
980 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
981 if (!IS_POSIX(fl))
982 continue;
983 if (!posix_locks_conflict(request, fl))
984 continue;
985 if (conflock)
986 locks_copy_conflock(conflock, fl);
987 error = -EAGAIN;
988 if (!(request->fl_flags & FL_SLEEP))
989 goto out;
990 /*
991 * Deadlock detection and insertion into the blocked
992 * locks list must be done while holding the same lock!
993 */
994 error = -EDEADLK;
995 spin_lock(&blocked_lock_lock);
996 if (likely(!posix_locks_deadlock(request, fl))) {
997 error = FILE_LOCK_DEFERRED;
998 __locks_insert_block(fl, request);
999 }
1000 spin_unlock(&blocked_lock_lock);
1001 goto out;
1002 }
1003 }
1004
1005 /* If we're just looking for a conflict, we're done. */
1006 error = 0;
1007 if (request->fl_flags & FL_ACCESS)
1008 goto out;
1009
1010 /* Find the first old lock with the same owner as the new lock */
1011 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1012 if (posix_same_owner(request, fl))
1013 break;
1014 }
1015
1016 /* Process locks with this owner. */
1017 list_for_each_entry_safe_from(fl, tmp, &ctx->flc_posix, fl_list) {
1018 if (!posix_same_owner(request, fl))
1019 break;
1020
1021 /* Detect adjacent or overlapping regions (if same lock type) */
1022 if (request->fl_type == fl->fl_type) {
1023 /* In all comparisons of start vs end, use
1024 * "start - 1" rather than "end + 1". If end
1025 * is OFFSET_MAX, end + 1 will become negative.
1026 */
1027 if (fl->fl_end < request->fl_start - 1)
1028 continue;
1029 /* If the next lock in the list has entirely bigger
1030 * addresses than the new one, insert the lock here.
1031 */
1032 if (fl->fl_start - 1 > request->fl_end)
1033 break;
1034
1035 /* If we come here, the new and old lock are of the
1036 * same type and adjacent or overlapping. Make one
1037 * lock yielding from the lower start address of both
1038 * locks to the higher end address.
1039 */
1040 if (fl->fl_start > request->fl_start)
1041 fl->fl_start = request->fl_start;
1042 else
1043 request->fl_start = fl->fl_start;
1044 if (fl->fl_end < request->fl_end)
1045 fl->fl_end = request->fl_end;
1046 else
1047 request->fl_end = fl->fl_end;
1048 if (added) {
1049 locks_delete_lock_ctx(fl, &ctx->flc_posix_cnt,
1050 &dispose);
1051 continue;
1052 }
1053 request = fl;
1054 added = true;
1055 } else {
1056 /* Processing for different lock types is a bit
1057 * more complex.
1058 */
1059 if (fl->fl_end < request->fl_start)
1060 continue;
1061 if (fl->fl_start > request->fl_end)
1062 break;
1063 if (request->fl_type == F_UNLCK)
1064 added = true;
1065 if (fl->fl_start < request->fl_start)
1066 left = fl;
1067 /* If the next lock in the list has a higher end
1068 * address than the new one, insert the new one here.
1069 */
1070 if (fl->fl_end > request->fl_end) {
1071 right = fl;
1072 break;
1073 }
1074 if (fl->fl_start >= request->fl_start) {
1075 /* The new lock completely replaces an old
1076 * one (This may happen several times).
1077 */
1078 if (added) {
1079 locks_delete_lock_ctx(fl,
1080 &ctx->flc_posix_cnt, &dispose);
1081 continue;
1082 }
1083 /*
1084 * Replace the old lock with new_fl, and
1085 * remove the old one. It's safe to do the
1086 * insert here since we know that we won't be
1087 * using new_fl later, and that the lock is
1088 * just replacing an existing lock.
1089 */
1090 error = -ENOLCK;
1091 if (!new_fl)
1092 goto out;
1093 locks_copy_lock(new_fl, request);
1094 request = new_fl;
1095 new_fl = NULL;
1096 locks_insert_lock_ctx(request,
1097 &ctx->flc_posix_cnt, &fl->fl_list);
1098 locks_delete_lock_ctx(fl,
1099 &ctx->flc_posix_cnt, &dispose);
1100 added = true;
1101 }
1102 }
1103 }
1104
1105 /*
1106 * The above code only modifies existing locks in case of merging or
1107 * replacing. If new lock(s) need to be inserted all modifications are
1108 * done below this, so it's safe yet to bail out.
1109 */
1110 error = -ENOLCK; /* "no luck" */
1111 if (right && left == right && !new_fl2)
1112 goto out;
1113
1114 error = 0;
1115 if (!added) {
1116 if (request->fl_type == F_UNLCK) {
1117 if (request->fl_flags & FL_EXISTS)
1118 error = -ENOENT;
1119 goto out;
1120 }
1121
1122 if (!new_fl) {
1123 error = -ENOLCK;
1124 goto out;
1125 }
1126 locks_copy_lock(new_fl, request);
1127 locks_insert_lock_ctx(new_fl, &ctx->flc_posix_cnt,
1128 &fl->fl_list);
1129 new_fl = NULL;
1130 }
1131 if (right) {
1132 if (left == right) {
1133 /* The new lock breaks the old one in two pieces,
1134 * so we have to use the second new lock.
1135 */
1136 left = new_fl2;
1137 new_fl2 = NULL;
1138 locks_copy_lock(left, right);
1139 locks_insert_lock_ctx(left, &ctx->flc_posix_cnt,
1140 &fl->fl_list);
1141 }
1142 right->fl_start = request->fl_end + 1;
1143 locks_wake_up_blocks(right);
1144 }
1145 if (left) {
1146 left->fl_end = request->fl_start - 1;
1147 locks_wake_up_blocks(left);
1148 }
1149 out:
1150 spin_unlock(&ctx->flc_lock);
1151 /*
1152 * Free any unused locks.
1153 */
1154 if (new_fl)
1155 locks_free_lock(new_fl);
1156 if (new_fl2)
1157 locks_free_lock(new_fl2);
1158 locks_dispose_list(&dispose);
1159 return error;
1160 }
1161
1162 /**
1163 * posix_lock_file - 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 * @conflock: Place to return a copy of the conflicting lock, if found.
1167 *
1168 * Add a POSIX style lock to a file.
1169 * We merge adjacent & overlapping locks whenever possible.
1170 * POSIX locks are sorted by owner task, then by starting address
1171 *
1172 * Note that if called with an FL_EXISTS argument, the caller may determine
1173 * whether or not a lock was successfully freed by testing the return
1174 * value for -ENOENT.
1175 */
1176 int posix_lock_file(struct file *filp, struct file_lock *fl,
1177 struct file_lock *conflock)
1178 {
1179 return __posix_lock_file(file_inode(filp), fl, conflock);
1180 }
1181 EXPORT_SYMBOL(posix_lock_file);
1182
1183 /**
1184 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1185 * @filp: The file to apply the lock to
1186 * @fl: The lock to be applied
1187 *
1188 * Add a POSIX style lock to a file.
1189 * We merge adjacent & overlapping locks whenever possible.
1190 * POSIX locks are sorted by owner task, then by starting address
1191 */
1192 int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1193 {
1194 int error;
1195 might_sleep ();
1196 for (;;) {
1197 error = posix_lock_file(filp, fl, NULL);
1198 if (error != FILE_LOCK_DEFERRED)
1199 break;
1200 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1201 if (!error)
1202 continue;
1203
1204 locks_delete_block(fl);
1205 break;
1206 }
1207 return error;
1208 }
1209 EXPORT_SYMBOL(posix_lock_file_wait);
1210
1211 /**
1212 * locks_mandatory_locked - Check for an active lock
1213 * @file: the file to check
1214 *
1215 * Searches the inode's list of locks to find any POSIX locks which conflict.
1216 * This function is called from locks_verify_locked() only.
1217 */
1218 int locks_mandatory_locked(struct file *file)
1219 {
1220 int ret;
1221 struct inode *inode = file_inode(file);
1222 struct file_lock_context *ctx;
1223 struct file_lock *fl;
1224
1225 ctx = inode->i_flctx;
1226 if (!ctx || list_empty_careful(&ctx->flc_posix))
1227 return 0;
1228
1229 /*
1230 * Search the lock list for this inode for any POSIX locks.
1231 */
1232 spin_lock(&ctx->flc_lock);
1233 ret = 0;
1234 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1235 if (fl->fl_owner != current->files &&
1236 fl->fl_owner != file) {
1237 ret = -EAGAIN;
1238 break;
1239 }
1240 }
1241 spin_unlock(&ctx->flc_lock);
1242 return ret;
1243 }
1244
1245 /**
1246 * locks_mandatory_area - Check for a conflicting lock
1247 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1248 * for shared
1249 * @inode: the file to check
1250 * @filp: how the file was opened (if it was)
1251 * @offset: start of area to check
1252 * @count: length of area to check
1253 *
1254 * Searches the inode's list of locks to find any POSIX locks which conflict.
1255 * This function is called from rw_verify_area() and
1256 * locks_verify_truncate().
1257 */
1258 int locks_mandatory_area(int read_write, struct inode *inode,
1259 struct file *filp, loff_t offset,
1260 size_t count)
1261 {
1262 struct file_lock fl;
1263 int error;
1264 bool sleep = false;
1265
1266 locks_init_lock(&fl);
1267 fl.fl_pid = current->tgid;
1268 fl.fl_file = filp;
1269 fl.fl_flags = FL_POSIX | FL_ACCESS;
1270 if (filp && !(filp->f_flags & O_NONBLOCK))
1271 sleep = true;
1272 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1273 fl.fl_start = offset;
1274 fl.fl_end = offset + count - 1;
1275
1276 for (;;) {
1277 if (filp) {
1278 fl.fl_owner = filp;
1279 fl.fl_flags &= ~FL_SLEEP;
1280 error = __posix_lock_file(inode, &fl, NULL);
1281 if (!error)
1282 break;
1283 }
1284
1285 if (sleep)
1286 fl.fl_flags |= FL_SLEEP;
1287 fl.fl_owner = current->files;
1288 error = __posix_lock_file(inode, &fl, NULL);
1289 if (error != FILE_LOCK_DEFERRED)
1290 break;
1291 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1292 if (!error) {
1293 /*
1294 * If we've been sleeping someone might have
1295 * changed the permissions behind our back.
1296 */
1297 if (__mandatory_lock(inode))
1298 continue;
1299 }
1300
1301 locks_delete_block(&fl);
1302 break;
1303 }
1304
1305 return error;
1306 }
1307
1308 EXPORT_SYMBOL(locks_mandatory_area);
1309
1310 static void lease_clear_pending(struct file_lock *fl, int arg)
1311 {
1312 switch (arg) {
1313 case F_UNLCK:
1314 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1315 /* fall through: */
1316 case F_RDLCK:
1317 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1318 }
1319 }
1320
1321 /* We already had a lease on this file; just change its type */
1322 int lease_modify(struct file_lock *fl, int arg, struct list_head *dispose)
1323 {
1324 struct file_lock_context *flctx;
1325 int error = assign_type(fl, arg);
1326
1327 if (error)
1328 return error;
1329 lease_clear_pending(fl, arg);
1330 locks_wake_up_blocks(fl);
1331 if (arg == F_UNLCK) {
1332 struct file *filp = fl->fl_file;
1333
1334 flctx = file_inode(filp)->i_flctx;
1335 f_delown(filp);
1336 filp->f_owner.signum = 0;
1337 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1338 if (fl->fl_fasync != NULL) {
1339 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1340 fl->fl_fasync = NULL;
1341 }
1342 locks_delete_lock_ctx(fl, &flctx->flc_lease_cnt, dispose);
1343 }
1344 return 0;
1345 }
1346 EXPORT_SYMBOL(lease_modify);
1347
1348 static bool past_time(unsigned long then)
1349 {
1350 if (!then)
1351 /* 0 is a special value meaning "this never expires": */
1352 return false;
1353 return time_after(jiffies, then);
1354 }
1355
1356 static void time_out_leases(struct inode *inode, struct list_head *dispose)
1357 {
1358 struct file_lock_context *ctx = inode->i_flctx;
1359 struct file_lock *fl, *tmp;
1360
1361 lockdep_assert_held(&ctx->flc_lock);
1362
1363 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
1364 trace_time_out_leases(inode, fl);
1365 if (past_time(fl->fl_downgrade_time))
1366 lease_modify(fl, F_RDLCK, dispose);
1367 if (past_time(fl->fl_break_time))
1368 lease_modify(fl, F_UNLCK, dispose);
1369 }
1370 }
1371
1372 static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1373 {
1374 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1375 return false;
1376 return locks_conflict(breaker, lease);
1377 }
1378
1379 static bool
1380 any_leases_conflict(struct inode *inode, struct file_lock *breaker)
1381 {
1382 struct file_lock_context *ctx = inode->i_flctx;
1383 struct file_lock *fl;
1384
1385 lockdep_assert_held(&ctx->flc_lock);
1386
1387 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1388 if (leases_conflict(fl, breaker))
1389 return true;
1390 }
1391 return false;
1392 }
1393
1394 /**
1395 * __break_lease - revoke all outstanding leases on file
1396 * @inode: the inode of the file to return
1397 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1398 * break all leases
1399 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1400 * only delegations
1401 *
1402 * break_lease (inlined for speed) has checked there already is at least
1403 * some kind of lock (maybe a lease) on this file. Leases are broken on
1404 * a call to open() or truncate(). This function can sleep unless you
1405 * specified %O_NONBLOCK to your open().
1406 */
1407 int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1408 {
1409 int error = 0;
1410 struct file_lock *new_fl;
1411 struct file_lock_context *ctx = inode->i_flctx;
1412 struct file_lock *fl;
1413 unsigned long break_time;
1414 int want_write = (mode & O_ACCMODE) != O_RDONLY;
1415 LIST_HEAD(dispose);
1416
1417 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
1418 if (IS_ERR(new_fl))
1419 return PTR_ERR(new_fl);
1420 new_fl->fl_flags = type;
1421
1422 /* typically we will check that ctx is non-NULL before calling */
1423 if (!ctx) {
1424 WARN_ON_ONCE(1);
1425 return error;
1426 }
1427
1428 spin_lock(&ctx->flc_lock);
1429
1430 time_out_leases(inode, &dispose);
1431
1432 if (!any_leases_conflict(inode, new_fl))
1433 goto out;
1434
1435 break_time = 0;
1436 if (lease_break_time > 0) {
1437 break_time = jiffies + lease_break_time * HZ;
1438 if (break_time == 0)
1439 break_time++; /* so that 0 means no break time */
1440 }
1441
1442 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1443 if (!leases_conflict(fl, new_fl))
1444 continue;
1445 if (want_write) {
1446 if (fl->fl_flags & FL_UNLOCK_PENDING)
1447 continue;
1448 fl->fl_flags |= FL_UNLOCK_PENDING;
1449 fl->fl_break_time = break_time;
1450 } else {
1451 if (lease_breaking(fl))
1452 continue;
1453 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1454 fl->fl_downgrade_time = break_time;
1455 }
1456 if (fl->fl_lmops->lm_break(fl))
1457 locks_delete_lock_ctx(fl, &ctx->flc_lease_cnt,
1458 &dispose);
1459 }
1460
1461 if (list_empty(&ctx->flc_lease))
1462 goto out;
1463
1464 if (mode & O_NONBLOCK) {
1465 trace_break_lease_noblock(inode, new_fl);
1466 error = -EWOULDBLOCK;
1467 goto out;
1468 }
1469
1470 restart:
1471 fl = list_first_entry(&ctx->flc_lease, struct file_lock, fl_list);
1472 break_time = fl->fl_break_time;
1473 if (break_time != 0)
1474 break_time -= jiffies;
1475 if (break_time == 0)
1476 break_time++;
1477 locks_insert_block(fl, new_fl);
1478 trace_break_lease_block(inode, new_fl);
1479 spin_unlock(&ctx->flc_lock);
1480 locks_dispose_list(&dispose);
1481 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1482 !new_fl->fl_next, break_time);
1483 spin_lock(&ctx->flc_lock);
1484 trace_break_lease_unblock(inode, new_fl);
1485 locks_delete_block(new_fl);
1486 if (error >= 0) {
1487 /*
1488 * Wait for the next conflicting lease that has not been
1489 * broken yet
1490 */
1491 if (error == 0)
1492 time_out_leases(inode, &dispose);
1493 if (any_leases_conflict(inode, new_fl))
1494 goto restart;
1495 error = 0;
1496 }
1497 out:
1498 spin_unlock(&ctx->flc_lock);
1499 locks_dispose_list(&dispose);
1500 locks_free_lock(new_fl);
1501 return error;
1502 }
1503
1504 EXPORT_SYMBOL(__break_lease);
1505
1506 /**
1507 * lease_get_mtime - get the last modified time of an inode
1508 * @inode: the inode
1509 * @time: pointer to a timespec which will contain the last modified time
1510 *
1511 * This is to force NFS clients to flush their caches for files with
1512 * exclusive leases. The justification is that if someone has an
1513 * exclusive lease, then they could be modifying it.
1514 */
1515 void lease_get_mtime(struct inode *inode, struct timespec *time)
1516 {
1517 bool has_lease = false;
1518 struct file_lock_context *ctx = inode->i_flctx;
1519 struct file_lock *fl;
1520
1521 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
1522 spin_lock(&ctx->flc_lock);
1523 if (!list_empty(&ctx->flc_lease)) {
1524 fl = list_first_entry(&ctx->flc_lease,
1525 struct file_lock, fl_list);
1526 if (fl->fl_type == F_WRLCK)
1527 has_lease = true;
1528 }
1529 spin_unlock(&ctx->flc_lock);
1530 }
1531
1532 if (has_lease)
1533 *time = current_fs_time(inode->i_sb);
1534 else
1535 *time = inode->i_mtime;
1536 }
1537
1538 EXPORT_SYMBOL(lease_get_mtime);
1539
1540 /**
1541 * fcntl_getlease - Enquire what lease is currently active
1542 * @filp: the file
1543 *
1544 * The value returned by this function will be one of
1545 * (if no lease break is pending):
1546 *
1547 * %F_RDLCK to indicate a shared lease is held.
1548 *
1549 * %F_WRLCK to indicate an exclusive lease is held.
1550 *
1551 * %F_UNLCK to indicate no lease is held.
1552 *
1553 * (if a lease break is pending):
1554 *
1555 * %F_RDLCK to indicate an exclusive lease needs to be
1556 * changed to a shared lease (or removed).
1557 *
1558 * %F_UNLCK to indicate the lease needs to be removed.
1559 *
1560 * XXX: sfr & willy disagree over whether F_INPROGRESS
1561 * should be returned to userspace.
1562 */
1563 int fcntl_getlease(struct file *filp)
1564 {
1565 struct file_lock *fl;
1566 struct inode *inode = file_inode(filp);
1567 struct file_lock_context *ctx = inode->i_flctx;
1568 int type = F_UNLCK;
1569 LIST_HEAD(dispose);
1570
1571 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
1572 spin_lock(&ctx->flc_lock);
1573 time_out_leases(file_inode(filp), &dispose);
1574 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1575 if (fl->fl_file != filp)
1576 continue;
1577 type = target_leasetype(fl);
1578 break;
1579 }
1580 spin_unlock(&ctx->flc_lock);
1581 locks_dispose_list(&dispose);
1582 }
1583 return type;
1584 }
1585
1586 /**
1587 * check_conflicting_open - see if the given dentry points to a file that has
1588 * an existing open that would conflict with the
1589 * desired lease.
1590 * @dentry: dentry to check
1591 * @arg: type of lease that we're trying to acquire
1592 *
1593 * Check to see if there's an existing open fd on this file that would
1594 * conflict with the lease we're trying to set.
1595 */
1596 static int
1597 check_conflicting_open(const struct dentry *dentry, const long arg)
1598 {
1599 int ret = 0;
1600 struct inode *inode = dentry->d_inode;
1601
1602 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1603 return -EAGAIN;
1604
1605 if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1606 (atomic_read(&inode->i_count) > 1)))
1607 ret = -EAGAIN;
1608
1609 return ret;
1610 }
1611
1612 static int
1613 generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
1614 {
1615 struct file_lock *fl, *my_fl = NULL, *lease;
1616 struct dentry *dentry = filp->f_path.dentry;
1617 struct inode *inode = dentry->d_inode;
1618 struct file_lock_context *ctx;
1619 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
1620 int error;
1621 LIST_HEAD(dispose);
1622
1623 lease = *flp;
1624 trace_generic_add_lease(inode, lease);
1625
1626 ctx = locks_get_lock_context(inode);
1627 if (!ctx)
1628 return -ENOMEM;
1629
1630 /*
1631 * In the delegation case we need mutual exclusion with
1632 * a number of operations that take the i_mutex. We trylock
1633 * because delegations are an optional optimization, and if
1634 * there's some chance of a conflict--we'd rather not
1635 * bother, maybe that's a sign this just isn't a good file to
1636 * hand out a delegation on.
1637 */
1638 if (is_deleg && !mutex_trylock(&inode->i_mutex))
1639 return -EAGAIN;
1640
1641 if (is_deleg && arg == F_WRLCK) {
1642 /* Write delegations are not currently supported: */
1643 mutex_unlock(&inode->i_mutex);
1644 WARN_ON_ONCE(1);
1645 return -EINVAL;
1646 }
1647
1648 spin_lock(&ctx->flc_lock);
1649 time_out_leases(inode, &dispose);
1650 error = check_conflicting_open(dentry, arg);
1651 if (error)
1652 goto out;
1653
1654 /*
1655 * At this point, we know that if there is an exclusive
1656 * lease on this file, then we hold it on this filp
1657 * (otherwise our open of this file would have blocked).
1658 * And if we are trying to acquire an exclusive lease,
1659 * then the file is not open by anyone (including us)
1660 * except for this filp.
1661 */
1662 error = -EAGAIN;
1663 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1664 if (fl->fl_file == filp) {
1665 my_fl = fl;
1666 continue;
1667 }
1668
1669 /*
1670 * No exclusive leases if someone else has a lease on
1671 * this file:
1672 */
1673 if (arg == F_WRLCK)
1674 goto out;
1675 /*
1676 * Modifying our existing lease is OK, but no getting a
1677 * new lease if someone else is opening for write:
1678 */
1679 if (fl->fl_flags & FL_UNLOCK_PENDING)
1680 goto out;
1681 }
1682
1683 if (my_fl != NULL) {
1684 error = lease->fl_lmops->lm_change(my_fl, arg, &dispose);
1685 if (error)
1686 goto out;
1687 goto out_setup;
1688 }
1689
1690 error = -EINVAL;
1691 if (!leases_enable)
1692 goto out;
1693
1694 locks_insert_lock_ctx(lease, &ctx->flc_lease_cnt, &ctx->flc_lease);
1695 /*
1696 * The check in break_lease() is lockless. It's possible for another
1697 * open to race in after we did the earlier check for a conflicting
1698 * open but before the lease was inserted. Check again for a
1699 * conflicting open and cancel the lease if there is one.
1700 *
1701 * We also add a barrier here to ensure that the insertion of the lock
1702 * precedes these checks.
1703 */
1704 smp_mb();
1705 error = check_conflicting_open(dentry, arg);
1706 if (error) {
1707 locks_unlink_lock_ctx(lease, &ctx->flc_lease_cnt);
1708 goto out;
1709 }
1710
1711 out_setup:
1712 if (lease->fl_lmops->lm_setup)
1713 lease->fl_lmops->lm_setup(lease, priv);
1714 out:
1715 spin_unlock(&ctx->flc_lock);
1716 locks_dispose_list(&dispose);
1717 if (is_deleg)
1718 mutex_unlock(&inode->i_mutex);
1719 if (!error && !my_fl)
1720 *flp = NULL;
1721 return error;
1722 }
1723
1724 static int generic_delete_lease(struct file *filp)
1725 {
1726 int error = -EAGAIN;
1727 struct file_lock *fl, *victim = NULL;
1728 struct dentry *dentry = filp->f_path.dentry;
1729 struct inode *inode = dentry->d_inode;
1730 struct file_lock_context *ctx = inode->i_flctx;
1731 LIST_HEAD(dispose);
1732
1733 if (!ctx) {
1734 trace_generic_delete_lease(inode, NULL);
1735 return error;
1736 }
1737
1738 spin_lock(&ctx->flc_lock);
1739 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1740 if (fl->fl_file == filp) {
1741 victim = fl;
1742 break;
1743 }
1744 }
1745 trace_generic_delete_lease(inode, fl);
1746 if (victim)
1747 error = fl->fl_lmops->lm_change(victim, F_UNLCK, &dispose);
1748 spin_unlock(&ctx->flc_lock);
1749 locks_dispose_list(&dispose);
1750 return error;
1751 }
1752
1753 /**
1754 * generic_setlease - sets a lease on an open file
1755 * @filp: file pointer
1756 * @arg: type of lease to obtain
1757 * @flp: input - file_lock to use, output - file_lock inserted
1758 * @priv: private data for lm_setup (may be NULL if lm_setup
1759 * doesn't require it)
1760 *
1761 * The (input) flp->fl_lmops->lm_break function is required
1762 * by break_lease().
1763 */
1764 int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
1765 void **priv)
1766 {
1767 struct dentry *dentry = filp->f_path.dentry;
1768 struct inode *inode = dentry->d_inode;
1769 int error;
1770
1771 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
1772 return -EACCES;
1773 if (!S_ISREG(inode->i_mode))
1774 return -EINVAL;
1775 error = security_file_lock(filp, arg);
1776 if (error)
1777 return error;
1778
1779 switch (arg) {
1780 case F_UNLCK:
1781 return generic_delete_lease(filp);
1782 case F_RDLCK:
1783 case F_WRLCK:
1784 if (!(*flp)->fl_lmops->lm_break) {
1785 WARN_ON_ONCE(1);
1786 return -ENOLCK;
1787 }
1788 return generic_add_lease(filp, arg, flp, priv);
1789 default:
1790 return -EINVAL;
1791 }
1792 }
1793 EXPORT_SYMBOL(generic_setlease);
1794
1795 /**
1796 * vfs_setlease - sets a lease on an open file
1797 * @filp: file pointer
1798 * @arg: type of lease to obtain
1799 * @lease: file_lock to use when adding a lease
1800 * @priv: private info for lm_setup when adding a lease (may be
1801 * NULL if lm_setup doesn't require it)
1802 *
1803 * Call this to establish a lease on the file. The "lease" argument is not
1804 * used for F_UNLCK requests and may be NULL. For commands that set or alter
1805 * an existing lease, the (*lease)->fl_lmops->lm_break operation must be set;
1806 * if not, this function will return -ENOLCK (and generate a scary-looking
1807 * stack trace).
1808 *
1809 * The "priv" pointer is passed directly to the lm_setup function as-is. It
1810 * may be NULL if the lm_setup operation doesn't require it.
1811 */
1812 int
1813 vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
1814 {
1815 if (filp->f_op->setlease)
1816 return filp->f_op->setlease(filp, arg, lease, priv);
1817 else
1818 return generic_setlease(filp, arg, lease, priv);
1819 }
1820 EXPORT_SYMBOL_GPL(vfs_setlease);
1821
1822 static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
1823 {
1824 struct file_lock *fl;
1825 struct fasync_struct *new;
1826 int error;
1827
1828 fl = lease_alloc(filp, arg);
1829 if (IS_ERR(fl))
1830 return PTR_ERR(fl);
1831
1832 new = fasync_alloc();
1833 if (!new) {
1834 locks_free_lock(fl);
1835 return -ENOMEM;
1836 }
1837 new->fa_fd = fd;
1838
1839 error = vfs_setlease(filp, arg, &fl, (void **)&new);
1840 if (fl)
1841 locks_free_lock(fl);
1842 if (new)
1843 fasync_free(new);
1844 return error;
1845 }
1846
1847 /**
1848 * fcntl_setlease - sets a lease on an open file
1849 * @fd: open file descriptor
1850 * @filp: file pointer
1851 * @arg: type of lease to obtain
1852 *
1853 * Call this fcntl to establish a lease on the file.
1854 * Note that you also need to call %F_SETSIG to
1855 * receive a signal when the lease is broken.
1856 */
1857 int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1858 {
1859 if (arg == F_UNLCK)
1860 return vfs_setlease(filp, F_UNLCK, NULL, NULL);
1861 return do_fcntl_add_lease(fd, filp, arg);
1862 }
1863
1864 /**
1865 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1866 * @filp: The file to apply the lock to
1867 * @fl: The lock to be applied
1868 *
1869 * Add a FLOCK style lock to a file.
1870 */
1871 int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1872 {
1873 int error;
1874 might_sleep();
1875 for (;;) {
1876 error = flock_lock_file(filp, fl);
1877 if (error != FILE_LOCK_DEFERRED)
1878 break;
1879 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1880 if (!error)
1881 continue;
1882
1883 locks_delete_block(fl);
1884 break;
1885 }
1886 return error;
1887 }
1888
1889 EXPORT_SYMBOL(flock_lock_file_wait);
1890
1891 /**
1892 * sys_flock: - flock() system call.
1893 * @fd: the file descriptor to lock.
1894 * @cmd: the type of lock to apply.
1895 *
1896 * Apply a %FL_FLOCK style lock to an open file descriptor.
1897 * The @cmd can be one of
1898 *
1899 * %LOCK_SH -- a shared lock.
1900 *
1901 * %LOCK_EX -- an exclusive lock.
1902 *
1903 * %LOCK_UN -- remove an existing lock.
1904 *
1905 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1906 *
1907 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1908 * processes read and write access respectively.
1909 */
1910 SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
1911 {
1912 struct fd f = fdget(fd);
1913 struct file_lock *lock;
1914 int can_sleep, unlock;
1915 int error;
1916
1917 error = -EBADF;
1918 if (!f.file)
1919 goto out;
1920
1921 can_sleep = !(cmd & LOCK_NB);
1922 cmd &= ~LOCK_NB;
1923 unlock = (cmd == LOCK_UN);
1924
1925 if (!unlock && !(cmd & LOCK_MAND) &&
1926 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
1927 goto out_putf;
1928
1929 lock = flock_make_lock(f.file, cmd);
1930 if (IS_ERR(lock)) {
1931 error = PTR_ERR(lock);
1932 goto out_putf;
1933 }
1934
1935 if (can_sleep)
1936 lock->fl_flags |= FL_SLEEP;
1937
1938 error = security_file_lock(f.file, lock->fl_type);
1939 if (error)
1940 goto out_free;
1941
1942 if (f.file->f_op->flock)
1943 error = f.file->f_op->flock(f.file,
1944 (can_sleep) ? F_SETLKW : F_SETLK,
1945 lock);
1946 else
1947 error = flock_lock_file_wait(f.file, lock);
1948
1949 out_free:
1950 locks_free_lock(lock);
1951
1952 out_putf:
1953 fdput(f);
1954 out:
1955 return error;
1956 }
1957
1958 /**
1959 * vfs_test_lock - test file byte range lock
1960 * @filp: The file to test lock for
1961 * @fl: The lock to test; also used to hold result
1962 *
1963 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1964 * setting conf->fl_type to something other than F_UNLCK.
1965 */
1966 int vfs_test_lock(struct file *filp, struct file_lock *fl)
1967 {
1968 if (filp->f_op->lock)
1969 return filp->f_op->lock(filp, F_GETLK, fl);
1970 posix_test_lock(filp, fl);
1971 return 0;
1972 }
1973 EXPORT_SYMBOL_GPL(vfs_test_lock);
1974
1975 static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1976 {
1977 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
1978 #if BITS_PER_LONG == 32
1979 /*
1980 * Make sure we can represent the posix lock via
1981 * legacy 32bit flock.
1982 */
1983 if (fl->fl_start > OFFT_OFFSET_MAX)
1984 return -EOVERFLOW;
1985 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1986 return -EOVERFLOW;
1987 #endif
1988 flock->l_start = fl->fl_start;
1989 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1990 fl->fl_end - fl->fl_start + 1;
1991 flock->l_whence = 0;
1992 flock->l_type = fl->fl_type;
1993 return 0;
1994 }
1995
1996 #if BITS_PER_LONG == 32
1997 static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1998 {
1999 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
2000 flock->l_start = fl->fl_start;
2001 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2002 fl->fl_end - fl->fl_start + 1;
2003 flock->l_whence = 0;
2004 flock->l_type = fl->fl_type;
2005 }
2006 #endif
2007
2008 /* Report the first existing lock that would conflict with l.
2009 * This implements the F_GETLK command of fcntl().
2010 */
2011 int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock __user *l)
2012 {
2013 struct file_lock file_lock;
2014 struct flock flock;
2015 int error;
2016
2017 error = -EFAULT;
2018 if (copy_from_user(&flock, l, sizeof(flock)))
2019 goto out;
2020 error = -EINVAL;
2021 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2022 goto out;
2023
2024 error = flock_to_posix_lock(filp, &file_lock, &flock);
2025 if (error)
2026 goto out;
2027
2028 if (cmd == F_OFD_GETLK) {
2029 error = -EINVAL;
2030 if (flock.l_pid != 0)
2031 goto out;
2032
2033 cmd = F_GETLK;
2034 file_lock.fl_flags |= FL_OFDLCK;
2035 file_lock.fl_owner = filp;
2036 }
2037
2038 error = vfs_test_lock(filp, &file_lock);
2039 if (error)
2040 goto out;
2041
2042 flock.l_type = file_lock.fl_type;
2043 if (file_lock.fl_type != F_UNLCK) {
2044 error = posix_lock_to_flock(&flock, &file_lock);
2045 if (error)
2046 goto rel_priv;
2047 }
2048 error = -EFAULT;
2049 if (!copy_to_user(l, &flock, sizeof(flock)))
2050 error = 0;
2051 rel_priv:
2052 locks_release_private(&file_lock);
2053 out:
2054 return error;
2055 }
2056
2057 /**
2058 * vfs_lock_file - file byte range lock
2059 * @filp: The file to apply the lock to
2060 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2061 * @fl: The lock to be applied
2062 * @conf: Place to return a copy of the conflicting lock, if found.
2063 *
2064 * A caller that doesn't care about the conflicting lock may pass NULL
2065 * as the final argument.
2066 *
2067 * If the filesystem defines a private ->lock() method, then @conf will
2068 * be left unchanged; so a caller that cares should initialize it to
2069 * some acceptable default.
2070 *
2071 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2072 * locks, the ->lock() interface may return asynchronously, before the lock has
2073 * been granted or denied by the underlying filesystem, if (and only if)
2074 * lm_grant is set. Callers expecting ->lock() to return asynchronously
2075 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2076 * the request is for a blocking lock. When ->lock() does return asynchronously,
2077 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
2078 * request completes.
2079 * If the request is for non-blocking lock the file system should return
2080 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2081 * with the result. If the request timed out the callback routine will return a
2082 * nonzero return code and the file system should release the lock. The file
2083 * system is also responsible to keep a corresponding posix lock when it
2084 * grants a lock so the VFS can find out which locks are locally held and do
2085 * the correct lock cleanup when required.
2086 * The underlying filesystem must not drop the kernel lock or call
2087 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
2088 * return code.
2089 */
2090 int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
2091 {
2092 if (filp->f_op->lock)
2093 return filp->f_op->lock(filp, cmd, fl);
2094 else
2095 return posix_lock_file(filp, fl, conf);
2096 }
2097 EXPORT_SYMBOL_GPL(vfs_lock_file);
2098
2099 static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2100 struct file_lock *fl)
2101 {
2102 int error;
2103
2104 error = security_file_lock(filp, fl->fl_type);
2105 if (error)
2106 return error;
2107
2108 for (;;) {
2109 error = vfs_lock_file(filp, cmd, fl, NULL);
2110 if (error != FILE_LOCK_DEFERRED)
2111 break;
2112 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
2113 if (!error)
2114 continue;
2115
2116 locks_delete_block(fl);
2117 break;
2118 }
2119
2120 return error;
2121 }
2122
2123 /* Ensure that fl->fl_filp has compatible f_mode for F_SETLK calls */
2124 static int
2125 check_fmode_for_setlk(struct file_lock *fl)
2126 {
2127 switch (fl->fl_type) {
2128 case F_RDLCK:
2129 if (!(fl->fl_file->f_mode & FMODE_READ))
2130 return -EBADF;
2131 break;
2132 case F_WRLCK:
2133 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2134 return -EBADF;
2135 }
2136 return 0;
2137 }
2138
2139 /* Apply the lock described by l to an open file descriptor.
2140 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2141 */
2142 int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
2143 struct flock __user *l)
2144 {
2145 struct file_lock *file_lock = locks_alloc_lock();
2146 struct flock flock;
2147 struct inode *inode;
2148 struct file *f;
2149 int error;
2150
2151 if (file_lock == NULL)
2152 return -ENOLCK;
2153
2154 /*
2155 * This might block, so we do it before checking the inode.
2156 */
2157 error = -EFAULT;
2158 if (copy_from_user(&flock, l, sizeof(flock)))
2159 goto out;
2160
2161 inode = file_inode(filp);
2162
2163 /* Don't allow mandatory locks on files that may be memory mapped
2164 * and shared.
2165 */
2166 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
2167 error = -EAGAIN;
2168 goto out;
2169 }
2170
2171 again:
2172 error = flock_to_posix_lock(filp, file_lock, &flock);
2173 if (error)
2174 goto out;
2175
2176 error = check_fmode_for_setlk(file_lock);
2177 if (error)
2178 goto out;
2179
2180 /*
2181 * If the cmd is requesting file-private locks, then set the
2182 * FL_OFDLCK flag and override the owner.
2183 */
2184 switch (cmd) {
2185 case F_OFD_SETLK:
2186 error = -EINVAL;
2187 if (flock.l_pid != 0)
2188 goto out;
2189
2190 cmd = F_SETLK;
2191 file_lock->fl_flags |= FL_OFDLCK;
2192 file_lock->fl_owner = filp;
2193 break;
2194 case F_OFD_SETLKW:
2195 error = -EINVAL;
2196 if (flock.l_pid != 0)
2197 goto out;
2198
2199 cmd = F_SETLKW;
2200 file_lock->fl_flags |= FL_OFDLCK;
2201 file_lock->fl_owner = filp;
2202 /* Fallthrough */
2203 case F_SETLKW:
2204 file_lock->fl_flags |= FL_SLEEP;
2205 }
2206
2207 error = do_lock_file_wait(filp, cmd, file_lock);
2208
2209 /*
2210 * Attempt to detect a close/fcntl race and recover by
2211 * releasing the lock that was just acquired.
2212 */
2213 /*
2214 * we need that spin_lock here - it prevents reordering between
2215 * update of i_flctx->flc_posix and check for it done in close().
2216 * rcu_read_lock() wouldn't do.
2217 */
2218 spin_lock(&current->files->file_lock);
2219 f = fcheck(fd);
2220 spin_unlock(&current->files->file_lock);
2221 if (!error && f != filp && flock.l_type != F_UNLCK) {
2222 flock.l_type = F_UNLCK;
2223 goto again;
2224 }
2225
2226 out:
2227 locks_free_lock(file_lock);
2228 return error;
2229 }
2230
2231 #if BITS_PER_LONG == 32
2232 /* Report the first existing lock that would conflict with l.
2233 * This implements the F_GETLK command of fcntl().
2234 */
2235 int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 __user *l)
2236 {
2237 struct file_lock file_lock;
2238 struct flock64 flock;
2239 int error;
2240
2241 error = -EFAULT;
2242 if (copy_from_user(&flock, l, sizeof(flock)))
2243 goto out;
2244 error = -EINVAL;
2245 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2246 goto out;
2247
2248 error = flock64_to_posix_lock(filp, &file_lock, &flock);
2249 if (error)
2250 goto out;
2251
2252 if (cmd == F_OFD_GETLK) {
2253 error = -EINVAL;
2254 if (flock.l_pid != 0)
2255 goto out;
2256
2257 cmd = F_GETLK64;
2258 file_lock.fl_flags |= FL_OFDLCK;
2259 file_lock.fl_owner = filp;
2260 }
2261
2262 error = vfs_test_lock(filp, &file_lock);
2263 if (error)
2264 goto out;
2265
2266 flock.l_type = file_lock.fl_type;
2267 if (file_lock.fl_type != F_UNLCK)
2268 posix_lock_to_flock64(&flock, &file_lock);
2269
2270 error = -EFAULT;
2271 if (!copy_to_user(l, &flock, sizeof(flock)))
2272 error = 0;
2273
2274 locks_release_private(&file_lock);
2275 out:
2276 return error;
2277 }
2278
2279 /* Apply the lock described by l to an open file descriptor.
2280 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2281 */
2282 int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2283 struct flock64 __user *l)
2284 {
2285 struct file_lock *file_lock = locks_alloc_lock();
2286 struct flock64 flock;
2287 struct inode *inode;
2288 struct file *f;
2289 int error;
2290
2291 if (file_lock == NULL)
2292 return -ENOLCK;
2293
2294 /*
2295 * This might block, so we do it before checking the inode.
2296 */
2297 error = -EFAULT;
2298 if (copy_from_user(&flock, l, sizeof(flock)))
2299 goto out;
2300
2301 inode = file_inode(filp);
2302
2303 /* Don't allow mandatory locks on files that may be memory mapped
2304 * and shared.
2305 */
2306 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
2307 error = -EAGAIN;
2308 goto out;
2309 }
2310
2311 again:
2312 error = flock64_to_posix_lock(filp, file_lock, &flock);
2313 if (error)
2314 goto out;
2315
2316 error = check_fmode_for_setlk(file_lock);
2317 if (error)
2318 goto out;
2319
2320 /*
2321 * If the cmd is requesting file-private locks, then set the
2322 * FL_OFDLCK flag and override the owner.
2323 */
2324 switch (cmd) {
2325 case F_OFD_SETLK:
2326 error = -EINVAL;
2327 if (flock.l_pid != 0)
2328 goto out;
2329
2330 cmd = F_SETLK64;
2331 file_lock->fl_flags |= FL_OFDLCK;
2332 file_lock->fl_owner = filp;
2333 break;
2334 case F_OFD_SETLKW:
2335 error = -EINVAL;
2336 if (flock.l_pid != 0)
2337 goto out;
2338
2339 cmd = F_SETLKW64;
2340 file_lock->fl_flags |= FL_OFDLCK;
2341 file_lock->fl_owner = filp;
2342 /* Fallthrough */
2343 case F_SETLKW64:
2344 file_lock->fl_flags |= FL_SLEEP;
2345 }
2346
2347 error = do_lock_file_wait(filp, cmd, file_lock);
2348
2349 /*
2350 * Attempt to detect a close/fcntl race and recover by
2351 * releasing the lock that was just acquired.
2352 */
2353 spin_lock(&current->files->file_lock);
2354 f = fcheck(fd);
2355 spin_unlock(&current->files->file_lock);
2356 if (!error && f != filp && flock.l_type != F_UNLCK) {
2357 flock.l_type = F_UNLCK;
2358 goto again;
2359 }
2360
2361 out:
2362 locks_free_lock(file_lock);
2363 return error;
2364 }
2365 #endif /* BITS_PER_LONG == 32 */
2366
2367 /*
2368 * This function is called when the file is being removed
2369 * from the task's fd array. POSIX locks belonging to this task
2370 * are deleted at this time.
2371 */
2372 void locks_remove_posix(struct file *filp, fl_owner_t owner)
2373 {
2374 struct file_lock lock;
2375 struct file_lock_context *ctx = file_inode(filp)->i_flctx;
2376
2377 /*
2378 * If there are no locks held on this file, we don't need to call
2379 * posix_lock_file(). Another process could be setting a lock on this
2380 * file at the same time, but we wouldn't remove that lock anyway.
2381 */
2382 if (!ctx || list_empty(&ctx->flc_posix))
2383 return;
2384
2385 lock.fl_type = F_UNLCK;
2386 lock.fl_flags = FL_POSIX | FL_CLOSE;
2387 lock.fl_start = 0;
2388 lock.fl_end = OFFSET_MAX;
2389 lock.fl_owner = owner;
2390 lock.fl_pid = current->tgid;
2391 lock.fl_file = filp;
2392 lock.fl_ops = NULL;
2393 lock.fl_lmops = NULL;
2394
2395 vfs_lock_file(filp, F_SETLK, &lock, NULL);
2396
2397 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2398 lock.fl_ops->fl_release_private(&lock);
2399 }
2400
2401 EXPORT_SYMBOL(locks_remove_posix);
2402
2403 /* The i_flctx must be valid when calling into here */
2404 static void
2405 locks_remove_flock(struct file *filp)
2406 {
2407 struct file_lock fl = {
2408 .fl_owner = filp,
2409 .fl_pid = current->tgid,
2410 .fl_file = filp,
2411 .fl_flags = FL_FLOCK,
2412 .fl_type = F_UNLCK,
2413 .fl_end = OFFSET_MAX,
2414 };
2415 struct file_lock_context *flctx = file_inode(filp)->i_flctx;
2416
2417 if (list_empty(&flctx->flc_flock))
2418 return;
2419
2420 if (filp->f_op->flock)
2421 filp->f_op->flock(filp, F_SETLKW, &fl);
2422 else
2423 flock_lock_file(filp, &fl);
2424
2425 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2426 fl.fl_ops->fl_release_private(&fl);
2427 }
2428
2429 /* The i_flctx must be valid when calling into here */
2430 static void
2431 locks_remove_lease(struct file *filp)
2432 {
2433 struct inode *inode = file_inode(filp);
2434 struct file_lock_context *ctx = inode->i_flctx;
2435 struct file_lock *fl, *tmp;
2436 LIST_HEAD(dispose);
2437
2438 if (list_empty(&ctx->flc_lease))
2439 return;
2440
2441 spin_lock(&ctx->flc_lock);
2442 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list)
2443 lease_modify(fl, F_UNLCK, &dispose);
2444 spin_unlock(&ctx->flc_lock);
2445 locks_dispose_list(&dispose);
2446 }
2447
2448 /*
2449 * This function is called on the last close of an open file.
2450 */
2451 void locks_remove_file(struct file *filp)
2452 {
2453 if (!file_inode(filp)->i_flctx)
2454 return;
2455
2456 /* remove any OFD locks */
2457 locks_remove_posix(filp, filp);
2458
2459 /* remove flock locks */
2460 locks_remove_flock(filp);
2461
2462 /* remove any leases */
2463 locks_remove_lease(filp);
2464 }
2465
2466 /**
2467 * posix_unblock_lock - stop waiting for a file lock
2468 * @waiter: the lock which was waiting
2469 *
2470 * lockd needs to block waiting for locks.
2471 */
2472 int
2473 posix_unblock_lock(struct file_lock *waiter)
2474 {
2475 int status = 0;
2476
2477 spin_lock(&blocked_lock_lock);
2478 if (waiter->fl_next)
2479 __locks_delete_block(waiter);
2480 else
2481 status = -ENOENT;
2482 spin_unlock(&blocked_lock_lock);
2483 return status;
2484 }
2485 EXPORT_SYMBOL(posix_unblock_lock);
2486
2487 /**
2488 * vfs_cancel_lock - file byte range unblock lock
2489 * @filp: The file to apply the unblock to
2490 * @fl: The lock to be unblocked
2491 *
2492 * Used by lock managers to cancel blocked requests
2493 */
2494 int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2495 {
2496 if (filp->f_op->lock)
2497 return filp->f_op->lock(filp, F_CANCELLK, fl);
2498 return 0;
2499 }
2500
2501 EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2502
2503 #ifdef CONFIG_PROC_FS
2504 #include <linux/proc_fs.h>
2505 #include <linux/seq_file.h>
2506
2507 struct locks_iterator {
2508 int li_cpu;
2509 loff_t li_pos;
2510 };
2511
2512 static void lock_get_status(struct seq_file *f, struct file_lock *fl,
2513 loff_t id, char *pfx)
2514 {
2515 struct inode *inode = NULL;
2516 unsigned int fl_pid;
2517
2518 if (fl->fl_nspid)
2519 fl_pid = pid_vnr(fl->fl_nspid);
2520 else
2521 fl_pid = fl->fl_pid;
2522
2523 if (fl->fl_file != NULL)
2524 inode = file_inode(fl->fl_file);
2525
2526 seq_printf(f, "%lld:%s ", id, pfx);
2527 if (IS_POSIX(fl)) {
2528 if (fl->fl_flags & FL_ACCESS)
2529 seq_puts(f, "ACCESS");
2530 else if (IS_OFDLCK(fl))
2531 seq_puts(f, "OFDLCK");
2532 else
2533 seq_puts(f, "POSIX ");
2534
2535 seq_printf(f, " %s ",
2536 (inode == NULL) ? "*NOINODE*" :
2537 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
2538 } else if (IS_FLOCK(fl)) {
2539 if (fl->fl_type & LOCK_MAND) {
2540 seq_puts(f, "FLOCK MSNFS ");
2541 } else {
2542 seq_puts(f, "FLOCK ADVISORY ");
2543 }
2544 } else if (IS_LEASE(fl)) {
2545 if (fl->fl_flags & FL_DELEG)
2546 seq_puts(f, "DELEG ");
2547 else
2548 seq_puts(f, "LEASE ");
2549
2550 if (lease_breaking(fl))
2551 seq_puts(f, "BREAKING ");
2552 else if (fl->fl_file)
2553 seq_puts(f, "ACTIVE ");
2554 else
2555 seq_puts(f, "BREAKER ");
2556 } else {
2557 seq_puts(f, "UNKNOWN UNKNOWN ");
2558 }
2559 if (fl->fl_type & LOCK_MAND) {
2560 seq_printf(f, "%s ",
2561 (fl->fl_type & LOCK_READ)
2562 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2563 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2564 } else {
2565 seq_printf(f, "%s ",
2566 (lease_breaking(fl))
2567 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2568 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
2569 }
2570 if (inode) {
2571 #ifdef WE_CAN_BREAK_LSLK_NOW
2572 seq_printf(f, "%d %s:%ld ", fl_pid,
2573 inode->i_sb->s_id, inode->i_ino);
2574 #else
2575 /* userspace relies on this representation of dev_t ;-( */
2576 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
2577 MAJOR(inode->i_sb->s_dev),
2578 MINOR(inode->i_sb->s_dev), inode->i_ino);
2579 #endif
2580 } else {
2581 seq_printf(f, "%d <none>:0 ", fl_pid);
2582 }
2583 if (IS_POSIX(fl)) {
2584 if (fl->fl_end == OFFSET_MAX)
2585 seq_printf(f, "%Ld EOF\n", fl->fl_start);
2586 else
2587 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
2588 } else {
2589 seq_puts(f, "0 EOF\n");
2590 }
2591 }
2592
2593 static int locks_show(struct seq_file *f, void *v)
2594 {
2595 struct locks_iterator *iter = f->private;
2596 struct file_lock *fl, *bfl;
2597
2598 fl = hlist_entry(v, struct file_lock, fl_link);
2599
2600 lock_get_status(f, fl, iter->li_pos, "");
2601
2602 list_for_each_entry(bfl, &fl->fl_block, fl_block)
2603 lock_get_status(f, bfl, iter->li_pos, " ->");
2604
2605 return 0;
2606 }
2607
2608 static void *locks_start(struct seq_file *f, loff_t *pos)
2609 __acquires(&blocked_lock_lock)
2610 {
2611 struct locks_iterator *iter = f->private;
2612
2613 iter->li_pos = *pos + 1;
2614 lg_global_lock(&file_lock_lglock);
2615 spin_lock(&blocked_lock_lock);
2616 return seq_hlist_start_percpu(&file_lock_list, &iter->li_cpu, *pos);
2617 }
2618
2619 static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2620 {
2621 struct locks_iterator *iter = f->private;
2622
2623 ++iter->li_pos;
2624 return seq_hlist_next_percpu(v, &file_lock_list, &iter->li_cpu, pos);
2625 }
2626
2627 static void locks_stop(struct seq_file *f, void *v)
2628 __releases(&blocked_lock_lock)
2629 {
2630 spin_unlock(&blocked_lock_lock);
2631 lg_global_unlock(&file_lock_lglock);
2632 }
2633
2634 static const struct seq_operations locks_seq_operations = {
2635 .start = locks_start,
2636 .next = locks_next,
2637 .stop = locks_stop,
2638 .show = locks_show,
2639 };
2640
2641 static int locks_open(struct inode *inode, struct file *filp)
2642 {
2643 return seq_open_private(filp, &locks_seq_operations,
2644 sizeof(struct locks_iterator));
2645 }
2646
2647 static const struct file_operations proc_locks_operations = {
2648 .open = locks_open,
2649 .read = seq_read,
2650 .llseek = seq_lseek,
2651 .release = seq_release_private,
2652 };
2653
2654 static int __init proc_locks_init(void)
2655 {
2656 proc_create("locks", 0, NULL, &proc_locks_operations);
2657 return 0;
2658 }
2659 module_init(proc_locks_init);
2660 #endif
2661
2662 static int __init filelock_init(void)
2663 {
2664 int i;
2665
2666 flctx_cache = kmem_cache_create("file_lock_ctx",
2667 sizeof(struct file_lock_context), 0, SLAB_PANIC, NULL);
2668
2669 filelock_cache = kmem_cache_create("file_lock_cache",
2670 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2671
2672 lg_lock_init(&file_lock_lglock, "file_lock_lglock");
2673
2674 for_each_possible_cpu(i)
2675 INIT_HLIST_HEAD(per_cpu_ptr(&file_lock_list, i));
2676
2677 return 0;
2678 }
2679
2680 core_initcall(filelock_init);