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