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