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