locks.c 67.7 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
/*
 *  linux/fs/locks.c
 *
 *  Provide support for fcntl()'s F_GETLK, F_SETLK, and F_SETLKW calls.
 *  Doug Evans (dje@spiff.uucp), August 07, 1992
 *
 *  Deadlock detection added.
 *  FIXME: one thing isn't handled yet:
 *	- mandatory locks (requires lots of changes elsewhere)
 *  Kelly Carmichael (kelly@[142.24.8.65]), September 17, 1994.
 *
 *  Miscellaneous edits, and a total rewrite of posix_lock_file() code.
 *  Kai Petzke (wpp@marie.physik.tu-berlin.de), 1994
 *  
 *  Converted file_lock_table to a linked list from an array, which eliminates
 *  the limits on how many active file locks are open.
 *  Chad Page (pageone@netcom.com), November 27, 1994
 * 
 *  Removed dependency on file descriptors. dup()'ed file descriptors now
 *  get the same locks as the original file descriptors, and a close() on
 *  any file descriptor removes ALL the locks on the file for the current
 *  process. Since locks still depend on the process id, locks are inherited
 *  after an exec() but not after a fork(). This agrees with POSIX, and both
 *  BSD and SVR4 practice.
 *  Andy Walker (andy@lysaker.kvaerner.no), February 14, 1995
 *
 *  Scrapped free list which is redundant now that we allocate locks
 *  dynamically with kmalloc()/kfree().
 *  Andy Walker (andy@lysaker.kvaerner.no), February 21, 1995
 *
 *  Implemented two lock personalities - FL_FLOCK and FL_POSIX.
 *
 *  FL_POSIX locks are created with calls to fcntl() and lockf() through the
 *  fcntl() system call. They have the semantics described above.
 *
 *  FL_FLOCK locks are created with calls to flock(), through the flock()
 *  system call, which is new. Old C libraries implement flock() via fcntl()
 *  and will continue to use the old, broken implementation.
 *
 *  FL_FLOCK locks follow the 4.4 BSD flock() semantics. They are associated
 *  with a file pointer (filp). As a result they can be shared by a parent
 *  process and its children after a fork(). They are removed when the last
 *  file descriptor referring to the file pointer is closed (unless explicitly
 *  unlocked). 
 *
 *  FL_FLOCK locks never deadlock, an existing lock is always removed before
 *  upgrading from shared to exclusive (or vice versa). When this happens
 *  any processes blocked by the current lock are woken up and allowed to
 *  run before the new lock is applied.
 *  Andy Walker (andy@lysaker.kvaerner.no), June 09, 1995
 *
 *  Removed some race conditions in flock_lock_file(), marked other possible
 *  races. Just grep for FIXME to see them. 
 *  Dmitry Gorodchanin (pgmdsg@ibi.com), February 09, 1996.
 *
 *  Addressed Dmitry's concerns. Deadlock checking no longer recursive.
 *  Lock allocation changed to GFP_ATOMIC as we can't afford to sleep
 *  once we've checked for blocking and deadlocking.
 *  Andy Walker (andy@lysaker.kvaerner.no), April 03, 1996.
 *
 *  Initial implementation of mandatory locks. SunOS turned out to be
 *  a rotten model, so I implemented the "obvious" semantics.
P
Paul Bolle 已提交
63
 *  See 'Documentation/filesystems/mandatory-locking.txt' for details.
L
Linus Torvalds 已提交
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
 *  Andy Walker (andy@lysaker.kvaerner.no), April 06, 1996.
 *
 *  Don't allow mandatory locks on mmap()'ed files. Added simple functions to
 *  check if a file has mandatory locks, used by mmap(), open() and creat() to
 *  see if system call should be rejected. Ref. HP-UX/SunOS/Solaris Reference
 *  Manual, Section 2.
 *  Andy Walker (andy@lysaker.kvaerner.no), April 09, 1996.
 *
 *  Tidied up block list handling. Added '/proc/locks' interface.
 *  Andy Walker (andy@lysaker.kvaerner.no), April 24, 1996.
 *
 *  Fixed deadlock condition for pathological code that mixes calls to
 *  flock() and fcntl().
 *  Andy Walker (andy@lysaker.kvaerner.no), April 29, 1996.
 *
 *  Allow only one type of locking scheme (FL_POSIX or FL_FLOCK) to be in use
 *  for a given file at a time. Changed the CONFIG_LOCK_MANDATORY scheme to
 *  guarantee sensible behaviour in the case where file system modules might
 *  be compiled with different options than the kernel itself.
 *  Andy Walker (andy@lysaker.kvaerner.no), May 15, 1996.
 *
 *  Added a couple of missing wake_up() calls. Thanks to Thomas Meckel
 *  (Thomas.Meckel@mni.fh-giessen.de) for spotting this.
 *  Andy Walker (andy@lysaker.kvaerner.no), May 15, 1996.
 *
 *  Changed FL_POSIX locks to use the block list in the same way as FL_FLOCK
 *  locks. Changed process synchronisation to avoid dereferencing locks that
 *  have already been freed.
 *  Andy Walker (andy@lysaker.kvaerner.no), Sep 21, 1996.
 *
 *  Made the block list a circular list to minimise searching in the list.
 *  Andy Walker (andy@lysaker.kvaerner.no), Sep 25, 1996.
 *
 *  Made mandatory locking a mount option. Default is not to allow mandatory
 *  locking.
 *  Andy Walker (andy@lysaker.kvaerner.no), Oct 04, 1996.
 *
 *  Some adaptations for NFS support.
 *  Olaf Kirch (okir@monad.swb.de), Dec 1996,
 *
 *  Fixed /proc/locks interface so that we can't overrun the buffer we are handed.
 *  Andy Walker (andy@lysaker.kvaerner.no), May 12, 1997.
 *
 *  Use slab allocator instead of kmalloc/kfree.
 *  Use generic list implementation from <linux/list.h>.
 *  Sped up posix_locks_deadlock by only considering blocked locks.
 *  Matthew Wilcox <willy@debian.org>, March, 2000.
 *
 *  Leases and LOCK_MAND
 *  Matthew Wilcox <willy@debian.org>, June, 2000.
 *  Stephen Rothwell <sfr@canb.auug.org.au>, June, 2000.
 */

#include <linux/capability.h>
#include <linux/file.h>
A
Al Viro 已提交
119
#include <linux/fdtable.h>
L
Linus Torvalds 已提交
120 121 122 123 124 125 126
#include <linux/fs.h>
#include <linux/init.h>
#include <linux/module.h>
#include <linux/security.h>
#include <linux/slab.h>
#include <linux/syscalls.h>
#include <linux/time.h>
127
#include <linux/rcupdate.h>
128
#include <linux/pid_namespace.h>
129
#include <linux/hashtable.h>
130 131
#include <linux/percpu.h>
#include <linux/lglock.h>
L
Linus Torvalds 已提交
132

133 134 135
#define CREATE_TRACE_POINTS
#include <trace/events/filelock.h>

L
Linus Torvalds 已提交
136 137 138 139
#include <asm/uaccess.h>

#define IS_POSIX(fl)	(fl->fl_flags & FL_POSIX)
#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)
L
Linus Torvalds 已提交
142

J
J. Bruce Fields 已提交
143 144
static bool lease_breaking(struct file_lock *fl)
{
145 146 147 148 149 150 151 152 153 154
	return fl->fl_flags & (FL_UNLOCK_PENDING | FL_DOWNGRADE_PENDING);
}

static int target_leasetype(struct file_lock *fl)
{
	if (fl->fl_flags & FL_UNLOCK_PENDING)
		return F_UNLCK;
	if (fl->fl_flags & FL_DOWNGRADE_PENDING)
		return F_RDLCK;
	return fl->fl_type;
J
J. Bruce Fields 已提交
155 156
}

L
Linus Torvalds 已提交
157 158 159 160 161 162
int leases_enable = 1;
int lease_break_time = 45;

#define for_each_lock(inode, lockp) \
	for (lockp = &inode->i_flock; *lockp != NULL; lockp = &(*lockp)->fl_next)

163
/*
164 165 166 167
 * The global file_lock_list is only used for displaying /proc/locks, so we
 * keep a list on each CPU, with each list protected by its own spinlock via
 * the file_lock_lglock. Note that alterations to the list also require that
 * the relevant i_lock is held.
168
 */
169 170
DEFINE_STATIC_LGLOCK(file_lock_lglock);
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 177 178 179 180 181
 *
 * We hash locks by lockowner in order to optimize searching for the lock a
 * particular lockowner is waiting on.
 *
 * FIXME: make this value scale via some heuristic? We generally will want more
 * buckets when we have more lockowners holding locks, but that's a little
 * difficult to determine without knowing what the workload will look like.
182
 */
183 184
#define BLOCKED_HASH_BITS	7
static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
185

186
/*
187 188
 * This lock protects the blocked_hash. Generally, if you're accessing it, you
 * want to be holding this lock.
189 190 191 192 193 194 195 196 197 198 199 200 201 202
 *
 * In addition, it also protects the fl->fl_block list, and the fl->fl_next
 * pointer for file_lock structures that are acting as lock requests (in
 * contrast to those that are acting as records of acquired locks).
 *
 * Note that when we acquire this lock in order to change the above fields,
 * we often hold the i_lock as well. In certain cases, when reading the fields
 * protected by this lock, we can skip acquiring it iff we already hold the
 * i_lock.
 *
 * In particular, adding an entry to the fl_block list requires that you hold
 * both the i_lock and the blocked_lock_lock (acquired in that order). Deleting
 * an entry from the list however only requires the file_lock_lock.
 */
203
static DEFINE_SPINLOCK(blocked_lock_lock);
L
Linus Torvalds 已提交
204

205
static struct kmem_cache *filelock_cache __read_mostly;
L
Linus Torvalds 已提交
206

M
Miklos Szeredi 已提交
207
static void locks_init_lock_heads(struct file_lock *fl)
M
Miklos Szeredi 已提交
208
{
209
	INIT_HLIST_NODE(&fl->fl_link);
M
Miklos Szeredi 已提交
210 211
	INIT_LIST_HEAD(&fl->fl_block);
	init_waitqueue_head(&fl->fl_wait);
M
Miklos Szeredi 已提交
212 213
}

L
Linus Torvalds 已提交
214
/* Allocate an empty lock structure. */
215
struct file_lock *locks_alloc_lock(void)
L
Linus Torvalds 已提交
216
{
M
Miklos Szeredi 已提交
217
	struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
M
Miklos Szeredi 已提交
218 219

	if (fl)
M
Miklos Szeredi 已提交
220
		locks_init_lock_heads(fl);
M
Miklos Szeredi 已提交
221 222

	return fl;
L
Linus Torvalds 已提交
223
}
224
EXPORT_SYMBOL_GPL(locks_alloc_lock);
L
Linus Torvalds 已提交
225

226
void locks_release_private(struct file_lock *fl)
227 228 229 230 231 232 233
{
	if (fl->fl_ops) {
		if (fl->fl_ops->fl_release_private)
			fl->fl_ops->fl_release_private(fl);
		fl->fl_ops = NULL;
	}

234 235 236 237 238
	if (fl->fl_lmops) {
		if (fl->fl_lmops->lm_put_owner)
			fl->fl_lmops->lm_put_owner(fl);
		fl->fl_lmops = NULL;
	}
239
}
240
EXPORT_SYMBOL_GPL(locks_release_private);
241

L
Linus Torvalds 已提交
242
/* Free a lock which is not in use. */
243
void locks_free_lock(struct file_lock *fl)
L
Linus Torvalds 已提交
244
{
M
Miklos Szeredi 已提交
245 246
	BUG_ON(waitqueue_active(&fl->fl_wait));
	BUG_ON(!list_empty(&fl->fl_block));
247
	BUG_ON(!hlist_unhashed(&fl->fl_link));
L
Linus Torvalds 已提交
248

249
	locks_release_private(fl);
L
Linus Torvalds 已提交
250 251
	kmem_cache_free(filelock_cache, fl);
}
252
EXPORT_SYMBOL(locks_free_lock);
L
Linus Torvalds 已提交
253

254 255 256 257 258 259 260 261 262 263 264 265
static void
locks_dispose_list(struct list_head *dispose)
{
	struct file_lock *fl;

	while (!list_empty(dispose)) {
		fl = list_first_entry(dispose, struct file_lock, fl_block);
		list_del_init(&fl->fl_block);
		locks_free_lock(fl);
	}
}

L
Linus Torvalds 已提交
266 267
void locks_init_lock(struct file_lock *fl)
{
M
Miklos Szeredi 已提交
268 269
	memset(fl, 0, sizeof(struct file_lock));
	locks_init_lock_heads(fl);
L
Linus Torvalds 已提交
270 271 272 273 274 275 276
}

EXPORT_SYMBOL(locks_init_lock);

/*
 * Initialize a new lock from an existing file_lock structure.
 */
277
void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
L
Linus Torvalds 已提交
278 279 280
{
	new->fl_owner = fl->fl_owner;
	new->fl_pid = fl->fl_pid;
281
	new->fl_file = NULL;
L
Linus Torvalds 已提交
282 283 284 285
	new->fl_flags = fl->fl_flags;
	new->fl_type = fl->fl_type;
	new->fl_start = fl->fl_start;
	new->fl_end = fl->fl_end;
286
	new->fl_lmops = fl->fl_lmops;
287
	new->fl_ops = NULL;
288 289 290 291 292

	if (fl->fl_lmops) {
		if (fl->fl_lmops->lm_get_owner)
			fl->fl_lmops->lm_get_owner(new, fl);
	}
293
}
294
EXPORT_SYMBOL(locks_copy_conflock);
295 296 297

void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
{
298 299
	/* "new" must be a freshly-initialized lock */
	WARN_ON_ONCE(new->fl_ops);
300

301
	locks_copy_conflock(new, fl);
302

303
	new->fl_file = fl->fl_file;
L
Linus Torvalds 已提交
304
	new->fl_ops = fl->fl_ops;
305

306 307 308 309
	if (fl->fl_ops) {
		if (fl->fl_ops->fl_copy_lock)
			fl->fl_ops->fl_copy_lock(new, fl);
	}
L
Linus Torvalds 已提交
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
}

EXPORT_SYMBOL(locks_copy_lock);

static inline int flock_translate_cmd(int cmd) {
	if (cmd & LOCK_MAND)
		return cmd & (LOCK_MAND | LOCK_RW);
	switch (cmd) {
	case LOCK_SH:
		return F_RDLCK;
	case LOCK_EX:
		return F_WRLCK;
	case LOCK_UN:
		return F_UNLCK;
	}
	return -EINVAL;
}

/* Fill in a file_lock structure with an appropriate FLOCK lock. */
static int flock_make_lock(struct file *filp, struct file_lock **lock,
		unsigned int cmd)
{
	struct file_lock *fl;
	int type = flock_translate_cmd(cmd);
	if (type < 0)
		return type;
	
	fl = locks_alloc_lock();
	if (fl == NULL)
		return -ENOMEM;

	fl->fl_file = filp;
342
	fl->fl_owner = filp;
L
Linus Torvalds 已提交
343 344 345 346 347 348 349 350 351
	fl->fl_pid = current->tgid;
	fl->fl_flags = FL_FLOCK;
	fl->fl_type = type;
	fl->fl_end = OFFSET_MAX;
	
	*lock = fl;
	return 0;
}

352
static int assign_type(struct file_lock *fl, long type)
L
Linus Torvalds 已提交
353 354 355 356 357 358 359 360 361 362 363 364 365
{
	switch (type) {
	case F_RDLCK:
	case F_WRLCK:
	case F_UNLCK:
		fl->fl_type = type;
		break;
	default:
		return -EINVAL;
	}
	return 0;
}

366 367
static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
				 struct flock64 *l)
L
Linus Torvalds 已提交
368 369
{
	switch (l->l_whence) {
370
	case SEEK_SET:
371
		fl->fl_start = 0;
L
Linus Torvalds 已提交
372
		break;
373
	case SEEK_CUR:
374
		fl->fl_start = filp->f_pos;
L
Linus Torvalds 已提交
375
		break;
376
	case SEEK_END:
377
		fl->fl_start = i_size_read(file_inode(filp));
L
Linus Torvalds 已提交
378 379 380 381
		break;
	default:
		return -EINVAL;
	}
382 383 384 385 386
	if (l->l_start > OFFSET_MAX - fl->fl_start)
		return -EOVERFLOW;
	fl->fl_start += l->l_start;
	if (fl->fl_start < 0)
		return -EINVAL;
L
Linus Torvalds 已提交
387 388 389

	/* POSIX-1996 leaves the case l->l_len < 0 undefined;
	   POSIX-2001 defines it. */
390
	if (l->l_len > 0) {
391 392 393 394
		if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
			return -EOVERFLOW;
		fl->fl_end = fl->fl_start + l->l_len - 1;

395
	} else if (l->l_len < 0) {
396
		if (fl->fl_start + l->l_len < 0)
397
			return -EINVAL;
398 399 400 401 402
		fl->fl_end = fl->fl_start - 1;
		fl->fl_start += l->l_len;
	} else
		fl->fl_end = OFFSET_MAX;

L
Linus Torvalds 已提交
403 404 405 406 407 408 409 410 411 412
	fl->fl_owner = current->files;
	fl->fl_pid = current->tgid;
	fl->fl_file = filp;
	fl->fl_flags = FL_POSIX;
	fl->fl_ops = NULL;
	fl->fl_lmops = NULL;

	return assign_type(fl, l->l_type);
}

413 414 415 416 417
/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
 * style lock.
 */
static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
			       struct flock *l)
L
Linus Torvalds 已提交
418
{
419 420 421 422 423 424 425 426
	struct flock64 ll = {
		.l_type = l->l_type,
		.l_whence = l->l_whence,
		.l_start = l->l_start,
		.l_len = l->l_len,
	};

	return flock64_to_posix_lock(filp, fl, &ll);
L
Linus Torvalds 已提交
427 428 429 430 431 432 433 434
}

/* default lease lock manager operations */
static void lease_break_callback(struct file_lock *fl)
{
	kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
}

435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
static void
lease_setup(struct file_lock *fl, void **priv)
{
	struct file *filp = fl->fl_file;
	struct fasync_struct *fa = *priv;

	/*
	 * fasync_insert_entry() returns the old entry if any. If there was no
	 * old entry, then it used "priv" and inserted it into the fasync list.
	 * Clear the pointer to indicate that it shouldn't be freed.
	 */
	if (!fasync_insert_entry(fa->fa_fd, filp, &fl->fl_fasync, fa))
		*priv = NULL;

	__f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
}

452
static const struct lock_manager_operations lease_manager_ops = {
J
J. Bruce Fields 已提交
453 454
	.lm_break = lease_break_callback,
	.lm_change = lease_modify,
455
	.lm_setup = lease_setup,
L
Linus Torvalds 已提交
456 457 458 459 460
};

/*
 * Initialize a lease, use the default lock manager operations
 */
461
static int lease_init(struct file *filp, long type, struct file_lock *fl)
L
Linus Torvalds 已提交
462
 {
463 464 465
	if (assign_type(fl, type) != 0)
		return -EINVAL;

466
	fl->fl_owner = current->files;
L
Linus Torvalds 已提交
467 468 469 470 471 472 473 474 475 476 477 478
	fl->fl_pid = current->tgid;

	fl->fl_file = filp;
	fl->fl_flags = FL_LEASE;
	fl->fl_start = 0;
	fl->fl_end = OFFSET_MAX;
	fl->fl_ops = NULL;
	fl->fl_lmops = &lease_manager_ops;
	return 0;
}

/* Allocate a file_lock initialised to this type of lease */
479
static struct file_lock *lease_alloc(struct file *filp, long type)
L
Linus Torvalds 已提交
480 481
{
	struct file_lock *fl = locks_alloc_lock();
482
	int error = -ENOMEM;
L
Linus Torvalds 已提交
483 484

	if (fl == NULL)
J
J. Bruce Fields 已提交
485
		return ERR_PTR(error);
L
Linus Torvalds 已提交
486 487

	error = lease_init(filp, type, fl);
488 489
	if (error) {
		locks_free_lock(fl);
J
J. Bruce Fields 已提交
490
		return ERR_PTR(error);
491
	}
J
J. Bruce Fields 已提交
492
	return fl;
L
Linus Torvalds 已提交
493 494 495 496 497 498 499 500 501 502 503 504 505
}

/* Check if two locks overlap each other.
 */
static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
{
	return ((fl1->fl_end >= fl2->fl_start) &&
		(fl2->fl_end >= fl1->fl_start));
}

/*
 * Check whether two locks have the same owner.
 */
506
static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
L
Linus Torvalds 已提交
507
{
J
J. Bruce Fields 已提交
508
	if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
L
Linus Torvalds 已提交
509
		return fl2->fl_lmops == fl1->fl_lmops &&
J
J. Bruce Fields 已提交
510
			fl1->fl_lmops->lm_compare_owner(fl1, fl2);
L
Linus Torvalds 已提交
511 512 513
	return fl1->fl_owner == fl2->fl_owner;
}

514
/* Must be called with the i_lock held! */
515
static void locks_insert_global_locks(struct file_lock *fl)
516
{
517 518 519 520
	lg_local_lock(&file_lock_lglock);
	fl->fl_link_cpu = smp_processor_id();
	hlist_add_head(&fl->fl_link, this_cpu_ptr(&file_lock_list));
	lg_local_unlock(&file_lock_lglock);
521 522
}

523
/* Must be called with the i_lock held! */
524
static void locks_delete_global_locks(struct file_lock *fl)
525
{
526 527 528 529 530 531 532 533
	/*
	 * Avoid taking lock if already unhashed. This is safe since this check
	 * is done while holding the i_lock, and new insertions into the list
	 * also require that it be held.
	 */
	if (hlist_unhashed(&fl->fl_link))
		return;
	lg_local_lock_cpu(&file_lock_lglock, fl->fl_link_cpu);
534
	hlist_del_init(&fl->fl_link);
535
	lg_local_unlock_cpu(&file_lock_lglock, fl->fl_link_cpu);
536 537
}

538 539 540 541 542 543 544 545
static unsigned long
posix_owner_key(struct file_lock *fl)
{
	if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
		return fl->fl_lmops->lm_owner_key(fl);
	return (unsigned long)fl->fl_owner;
}

546
static void locks_insert_global_blocked(struct file_lock *waiter)
547
{
548
	hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
549 550
}

551
static void locks_delete_global_blocked(struct file_lock *waiter)
552
{
553
	hash_del(&waiter->fl_link);
554 555
}

L
Linus Torvalds 已提交
556 557
/* Remove waiter from blocker's block list.
 * When blocker ends up pointing to itself then the list is empty.
558
 *
559
 * Must be called with blocked_lock_lock held.
L
Linus Torvalds 已提交
560
 */
561
static void __locks_delete_block(struct file_lock *waiter)
L
Linus Torvalds 已提交
562
{
563
	locks_delete_global_blocked(waiter);
L
Linus Torvalds 已提交
564 565 566 567
	list_del_init(&waiter->fl_block);
	waiter->fl_next = NULL;
}

568
static void locks_delete_block(struct file_lock *waiter)
L
Linus Torvalds 已提交
569
{
570
	spin_lock(&blocked_lock_lock);
L
Linus Torvalds 已提交
571
	__locks_delete_block(waiter);
572
	spin_unlock(&blocked_lock_lock);
L
Linus Torvalds 已提交
573 574 575 576 577 578
}

/* Insert waiter into blocker's block list.
 * We use a circular list so that processes can be easily woken up in
 * the order they blocked. The documentation doesn't require this but
 * it seems like the reasonable thing to do.
579
 *
580
 * Must be called with both the i_lock and blocked_lock_lock held. The fl_block
J
Jeff Layton 已提交
581
 * list itself is protected by the blocked_lock_lock, but by ensuring that the
582
 * i_lock is also held on insertions we can avoid taking the blocked_lock_lock
583
 * in some cases when we see that the fl_block list is empty.
L
Linus Torvalds 已提交
584
 */
585 586
static void __locks_insert_block(struct file_lock *blocker,
					struct file_lock *waiter)
L
Linus Torvalds 已提交
587
{
588
	BUG_ON(!list_empty(&waiter->fl_block));
L
Linus Torvalds 已提交
589
	waiter->fl_next = blocker;
590
	list_add_tail(&waiter->fl_block, &blocker->fl_block);
591
	if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
592 593 594 595 596 597 598
		locks_insert_global_blocked(waiter);
}

/* Must be called with i_lock held. */
static void locks_insert_block(struct file_lock *blocker,
					struct file_lock *waiter)
{
599
	spin_lock(&blocked_lock_lock);
600
	__locks_insert_block(blocker, waiter);
601
	spin_unlock(&blocked_lock_lock);
L
Linus Torvalds 已提交
602 603
}

604 605 606
/*
 * Wake up processes blocked waiting for blocker.
 *
607
 * Must be called with the inode->i_lock held!
L
Linus Torvalds 已提交
608 609 610
 */
static void locks_wake_up_blocks(struct file_lock *blocker)
{
611 612 613 614 615
	/*
	 * Avoid taking global lock if list is empty. This is safe since new
	 * blocked requests are only added to the list under the i_lock, and
	 * the i_lock is always held here. Note that removal from the fl_block
	 * list does not require the i_lock, so we must recheck list_empty()
616
	 * after acquiring the blocked_lock_lock.
617 618 619 620
	 */
	if (list_empty(&blocker->fl_block))
		return;

621
	spin_lock(&blocked_lock_lock);
L
Linus Torvalds 已提交
622
	while (!list_empty(&blocker->fl_block)) {
623 624 625
		struct file_lock *waiter;

		waiter = list_first_entry(&blocker->fl_block,
L
Linus Torvalds 已提交
626 627
				struct file_lock, fl_block);
		__locks_delete_block(waiter);
J
J. Bruce Fields 已提交
628 629
		if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
			waiter->fl_lmops->lm_notify(waiter);
L
Linus Torvalds 已提交
630 631 632
		else
			wake_up(&waiter->fl_wait);
	}
633
	spin_unlock(&blocked_lock_lock);
L
Linus Torvalds 已提交
634 635 636 637
}

/* Insert file lock fl into an inode's lock list at the position indicated
 * by pos. At the same time add the lock to the global file lock list.
638 639
 *
 * Must be called with the i_lock held!
L
Linus Torvalds 已提交
640 641 642
 */
static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
{
643 644
	fl->fl_nspid = get_pid(task_tgid(current));

L
Linus Torvalds 已提交
645 646 647
	/* insert into file's list */
	fl->fl_next = *pos;
	*pos = fl;
648 649

	locks_insert_global_locks(fl);
L
Linus Torvalds 已提交
650 651
}

652 653 654 655 656 657 658 659
/**
 * locks_delete_lock - Delete a lock and then free it.
 * @thisfl_p: pointer that points to the fl_next field of the previous
 * 	      inode->i_flock list entry
 *
 * Unlink a lock from all lists and free the namespace reference, but don't
 * free it yet. Wake up processes that are blocked waiting for this lock and
 * notify the FS that the lock has been cleared.
660 661
 *
 * Must be called with the i_lock held!
L
Linus Torvalds 已提交
662
 */
663
static void locks_unlink_lock(struct file_lock **thisfl_p)
L
Linus Torvalds 已提交
664 665 666
{
	struct file_lock *fl = *thisfl_p;

667 668
	locks_delete_global_locks(fl);

L
Linus Torvalds 已提交
669 670 671
	*thisfl_p = fl->fl_next;
	fl->fl_next = NULL;

672 673 674 675 676
	if (fl->fl_nspid) {
		put_pid(fl->fl_nspid);
		fl->fl_nspid = NULL;
	}

L
Linus Torvalds 已提交
677
	locks_wake_up_blocks(fl);
678 679 680 681 682 683 684
}

/*
 * Unlink a lock from all lists and free it.
 *
 * Must be called with i_lock held!
 */
685 686
static void locks_delete_lock(struct file_lock **thisfl_p,
			      struct list_head *dispose)
687 688 689 690
{
	struct file_lock *fl = *thisfl_p;

	locks_unlink_lock(thisfl_p);
691 692 693 694
	if (dispose)
		list_add(&fl->fl_block, dispose);
	else
		locks_free_lock(fl);
L
Linus Torvalds 已提交
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
}

/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
 * checks for shared/exclusive status of overlapping locks.
 */
static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
{
	if (sys_fl->fl_type == F_WRLCK)
		return 1;
	if (caller_fl->fl_type == F_WRLCK)
		return 1;
	return 0;
}

/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
 * checking before calling the locks_conflict().
 */
static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
{
	/* POSIX locks owned by the same process do not conflict with
	 * each other.
	 */
	if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
		return (0);

	/* Check whether they overlap */
	if (!locks_overlap(caller_fl, sys_fl))
		return 0;

	return (locks_conflict(caller_fl, sys_fl));
}

/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
 * checking before calling the locks_conflict().
 */
static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
{
	/* FLOCK locks referring to the same filp do not conflict with
	 * each other.
	 */
	if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
		return (0);
	if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
		return 0;

	return (locks_conflict(caller_fl, sys_fl));
}

743
void
744
posix_test_lock(struct file *filp, struct file_lock *fl)
L
Linus Torvalds 已提交
745 746
{
	struct file_lock *cfl;
747
	struct inode *inode = file_inode(filp);
L
Linus Torvalds 已提交
748

749
	spin_lock(&inode->i_lock);
A
Al Viro 已提交
750
	for (cfl = file_inode(filp)->i_flock; cfl; cfl = cfl->fl_next) {
L
Linus Torvalds 已提交
751 752
		if (!IS_POSIX(cfl))
			continue;
753
		if (posix_locks_conflict(fl, cfl))
L
Linus Torvalds 已提交
754 755
			break;
	}
756
	if (cfl) {
757
		locks_copy_conflock(fl, cfl);
758
		if (cfl->fl_nspid)
759
			fl->fl_pid = pid_vnr(cfl->fl_nspid);
760
	} else
761
		fl->fl_type = F_UNLCK;
762
	spin_unlock(&inode->i_lock);
763
	return;
L
Linus Torvalds 已提交
764 765 766
}
EXPORT_SYMBOL(posix_test_lock);

767 768 769 770 771
/*
 * Deadlock detection:
 *
 * We attempt to detect deadlocks that are due purely to posix file
 * locks.
L
Linus Torvalds 已提交
772
 *
773 774 775 776 777 778 779
 * We assume that a task can be waiting for at most one lock at a time.
 * So for any acquired lock, the process holding that lock may be
 * waiting on at most one other lock.  That lock in turns may be held by
 * someone waiting for at most one other lock.  Given a requested lock
 * caller_fl which is about to wait for a conflicting lock block_fl, we
 * follow this chain of waiters to ensure we are not about to create a
 * cycle.
L
Linus Torvalds 已提交
780
 *
781 782 783
 * Since we do this before we ever put a process to sleep on a lock, we
 * are ensured that there is never a cycle; that is what guarantees that
 * the while() loop in posix_locks_deadlock() eventually completes.
784
 *
785 786 787 788
 * Note: the above assumption may not be true when handling lock
 * requests from a broken NFS client. It may also fail in the presence
 * of tasks (such as posix threads) sharing the same open file table.
 * To handle those cases, we just bail out after a few iterations.
789
 *
790
 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
791 792 793 794
 * Because the owner is not even nominally tied to a thread of
 * execution, the deadlock detection below can't reasonably work well. Just
 * skip it for those.
 *
795
 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
796 797
 * locks that just checks for the case where two tasks are attempting to
 * upgrade from read to write locks on the same inode.
L
Linus Torvalds 已提交
798
 */
799 800 801

#define MAX_DEADLK_ITERATIONS 10

802 803 804 805 806
/* Find a lock that the owner of the given block_fl is blocking on. */
static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
{
	struct file_lock *fl;

807
	hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
808 809 810 811 812 813
		if (posix_same_owner(fl, block_fl))
			return fl->fl_next;
	}
	return NULL;
}

814
/* Must be called with the blocked_lock_lock held! */
815
static int posix_locks_deadlock(struct file_lock *caller_fl,
L
Linus Torvalds 已提交
816 817
				struct file_lock *block_fl)
{
818
	int i = 0;
L
Linus Torvalds 已提交
819

820 821
	/*
	 * This deadlock detector can't reasonably detect deadlocks with
822
	 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
823
	 */
824
	if (IS_OFDLCK(caller_fl))
825 826
		return 0;

827 828 829 830 831
	while ((block_fl = what_owner_is_waiting_for(block_fl))) {
		if (i++ > MAX_DEADLK_ITERATIONS)
			return 0;
		if (posix_same_owner(caller_fl, block_fl))
			return 1;
L
Linus Torvalds 已提交
832 833 834 835 836
	}
	return 0;
}

/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
837
 * after any leases, but before any posix locks.
838 839 840 841
 *
 * Note that if called with an FL_EXISTS argument, the caller may determine
 * whether or not a lock was successfully freed by testing the return
 * value for -ENOENT.
L
Linus Torvalds 已提交
842
 */
843
static int flock_lock_file(struct file *filp, struct file_lock *request)
L
Linus Torvalds 已提交
844
{
845
	struct file_lock *new_fl = NULL;
L
Linus Torvalds 已提交
846
	struct file_lock **before;
A
Al Viro 已提交
847
	struct inode * inode = file_inode(filp);
L
Linus Torvalds 已提交
848 849
	int error = 0;
	int found = 0;
850
	LIST_HEAD(dispose);
L
Linus Torvalds 已提交
851

852
	if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
853
		new_fl = locks_alloc_lock();
854 855
		if (!new_fl)
			return -ENOMEM;
856 857
	}

858
	spin_lock(&inode->i_lock);
859 860 861
	if (request->fl_flags & FL_ACCESS)
		goto find_conflict;

L
Linus Torvalds 已提交
862 863 864 865 866 867 868 869
	for_each_lock(inode, before) {
		struct file_lock *fl = *before;
		if (IS_POSIX(fl))
			break;
		if (IS_LEASE(fl))
			continue;
		if (filp != fl->fl_file)
			continue;
870
		if (request->fl_type == fl->fl_type)
L
Linus Torvalds 已提交
871 872
			goto out;
		found = 1;
873
		locks_delete_lock(before, &dispose);
L
Linus Torvalds 已提交
874 875 876
		break;
	}

877 878 879
	if (request->fl_type == F_UNLCK) {
		if ((request->fl_flags & FL_EXISTS) && !found)
			error = -ENOENT;
880
		goto out;
881
	}
L
Linus Torvalds 已提交
882 883 884 885 886

	/*
	 * If a higher-priority process was blocked on the old file lock,
	 * give it the opportunity to lock the file.
	 */
887
	if (found) {
888
		spin_unlock(&inode->i_lock);
889
		cond_resched();
890
		spin_lock(&inode->i_lock);
891
	}
L
Linus Torvalds 已提交
892

893
find_conflict:
L
Linus Torvalds 已提交
894 895 896 897 898 899
	for_each_lock(inode, before) {
		struct file_lock *fl = *before;
		if (IS_POSIX(fl))
			break;
		if (IS_LEASE(fl))
			continue;
900
		if (!flock_locks_conflict(request, fl))
L
Linus Torvalds 已提交
901 902
			continue;
		error = -EAGAIN;
903 904 905 906
		if (!(request->fl_flags & FL_SLEEP))
			goto out;
		error = FILE_LOCK_DEFERRED;
		locks_insert_block(fl, request);
L
Linus Torvalds 已提交
907 908
		goto out;
	}
909 910
	if (request->fl_flags & FL_ACCESS)
		goto out;
911
	locks_copy_lock(new_fl, request);
P
Pavel Emelyanov 已提交
912
	locks_insert_lock(before, new_fl);
913
	new_fl = NULL;
914
	error = 0;
L
Linus Torvalds 已提交
915 916

out:
917
	spin_unlock(&inode->i_lock);
918 919
	if (new_fl)
		locks_free_lock(new_fl);
920
	locks_dispose_list(&dispose);
L
Linus Torvalds 已提交
921 922 923
	return error;
}

924
static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
L
Linus Torvalds 已提交
925 926
{
	struct file_lock *fl;
927 928
	struct file_lock *new_fl = NULL;
	struct file_lock *new_fl2 = NULL;
L
Linus Torvalds 已提交
929 930 931
	struct file_lock *left = NULL;
	struct file_lock *right = NULL;
	struct file_lock **before;
932 933
	int error;
	bool added = false;
934
	LIST_HEAD(dispose);
L
Linus Torvalds 已提交
935 936 937 938

	/*
	 * We may need two file_lock structures for this operation,
	 * so we get them in advance to avoid races.
939 940
	 *
	 * In some cases we can be sure, that no new locks will be needed
L
Linus Torvalds 已提交
941
	 */
942 943 944 945 946 947
	if (!(request->fl_flags & FL_ACCESS) &&
	    (request->fl_type != F_UNLCK ||
	     request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
		new_fl = locks_alloc_lock();
		new_fl2 = locks_alloc_lock();
	}
L
Linus Torvalds 已提交
948

949
	spin_lock(&inode->i_lock);
950 951 952
	/*
	 * New lock request. Walk all POSIX locks and look for conflicts. If
	 * there are any, either return error or put the request on the
953
	 * blocker's list of waiters and the global blocked_hash.
954
	 */
L
Linus Torvalds 已提交
955 956
	if (request->fl_type != F_UNLCK) {
		for_each_lock(inode, before) {
957
			fl = *before;
L
Linus Torvalds 已提交
958 959 960 961
			if (!IS_POSIX(fl))
				continue;
			if (!posix_locks_conflict(request, fl))
				continue;
962
			if (conflock)
963
				locks_copy_conflock(conflock, fl);
L
Linus Torvalds 已提交
964 965 966
			error = -EAGAIN;
			if (!(request->fl_flags & FL_SLEEP))
				goto out;
967 968 969 970
			/*
			 * Deadlock detection and insertion into the blocked
			 * locks list must be done while holding the same lock!
			 */
L
Linus Torvalds 已提交
971
			error = -EDEADLK;
972
			spin_lock(&blocked_lock_lock);
973 974 975 976
			if (likely(!posix_locks_deadlock(request, fl))) {
				error = FILE_LOCK_DEFERRED;
				__locks_insert_block(fl, request);
			}
977
			spin_unlock(&blocked_lock_lock);
L
Linus Torvalds 已提交
978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998
			goto out;
  		}
  	}

	/* If we're just looking for a conflict, we're done. */
	error = 0;
	if (request->fl_flags & FL_ACCESS)
		goto out;

	/*
	 * Find the first old lock with the same owner as the new lock.
	 */
	
	before = &inode->i_flock;

	/* First skip locks owned by other processes.  */
	while ((fl = *before) && (!IS_POSIX(fl) ||
				  !posix_same_owner(request, fl))) {
		before = &fl->fl_next;
	}

999
	/* Process locks with this owner. */
L
Linus Torvalds 已提交
1000 1001 1002 1003
	while ((fl = *before) && posix_same_owner(request, fl)) {
		/* Detect adjacent or overlapping regions (if same lock type)
		 */
		if (request->fl_type == fl->fl_type) {
O
Olaf Kirch 已提交
1004 1005 1006 1007
			/* In all comparisons of start vs end, use
			 * "start - 1" rather than "end + 1". If end
			 * is OFFSET_MAX, end + 1 will become negative.
			 */
L
Linus Torvalds 已提交
1008 1009 1010 1011 1012
			if (fl->fl_end < request->fl_start - 1)
				goto next_lock;
			/* If the next lock in the list has entirely bigger
			 * addresses than the new one, insert the lock here.
			 */
O
Olaf Kirch 已提交
1013
			if (fl->fl_start - 1 > request->fl_end)
L
Linus Torvalds 已提交
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
				break;

			/* If we come here, the new and old lock are of the
			 * same type and adjacent or overlapping. Make one
			 * lock yielding from the lower start address of both
			 * locks to the higher end address.
			 */
			if (fl->fl_start > request->fl_start)
				fl->fl_start = request->fl_start;
			else
				request->fl_start = fl->fl_start;
			if (fl->fl_end < request->fl_end)
				fl->fl_end = request->fl_end;
			else
				request->fl_end = fl->fl_end;
			if (added) {
1030
				locks_delete_lock(before, &dispose);
L
Linus Torvalds 已提交
1031 1032 1033
				continue;
			}
			request = fl;
1034
			added = true;
L
Linus Torvalds 已提交
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
		}
		else {
			/* Processing for different lock types is a bit
			 * more complex.
			 */
			if (fl->fl_end < request->fl_start)
				goto next_lock;
			if (fl->fl_start > request->fl_end)
				break;
			if (request->fl_type == F_UNLCK)
1045
				added = true;
L
Linus Torvalds 已提交
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
			if (fl->fl_start < request->fl_start)
				left = fl;
			/* If the next lock in the list has a higher end
			 * address than the new one, insert the new one here.
			 */
			if (fl->fl_end > request->fl_end) {
				right = fl;
				break;
			}
			if (fl->fl_start >= request->fl_start) {
				/* The new lock completely replaces an old
				 * one (This may happen several times).
				 */
				if (added) {
1060
					locks_delete_lock(before, &dispose);
L
Linus Torvalds 已提交
1061 1062
					continue;
				}
1063 1064 1065 1066 1067 1068
				/*
				 * Replace the old lock with new_fl, and
				 * remove the old one. It's safe to do the
				 * insert here since we know that we won't be
				 * using new_fl later, and that the lock is
				 * just replacing an existing lock.
L
Linus Torvalds 已提交
1069
				 */
1070 1071 1072 1073 1074 1075
				error = -ENOLCK;
				if (!new_fl)
					goto out;
				locks_copy_lock(new_fl, request);
				request = new_fl;
				new_fl = NULL;
1076
				locks_delete_lock(before, &dispose);
1077
				locks_insert_lock(before, request);
1078
				added = true;
L
Linus Torvalds 已提交
1079 1080 1081 1082 1083 1084 1085 1086
			}
		}
		/* Go on to next lock.
		 */
	next_lock:
		before = &fl->fl_next;
	}

1087
	/*
1088 1089 1090
	 * The above code only modifies existing locks in case of merging or
	 * replacing. If new lock(s) need to be inserted all modifications are
	 * done below this, so it's safe yet to bail out.
1091 1092 1093 1094 1095
	 */
	error = -ENOLCK; /* "no luck" */
	if (right && left == right && !new_fl2)
		goto out;

L
Linus Torvalds 已提交
1096 1097
	error = 0;
	if (!added) {
1098 1099 1100
		if (request->fl_type == F_UNLCK) {
			if (request->fl_flags & FL_EXISTS)
				error = -ENOENT;
L
Linus Torvalds 已提交
1101
			goto out;
1102
		}
1103 1104 1105 1106 1107

		if (!new_fl) {
			error = -ENOLCK;
			goto out;
		}
L
Linus Torvalds 已提交
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
		locks_copy_lock(new_fl, request);
		locks_insert_lock(before, new_fl);
		new_fl = NULL;
	}
	if (right) {
		if (left == right) {
			/* The new lock breaks the old one in two pieces,
			 * so we have to use the second new lock.
			 */
			left = new_fl2;
			new_fl2 = NULL;
			locks_copy_lock(left, right);
			locks_insert_lock(before, left);
		}
		right->fl_start = request->fl_end + 1;
		locks_wake_up_blocks(right);
	}
	if (left) {
		left->fl_end = request->fl_start - 1;
		locks_wake_up_blocks(left);
	}
 out:
1130
	spin_unlock(&inode->i_lock);
L
Linus Torvalds 已提交
1131 1132 1133 1134 1135 1136 1137
	/*
	 * Free any unused locks.
	 */
	if (new_fl)
		locks_free_lock(new_fl);
	if (new_fl2)
		locks_free_lock(new_fl2);
1138
	locks_dispose_list(&dispose);
L
Linus Torvalds 已提交
1139 1140 1141 1142 1143 1144 1145
	return error;
}

/**
 * posix_lock_file - Apply a POSIX-style lock to a file
 * @filp: The file to apply the lock to
 * @fl: The lock to be applied
1146
 * @conflock: Place to return a copy of the conflicting lock, if found.
L
Linus Torvalds 已提交
1147 1148 1149 1150
 *
 * Add a POSIX style lock to a file.
 * We merge adjacent & overlapping locks whenever possible.
 * POSIX locks are sorted by owner task, then by starting address
1151 1152 1153 1154
 *
 * Note that if called with an FL_EXISTS argument, the caller may determine
 * whether or not a lock was successfully freed by testing the return
 * value for -ENOENT.
L
Linus Torvalds 已提交
1155
 */
1156
int posix_lock_file(struct file *filp, struct file_lock *fl,
1157 1158
			struct file_lock *conflock)
{
A
Al Viro 已提交
1159
	return __posix_lock_file(file_inode(filp), fl, conflock);
L
Linus Torvalds 已提交
1160
}
1161
EXPORT_SYMBOL(posix_lock_file);
L
Linus Torvalds 已提交
1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176

/**
 * posix_lock_file_wait - Apply a POSIX-style lock to a file
 * @filp: The file to apply the lock to
 * @fl: The lock to be applied
 *
 * Add a POSIX style lock to a file.
 * We merge adjacent & overlapping locks whenever possible.
 * POSIX locks are sorted by owner task, then by starting address
 */
int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
{
	int error;
	might_sleep ();
	for (;;) {
1177
		error = posix_lock_file(filp, fl, NULL);
1178
		if (error != FILE_LOCK_DEFERRED)
L
Linus Torvalds 已提交
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
			break;
		error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
		if (!error)
			continue;

		locks_delete_block(fl);
		break;
	}
	return error;
}
EXPORT_SYMBOL(posix_lock_file_wait);

/**
 * locks_mandatory_locked - Check for an active lock
1193
 * @file: the file to check
L
Linus Torvalds 已提交
1194 1195 1196 1197
 *
 * Searches the inode's list of locks to find any POSIX locks which conflict.
 * This function is called from locks_verify_locked() only.
 */
1198
int locks_mandatory_locked(struct file *file)
L
Linus Torvalds 已提交
1199
{
1200
	struct inode *inode = file_inode(file);
L
Linus Torvalds 已提交
1201 1202 1203 1204 1205
	struct file_lock *fl;

	/*
	 * Search the lock list for this inode for any POSIX locks.
	 */
1206
	spin_lock(&inode->i_lock);
L
Linus Torvalds 已提交
1207 1208 1209
	for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
		if (!IS_POSIX(fl))
			continue;
1210 1211
		if (fl->fl_owner != current->files &&
		    fl->fl_owner != file)
L
Linus Torvalds 已提交
1212 1213
			break;
	}
1214
	spin_unlock(&inode->i_lock);
L
Linus Torvalds 已提交
1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
	return fl ? -EAGAIN : 0;
}

/**
 * locks_mandatory_area - Check for a conflicting lock
 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
 *		for shared
 * @inode:      the file to check
 * @filp:       how the file was opened (if it was)
 * @offset:     start of area to check
 * @count:      length of area to check
 *
 * Searches the inode's list of locks to find any POSIX locks which conflict.
 * This function is called from rw_verify_area() and
 * locks_verify_truncate().
 */
int locks_mandatory_area(int read_write, struct inode *inode,
			 struct file *filp, loff_t offset,
			 size_t count)
{
	struct file_lock fl;
	int error;
1237
	bool sleep = false;
L
Linus Torvalds 已提交
1238 1239 1240 1241 1242 1243

	locks_init_lock(&fl);
	fl.fl_pid = current->tgid;
	fl.fl_file = filp;
	fl.fl_flags = FL_POSIX | FL_ACCESS;
	if (filp && !(filp->f_flags & O_NONBLOCK))
1244
		sleep = true;
L
Linus Torvalds 已提交
1245 1246 1247 1248 1249
	fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
	fl.fl_start = offset;
	fl.fl_end = offset + count - 1;

	for (;;) {
1250
		if (filp) {
1251
			fl.fl_owner = filp;
1252 1253 1254 1255 1256 1257 1258 1259 1260
			fl.fl_flags &= ~FL_SLEEP;
			error = __posix_lock_file(inode, &fl, NULL);
			if (!error)
				break;
		}

		if (sleep)
			fl.fl_flags |= FL_SLEEP;
		fl.fl_owner = current->files;
1261
		error = __posix_lock_file(inode, &fl, NULL);
1262
		if (error != FILE_LOCK_DEFERRED)
L
Linus Torvalds 已提交
1263 1264 1265 1266 1267 1268 1269
			break;
		error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
		if (!error) {
			/*
			 * If we've been sleeping someone might have
			 * changed the permissions behind our back.
			 */
1270
			if (__mandatory_lock(inode))
L
Linus Torvalds 已提交
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282
				continue;
		}

		locks_delete_block(&fl);
		break;
	}

	return error;
}

EXPORT_SYMBOL(locks_mandatory_area);

1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293
static void lease_clear_pending(struct file_lock *fl, int arg)
{
	switch (arg) {
	case F_UNLCK:
		fl->fl_flags &= ~FL_UNLOCK_PENDING;
		/* fall through: */
	case F_RDLCK:
		fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
	}
}

L
Linus Torvalds 已提交
1294
/* We already had a lease on this file; just change its type */
1295
int lease_modify(struct file_lock **before, int arg, struct list_head *dispose)
L
Linus Torvalds 已提交
1296 1297 1298 1299 1300 1301
{
	struct file_lock *fl = *before;
	int error = assign_type(fl, arg);

	if (error)
		return error;
1302
	lease_clear_pending(fl, arg);
L
Linus Torvalds 已提交
1303
	locks_wake_up_blocks(fl);
1304 1305 1306 1307 1308
	if (arg == F_UNLCK) {
		struct file *filp = fl->fl_file;

		f_delown(filp);
		filp->f_owner.signum = 0;
1309 1310 1311 1312 1313
		fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
		if (fl->fl_fasync != NULL) {
			printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
			fl->fl_fasync = NULL;
		}
1314
		locks_delete_lock(before, dispose);
1315
	}
L
Linus Torvalds 已提交
1316 1317 1318 1319
	return 0;
}
EXPORT_SYMBOL(lease_modify);

1320 1321 1322 1323 1324 1325 1326 1327
static bool past_time(unsigned long then)
{
	if (!then)
		/* 0 is a special value meaning "this never expires": */
		return false;
	return time_after(jiffies, then);
}

1328
static void time_out_leases(struct inode *inode, struct list_head *dispose)
L
Linus Torvalds 已提交
1329 1330 1331 1332
{
	struct file_lock **before;
	struct file_lock *fl;

1333 1334
	lockdep_assert_held(&inode->i_lock);

L
Linus Torvalds 已提交
1335
	before = &inode->i_flock;
J
J. Bruce Fields 已提交
1336
	while ((fl = *before) && IS_LEASE(fl) && lease_breaking(fl)) {
1337
		trace_time_out_leases(inode, fl);
1338
		if (past_time(fl->fl_downgrade_time))
1339
			lease_modify(before, F_RDLCK, dispose);
1340
		if (past_time(fl->fl_break_time))
1341
			lease_modify(before, F_UNLCK, dispose);
L
Linus Torvalds 已提交
1342 1343 1344 1345 1346
		if (fl == *before)	/* lease_modify may have freed fl */
			before = &fl->fl_next;
	}
}

J
J. Bruce Fields 已提交
1347 1348 1349 1350 1351 1352 1353
static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
{
	if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
		return false;
	return locks_conflict(breaker, lease);
}

L
Linus Torvalds 已提交
1354 1355 1356
/**
 *	__break_lease	-	revoke all outstanding leases on file
 *	@inode: the inode of the file to return
J
J. Bruce Fields 已提交
1357 1358 1359 1360
 *	@mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
 *	    break all leases
 *	@type: FL_LEASE: break leases and delegations; FL_DELEG: break
 *	    only delegations
L
Linus Torvalds 已提交
1361
 *
1362 1363 1364
 *	break_lease (inlined for speed) has checked there already is at least
 *	some kind of lock (maybe a lease) on this file.  Leases are broken on
 *	a call to open() or truncate().  This function can sleep unless you
L
Linus Torvalds 已提交
1365 1366
 *	specified %O_NONBLOCK to your open().
 */
J
J. Bruce Fields 已提交
1367
int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
L
Linus Torvalds 已提交
1368
{
1369
	int error = 0;
L
Linus Torvalds 已提交
1370 1371 1372 1373
	struct file_lock *new_fl, *flock;
	struct file_lock *fl;
	unsigned long break_time;
	int i_have_this_lease = 0;
J
J. Bruce Fields 已提交
1374
	bool lease_conflict = false;
1375
	int want_write = (mode & O_ACCMODE) != O_RDONLY;
1376
	LIST_HEAD(dispose);
L
Linus Torvalds 已提交
1377

1378
	new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
1379 1380
	if (IS_ERR(new_fl))
		return PTR_ERR(new_fl);
J
J. Bruce Fields 已提交
1381
	new_fl->fl_flags = type;
L
Linus Torvalds 已提交
1382

1383
	spin_lock(&inode->i_lock);
L
Linus Torvalds 已提交
1384

1385
	time_out_leases(inode, &dispose);
L
Linus Torvalds 已提交
1386 1387 1388 1389 1390

	flock = inode->i_flock;
	if ((flock == NULL) || !IS_LEASE(flock))
		goto out;

J
J. Bruce Fields 已提交
1391 1392 1393 1394 1395 1396 1397 1398
	for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
		if (leases_conflict(fl, new_fl)) {
			lease_conflict = true;
			if (fl->fl_owner == current->files)
				i_have_this_lease = 1;
		}
	}
	if (!lease_conflict)
1399 1400
		goto out;

L
Linus Torvalds 已提交
1401 1402 1403 1404 1405 1406 1407 1408
	break_time = 0;
	if (lease_break_time > 0) {
		break_time = jiffies + lease_break_time * HZ;
		if (break_time == 0)
			break_time++;	/* so that 0 means no break time */
	}

	for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
J
J. Bruce Fields 已提交
1409 1410
		if (!leases_conflict(fl, new_fl))
			continue;
1411 1412 1413 1414
		if (want_write) {
			if (fl->fl_flags & FL_UNLOCK_PENDING)
				continue;
			fl->fl_flags |= FL_UNLOCK_PENDING;
L
Linus Torvalds 已提交
1415
			fl->fl_break_time = break_time;
1416 1417 1418 1419 1420
		} else {
			if (lease_breaking(flock))
				continue;
			fl->fl_flags |= FL_DOWNGRADE_PENDING;
			fl->fl_downgrade_time = break_time;
L
Linus Torvalds 已提交
1421
		}
1422
		fl->fl_lmops->lm_break(fl);
L
Linus Torvalds 已提交
1423 1424 1425
	}

	if (i_have_this_lease || (mode & O_NONBLOCK)) {
1426
		trace_break_lease_noblock(inode, new_fl);
L
Linus Torvalds 已提交
1427 1428 1429 1430 1431 1432
		error = -EWOULDBLOCK;
		goto out;
	}

restart:
	break_time = flock->fl_break_time;
1433
	if (break_time != 0)
L
Linus Torvalds 已提交
1434
		break_time -= jiffies;
1435 1436
	if (break_time == 0)
		break_time++;
1437
	locks_insert_block(flock, new_fl);
1438
	trace_break_lease_block(inode, new_fl);
1439
	spin_unlock(&inode->i_lock);
1440
	locks_dispose_list(&dispose);
1441 1442
	error = wait_event_interruptible_timeout(new_fl->fl_wait,
						!new_fl->fl_next, break_time);
1443
	spin_lock(&inode->i_lock);
1444
	trace_break_lease_unblock(inode, new_fl);
1445
	locks_delete_block(new_fl);
L
Linus Torvalds 已提交
1446 1447
	if (error >= 0) {
		if (error == 0)
1448
			time_out_leases(inode, &dispose);
1449 1450 1451 1452
		/*
		 * Wait for the next conflicting lease that has not been
		 * broken yet
		 */
L
Linus Torvalds 已提交
1453 1454
		for (flock = inode->i_flock; flock && IS_LEASE(flock);
				flock = flock->fl_next) {
J
J. Bruce Fields 已提交
1455
			if (leases_conflict(new_fl, flock))
L
Linus Torvalds 已提交
1456 1457 1458 1459 1460 1461
				goto restart;
		}
		error = 0;
	}

out:
1462
	spin_unlock(&inode->i_lock);
1463
	locks_dispose_list(&dispose);
1464
	locks_free_lock(new_fl);
L
Linus Torvalds 已提交
1465 1466 1467 1468 1469 1470
	return error;
}

EXPORT_SYMBOL(__break_lease);

/**
1471
 *	lease_get_mtime - get the last modified time of an inode
L
Linus Torvalds 已提交
1472 1473 1474 1475 1476
 *	@inode: the inode
 *      @time:  pointer to a timespec which will contain the last modified time
 *
 * This is to force NFS clients to flush their caches for files with
 * exclusive leases.  The justification is that if someone has an
1477
 * exclusive lease, then they could be modifying it.
L
Linus Torvalds 已提交
1478 1479 1480
 */
void lease_get_mtime(struct inode *inode, struct timespec *time)
{
1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492
	bool has_lease = false;
	struct file_lock *flock;

	if (inode->i_flock) {
		spin_lock(&inode->i_lock);
		flock = inode->i_flock;
		if (flock && IS_LEASE(flock) && (flock->fl_type == F_WRLCK))
			has_lease = true;
		spin_unlock(&inode->i_lock);
	}

	if (has_lease)
L
Linus Torvalds 已提交
1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525
		*time = current_fs_time(inode->i_sb);
	else
		*time = inode->i_mtime;
}

EXPORT_SYMBOL(lease_get_mtime);

/**
 *	fcntl_getlease - Enquire what lease is currently active
 *	@filp: the file
 *
 *	The value returned by this function will be one of
 *	(if no lease break is pending):
 *
 *	%F_RDLCK to indicate a shared lease is held.
 *
 *	%F_WRLCK to indicate an exclusive lease is held.
 *
 *	%F_UNLCK to indicate no lease is held.
 *
 *	(if a lease break is pending):
 *
 *	%F_RDLCK to indicate an exclusive lease needs to be
 *		changed to a shared lease (or removed).
 *
 *	%F_UNLCK to indicate the lease needs to be removed.
 *
 *	XXX: sfr & willy disagree over whether F_INPROGRESS
 *	should be returned to userspace.
 */
int fcntl_getlease(struct file *filp)
{
	struct file_lock *fl;
1526
	struct inode *inode = file_inode(filp);
L
Linus Torvalds 已提交
1527
	int type = F_UNLCK;
1528
	LIST_HEAD(dispose);
L
Linus Torvalds 已提交
1529

1530
	spin_lock(&inode->i_lock);
1531
	time_out_leases(file_inode(filp), &dispose);
A
Al Viro 已提交
1532
	for (fl = file_inode(filp)->i_flock; fl && IS_LEASE(fl);
L
Linus Torvalds 已提交
1533 1534
			fl = fl->fl_next) {
		if (fl->fl_file == filp) {
1535
			type = target_leasetype(fl);
L
Linus Torvalds 已提交
1536 1537 1538
			break;
		}
	}
1539
	spin_unlock(&inode->i_lock);
1540
	locks_dispose_list(&dispose);
L
Linus Torvalds 已提交
1541 1542 1543
	return type;
}

1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
/**
 * check_conflicting_open - see if the given dentry points to a file that has
 * 			    an existing open that would conflict with the
 * 			    desired lease.
 * @dentry:	dentry to check
 * @arg:	type of lease that we're trying to acquire
 *
 * Check to see if there's an existing open fd on this file that would
 * conflict with the lease we're trying to set.
 */
static int
check_conflicting_open(const struct dentry *dentry, const long arg)
{
	int ret = 0;
	struct inode *inode = dentry->d_inode;

	if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
		return -EAGAIN;

	if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
	    (atomic_read(&inode->i_count) > 1)))
		ret = -EAGAIN;

	return ret;
}

1570 1571
static int
generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
L
Linus Torvalds 已提交
1572
{
1573
	struct file_lock *fl, **before, **my_before = NULL, *lease;
1574
	struct dentry *dentry = filp->f_path.dentry;
L
Linus Torvalds 已提交
1575
	struct inode *inode = dentry->d_inode;
J
J. Bruce Fields 已提交
1576
	bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J
J. Bruce Fields 已提交
1577
	int error;
1578
	LIST_HEAD(dispose);
L
Linus Torvalds 已提交
1579

1580
	lease = *flp;
1581 1582
	trace_generic_add_lease(inode, lease);

J
J. Bruce Fields 已提交
1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595
	/*
	 * In the delegation case we need mutual exclusion with
	 * a number of operations that take the i_mutex.  We trylock
	 * because delegations are an optional optimization, and if
	 * there's some chance of a conflict--we'd rather not
	 * bother, maybe that's a sign this just isn't a good file to
	 * hand out a delegation on.
	 */
	if (is_deleg && !mutex_trylock(&inode->i_mutex))
		return -EAGAIN;

	if (is_deleg && arg == F_WRLCK) {
		/* Write delegations are not currently supported: */
1596
		mutex_unlock(&inode->i_mutex);
J
J. Bruce Fields 已提交
1597 1598 1599
		WARN_ON_ONCE(1);
		return -EINVAL;
	}
1600

1601
	spin_lock(&inode->i_lock);
1602
	time_out_leases(inode, &dispose);
1603 1604
	error = check_conflicting_open(dentry, arg);
	if (error)
1605
		goto out;
1606

L
Linus Torvalds 已提交
1607 1608 1609 1610 1611 1612 1613 1614
	/*
	 * At this point, we know that if there is an exclusive
	 * lease on this file, then we hold it on this filp
	 * (otherwise our open of this file would have blocked).
	 * And if we are trying to acquire an exclusive lease,
	 * then the file is not open by anyone (including us)
	 * except for this filp.
	 */
J
J. Bruce Fields 已提交
1615
	error = -EAGAIN;
L
Linus Torvalds 已提交
1616 1617 1618
	for (before = &inode->i_flock;
			((fl = *before) != NULL) && IS_LEASE(fl);
			before = &fl->fl_next) {
J
J. Bruce Fields 已提交
1619
		if (fl->fl_file == filp) {
L
Linus Torvalds 已提交
1620
			my_before = before;
J
J. Bruce Fields 已提交
1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634
			continue;
		}
		/*
		 * No exclusive leases if someone else has a lease on
		 * this file:
		 */
		if (arg == F_WRLCK)
			goto out;
		/*
		 * Modifying our existing lease is OK, but no getting a
		 * new lease if someone else is opening for write:
		 */
		if (fl->fl_flags & FL_UNLOCK_PENDING)
			goto out;
L
Linus Torvalds 已提交
1635 1636 1637
	}

	if (my_before != NULL) {
1638
		lease = *my_before;
1639
		error = lease->fl_lmops->lm_change(my_before, arg, &dispose);
1640 1641 1642
		if (error)
			goto out;
		goto out_setup;
L
Linus Torvalds 已提交
1643 1644 1645 1646 1647 1648
	}

	error = -EINVAL;
	if (!leases_enable)
		goto out;

1649
	locks_insert_lock(before, lease);
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661
	/*
	 * The check in break_lease() is lockless. It's possible for another
	 * open to race in after we did the earlier check for a conflicting
	 * open but before the lease was inserted. Check again for a
	 * conflicting open and cancel the lease if there is one.
	 *
	 * We also add a barrier here to ensure that the insertion of the lock
	 * precedes these checks.
	 */
	smp_mb();
	error = check_conflicting_open(dentry, arg);
	if (error)
1662
		goto out_unlink;
1663 1664 1665 1666

out_setup:
	if (lease->fl_lmops->lm_setup)
		lease->fl_lmops->lm_setup(lease, priv);
L
Linus Torvalds 已提交
1667
out:
1668
	spin_unlock(&inode->i_lock);
1669
	locks_dispose_list(&dispose);
J
J. Bruce Fields 已提交
1670 1671
	if (is_deleg)
		mutex_unlock(&inode->i_mutex);
1672 1673
	if (!error && !my_before)
		*flp = NULL;
L
Linus Torvalds 已提交
1674
	return error;
1675 1676 1677
out_unlink:
	locks_unlink_lock(before);
	goto out;
L
Linus Torvalds 已提交
1678
}
1679

1680
static int generic_delete_lease(struct file *filp)
1681
{
1682
	int error = -EAGAIN;
1683 1684 1685
	struct file_lock *fl, **before;
	struct dentry *dentry = filp->f_path.dentry;
	struct inode *inode = dentry->d_inode;
1686
	LIST_HEAD(dispose);
1687

1688
	spin_lock(&inode->i_lock);
1689
	time_out_leases(inode, &dispose);
1690 1691 1692
	for (before = &inode->i_flock;
			((fl = *before) != NULL) && IS_LEASE(fl);
			before = &fl->fl_next) {
1693 1694
		if (fl->fl_file == filp)
			break;
1695
	}
1696 1697
	trace_generic_delete_lease(inode, fl);
	if (fl)
1698
		error = fl->fl_lmops->lm_change(before, F_UNLCK, &dispose);
1699
	spin_unlock(&inode->i_lock);
1700
	locks_dispose_list(&dispose);
1701
	return error;
1702 1703 1704 1705
}

/**
 *	generic_setlease	-	sets a lease on an open file
1706 1707 1708 1709 1710
 *	@filp:	file pointer
 *	@arg:	type of lease to obtain
 *	@flp:	input - file_lock to use, output - file_lock inserted
 *	@priv:	private data for lm_setup (may be NULL if lm_setup
 *		doesn't require it)
1711 1712 1713 1714
 *
 *	The (input) flp->fl_lmops->lm_break function is required
 *	by break_lease().
 */
1715 1716
int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
			void **priv)
1717 1718 1719 1720 1721
{
	struct dentry *dentry = filp->f_path.dentry;
	struct inode *inode = dentry->d_inode;
	int error;

1722
	if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
1723 1724 1725 1726 1727 1728 1729 1730 1731
		return -EACCES;
	if (!S_ISREG(inode->i_mode))
		return -EINVAL;
	error = security_file_lock(filp, arg);
	if (error)
		return error;

	switch (arg) {
	case F_UNLCK:
1732
		return generic_delete_lease(filp);
1733 1734
	case F_RDLCK:
	case F_WRLCK:
1735 1736 1737 1738
		if (!(*flp)->fl_lmops->lm_break) {
			WARN_ON_ONCE(1);
			return -ENOLCK;
		}
1739
		return generic_add_lease(filp, arg, flp, priv);
1740
	default:
1741
		return -EINVAL;
1742 1743
	}
}
1744
EXPORT_SYMBOL(generic_setlease);
L
Linus Torvalds 已提交
1745

1746
/**
1747
 * vfs_setlease        -       sets a lease on an open file
1748 1749 1750 1751 1752
 * @filp:	file pointer
 * @arg:	type of lease to obtain
 * @lease:	file_lock to use when adding a lease
 * @priv:	private info for lm_setup when adding a lease (may be
 * 		NULL if lm_setup doesn't require it)
1753 1754 1755 1756 1757 1758
 *
 * Call this to establish a lease on the file. The "lease" argument is not
 * used for F_UNLCK requests and may be NULL. For commands that set or alter
 * an existing lease, the (*lease)->fl_lmops->lm_break operation must be set;
 * if not, this function will return -ENOLCK (and generate a scary-looking
 * stack trace).
1759 1760 1761
 *
 * The "priv" pointer is passed directly to the lm_setup function as-is. It
 * may be NULL if the lm_setup operation doesn't require it.
L
Linus Torvalds 已提交
1762
 */
1763 1764
int
vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
L
Linus Torvalds 已提交
1765
{
1766
	if (filp->f_op->setlease)
1767
		return filp->f_op->setlease(filp, arg, lease, priv);
1768
	else
1769
		return generic_setlease(filp, arg, lease, priv);
L
Linus Torvalds 已提交
1770
}
1771
EXPORT_SYMBOL_GPL(vfs_setlease);
L
Linus Torvalds 已提交
1772

1773
static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
L
Linus Torvalds 已提交
1774
{
1775
	struct file_lock *fl;
1776
	struct fasync_struct *new;
L
Linus Torvalds 已提交
1777 1778
	int error;

1779 1780 1781
	fl = lease_alloc(filp, arg);
	if (IS_ERR(fl))
		return PTR_ERR(fl);
L
Linus Torvalds 已提交
1782

1783 1784 1785 1786 1787
	new = fasync_alloc();
	if (!new) {
		locks_free_lock(fl);
		return -ENOMEM;
	}
1788
	new->fa_fd = fd;
1789

1790
	error = vfs_setlease(filp, arg, &fl, (void **)&new);
1791 1792
	if (fl)
		locks_free_lock(fl);
1793 1794
	if (new)
		fasync_free(new);
L
Linus Torvalds 已提交
1795 1796 1797
	return error;
}

1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810
/**
 *	fcntl_setlease	-	sets a lease on an open file
 *	@fd: open file descriptor
 *	@filp: file pointer
 *	@arg: type of lease to obtain
 *
 *	Call this fcntl to establish a lease on the file.
 *	Note that you also need to call %F_SETSIG to
 *	receive a signal when the lease is broken.
 */
int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
{
	if (arg == F_UNLCK)
1811
		return vfs_setlease(filp, F_UNLCK, NULL, NULL);
1812 1813 1814
	return do_fcntl_add_lease(fd, filp, arg);
}

L
Linus Torvalds 已提交
1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827
/**
 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
 * @filp: The file to apply the lock to
 * @fl: The lock to be applied
 *
 * Add a FLOCK style lock to a file.
 */
int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
{
	int error;
	might_sleep();
	for (;;) {
		error = flock_lock_file(filp, fl);
1828
		if (error != FILE_LOCK_DEFERRED)
L
Linus Torvalds 已提交
1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860
			break;
		error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
		if (!error)
			continue;

		locks_delete_block(fl);
		break;
	}
	return error;
}

EXPORT_SYMBOL(flock_lock_file_wait);

/**
 *	sys_flock: - flock() system call.
 *	@fd: the file descriptor to lock.
 *	@cmd: the type of lock to apply.
 *
 *	Apply a %FL_FLOCK style lock to an open file descriptor.
 *	The @cmd can be one of
 *
 *	%LOCK_SH -- a shared lock.
 *
 *	%LOCK_EX -- an exclusive lock.
 *
 *	%LOCK_UN -- remove an existing lock.
 *
 *	%LOCK_MAND -- a `mandatory' flock.  This exists to emulate Windows Share Modes.
 *
 *	%LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
 *	processes read and write access respectively.
 */
1861
SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
L
Linus Torvalds 已提交
1862
{
1863
	struct fd f = fdget(fd);
L
Linus Torvalds 已提交
1864 1865 1866 1867 1868
	struct file_lock *lock;
	int can_sleep, unlock;
	int error;

	error = -EBADF;
1869
	if (!f.file)
L
Linus Torvalds 已提交
1870 1871 1872 1873 1874 1875
		goto out;

	can_sleep = !(cmd & LOCK_NB);
	cmd &= ~LOCK_NB;
	unlock = (cmd == LOCK_UN);

1876
	if (!unlock && !(cmd & LOCK_MAND) &&
1877
	    !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
L
Linus Torvalds 已提交
1878 1879
		goto out_putf;

1880
	error = flock_make_lock(f.file, &lock, cmd);
L
Linus Torvalds 已提交
1881 1882 1883 1884 1885
	if (error)
		goto out_putf;
	if (can_sleep)
		lock->fl_flags |= FL_SLEEP;

1886
	error = security_file_lock(f.file, lock->fl_type);
L
Linus Torvalds 已提交
1887 1888 1889
	if (error)
		goto out_free;

A
Al Viro 已提交
1890
	if (f.file->f_op->flock)
1891
		error = f.file->f_op->flock(f.file,
L
Linus Torvalds 已提交
1892 1893 1894
					  (can_sleep) ? F_SETLKW : F_SETLK,
					  lock);
	else
1895
		error = flock_lock_file_wait(f.file, lock);
L
Linus Torvalds 已提交
1896 1897

 out_free:
1898
	locks_free_lock(lock);
L
Linus Torvalds 已提交
1899 1900

 out_putf:
1901
	fdput(f);
L
Linus Torvalds 已提交
1902 1903 1904 1905
 out:
	return error;
}

1906 1907 1908
/**
 * vfs_test_lock - test file byte range lock
 * @filp: The file to test lock for
1909
 * @fl: The lock to test; also used to hold result
1910 1911 1912 1913 1914 1915
 *
 * Returns -ERRNO on failure.  Indicates presence of conflicting lock by
 * setting conf->fl_type to something other than F_UNLCK.
 */
int vfs_test_lock(struct file *filp, struct file_lock *fl)
{
A
Al Viro 已提交
1916
	if (filp->f_op->lock)
1917 1918 1919 1920 1921 1922
		return filp->f_op->lock(filp, F_GETLK, fl);
	posix_test_lock(filp, fl);
	return 0;
}
EXPORT_SYMBOL_GPL(vfs_test_lock);

1923 1924
static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
{
1925
	flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939
#if BITS_PER_LONG == 32
	/*
	 * Make sure we can represent the posix lock via
	 * legacy 32bit flock.
	 */
	if (fl->fl_start > OFFT_OFFSET_MAX)
		return -EOVERFLOW;
	if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
		return -EOVERFLOW;
#endif
	flock->l_start = fl->fl_start;
	flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
		fl->fl_end - fl->fl_start + 1;
	flock->l_whence = 0;
1940
	flock->l_type = fl->fl_type;
1941 1942 1943 1944 1945 1946
	return 0;
}

#if BITS_PER_LONG == 32
static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
{
1947
	flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
1948 1949 1950 1951 1952 1953 1954 1955
	flock->l_start = fl->fl_start;
	flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
		fl->fl_end - fl->fl_start + 1;
	flock->l_whence = 0;
	flock->l_type = fl->fl_type;
}
#endif

L
Linus Torvalds 已提交
1956 1957 1958
/* Report the first existing lock that would conflict with l.
 * This implements the F_GETLK command of fcntl().
 */
1959
int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock __user *l)
L
Linus Torvalds 已提交
1960
{
1961
	struct file_lock file_lock;
L
Linus Torvalds 已提交
1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975
	struct flock flock;
	int error;

	error = -EFAULT;
	if (copy_from_user(&flock, l, sizeof(flock)))
		goto out;
	error = -EINVAL;
	if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
		goto out;

	error = flock_to_posix_lock(filp, &file_lock, &flock);
	if (error)
		goto out;

1976
	if (cmd == F_OFD_GETLK) {
1977 1978 1979 1980
		error = -EINVAL;
		if (flock.l_pid != 0)
			goto out;

1981
		cmd = F_GETLK;
1982
		file_lock.fl_flags |= FL_OFDLCK;
1983
		file_lock.fl_owner = filp;
1984 1985
	}

1986 1987 1988
	error = vfs_test_lock(filp, &file_lock);
	if (error)
		goto out;
L
Linus Torvalds 已提交
1989
 
1990 1991 1992
	flock.l_type = file_lock.fl_type;
	if (file_lock.fl_type != F_UNLCK) {
		error = posix_lock_to_flock(&flock, &file_lock);
1993
		if (error)
1994
			goto rel_priv;
L
Linus Torvalds 已提交
1995 1996 1997 1998
	}
	error = -EFAULT;
	if (!copy_to_user(l, &flock, sizeof(flock)))
		error = 0;
1999 2000
rel_priv:
	locks_release_private(&file_lock);
L
Linus Torvalds 已提交
2001 2002 2003 2004
out:
	return error;
}

2005 2006 2007 2008 2009
/**
 * vfs_lock_file - file byte range lock
 * @filp: The file to apply the lock to
 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
 * @fl: The lock to be applied
2010 2011 2012 2013 2014 2015 2016 2017
 * @conf: Place to return a copy of the conflicting lock, if found.
 *
 * A caller that doesn't care about the conflicting lock may pass NULL
 * as the final argument.
 *
 * If the filesystem defines a private ->lock() method, then @conf will
 * be left unchanged; so a caller that cares should initialize it to
 * some acceptable default.
2018 2019 2020 2021
 *
 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
 * locks, the ->lock() interface may return asynchronously, before the lock has
 * been granted or denied by the underlying filesystem, if (and only if)
J
J. Bruce Fields 已提交
2022
 * lm_grant is set. Callers expecting ->lock() to return asynchronously
2023 2024
 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
 * the request is for a blocking lock. When ->lock() does return asynchronously,
J
J. Bruce Fields 已提交
2025
 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
2026 2027
 * request completes.
 * If the request is for non-blocking lock the file system should return
2028 2029
 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
 * with the result. If the request timed out the callback routine will return a
2030 2031 2032 2033 2034
 * nonzero return code and the file system should release the lock. The file
 * system is also responsible to keep a corresponding posix lock when it
 * grants a lock so the VFS can find out which locks are locally held and do
 * the correct lock cleanup when required.
 * The underlying filesystem must not drop the kernel lock or call
J
J. Bruce Fields 已提交
2035
 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
2036
 * return code.
2037
 */
2038
int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
2039
{
A
Al Viro 已提交
2040
	if (filp->f_op->lock)
2041 2042
		return filp->f_op->lock(filp, cmd, fl);
	else
2043
		return posix_lock_file(filp, fl, conf);
2044 2045 2046
}
EXPORT_SYMBOL_GPL(vfs_lock_file);

M
Miklos Szeredi 已提交
2047 2048 2049 2050 2051 2052 2053 2054 2055
static int do_lock_file_wait(struct file *filp, unsigned int cmd,
			     struct file_lock *fl)
{
	int error;

	error = security_file_lock(filp, fl->fl_type);
	if (error)
		return error;

2056 2057 2058
	for (;;) {
		error = vfs_lock_file(filp, cmd, fl, NULL);
		if (error != FILE_LOCK_DEFERRED)
M
Miklos Szeredi 已提交
2059
			break;
2060 2061 2062 2063 2064 2065
		error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
		if (!error)
			continue;

		locks_delete_block(fl);
		break;
M
Miklos Szeredi 已提交
2066 2067 2068 2069 2070
	}

	return error;
}

2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086
/* Ensure that fl->fl_filp has compatible f_mode for F_SETLK calls */
static int
check_fmode_for_setlk(struct file_lock *fl)
{
	switch (fl->fl_type) {
	case F_RDLCK:
		if (!(fl->fl_file->f_mode & FMODE_READ))
			return -EBADF;
		break;
	case F_WRLCK:
		if (!(fl->fl_file->f_mode & FMODE_WRITE))
			return -EBADF;
	}
	return 0;
}

L
Linus Torvalds 已提交
2087 2088 2089
/* Apply the lock described by l to an open file descriptor.
 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
 */
2090 2091
int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
		struct flock __user *l)
L
Linus Torvalds 已提交
2092 2093 2094 2095
{
	struct file_lock *file_lock = locks_alloc_lock();
	struct flock flock;
	struct inode *inode;
2096
	struct file *f;
L
Linus Torvalds 已提交
2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108
	int error;

	if (file_lock == NULL)
		return -ENOLCK;

	/*
	 * This might block, so we do it before checking the inode.
	 */
	error = -EFAULT;
	if (copy_from_user(&flock, l, sizeof(flock)))
		goto out;

A
Al Viro 已提交
2109
	inode = file_inode(filp);
L
Linus Torvalds 已提交
2110 2111 2112 2113

	/* Don't allow mandatory locks on files that may be memory mapped
	 * and shared.
	 */
2114
	if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
L
Linus Torvalds 已提交
2115 2116 2117 2118
		error = -EAGAIN;
		goto out;
	}

2119
again:
L
Linus Torvalds 已提交
2120 2121 2122
	error = flock_to_posix_lock(filp, file_lock, &flock);
	if (error)
		goto out;
2123

2124 2125 2126 2127
	error = check_fmode_for_setlk(file_lock);
	if (error)
		goto out;

2128 2129
	/*
	 * If the cmd is requesting file-private locks, then set the
2130
	 * FL_OFDLCK flag and override the owner.
2131 2132
	 */
	switch (cmd) {
2133
	case F_OFD_SETLK:
2134 2135 2136 2137
		error = -EINVAL;
		if (flock.l_pid != 0)
			goto out;

2138
		cmd = F_SETLK;
2139
		file_lock->fl_flags |= FL_OFDLCK;
2140
		file_lock->fl_owner = filp;
2141
		break;
2142
	case F_OFD_SETLKW:
2143 2144 2145 2146
		error = -EINVAL;
		if (flock.l_pid != 0)
			goto out;

2147
		cmd = F_SETLKW;
2148
		file_lock->fl_flags |= FL_OFDLCK;
2149
		file_lock->fl_owner = filp;
2150 2151
		/* Fallthrough */
	case F_SETLKW:
L
Linus Torvalds 已提交
2152 2153
		file_lock->fl_flags |= FL_SLEEP;
	}
2154

M
Miklos Szeredi 已提交
2155
	error = do_lock_file_wait(filp, cmd, file_lock);
L
Linus Torvalds 已提交
2156

2157 2158 2159 2160
	/*
	 * Attempt to detect a close/fcntl race and recover by
	 * releasing the lock that was just acquired.
	 */
2161 2162 2163 2164 2165 2166 2167 2168 2169
	/*
	 * we need that spin_lock here - it prevents reordering between
	 * update of inode->i_flock and check for it done in close().
	 * rcu_read_lock() wouldn't do.
	 */
	spin_lock(&current->files->file_lock);
	f = fcheck(fd);
	spin_unlock(&current->files->file_lock);
	if (!error && f != filp && flock.l_type != F_UNLCK) {
2170 2171
		flock.l_type = F_UNLCK;
		goto again;
L
Linus Torvalds 已提交
2172 2173
	}

2174
out:
L
Linus Torvalds 已提交
2175 2176 2177 2178 2179 2180 2181 2182
	locks_free_lock(file_lock);
	return error;
}

#if BITS_PER_LONG == 32
/* Report the first existing lock that would conflict with l.
 * This implements the F_GETLK command of fcntl().
 */
2183
int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 __user *l)
L
Linus Torvalds 已提交
2184
{
2185
	struct file_lock file_lock;
L
Linus Torvalds 已提交
2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199
	struct flock64 flock;
	int error;

	error = -EFAULT;
	if (copy_from_user(&flock, l, sizeof(flock)))
		goto out;
	error = -EINVAL;
	if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
		goto out;

	error = flock64_to_posix_lock(filp, &file_lock, &flock);
	if (error)
		goto out;

2200
	if (cmd == F_OFD_GETLK) {
2201 2202 2203 2204
		error = -EINVAL;
		if (flock.l_pid != 0)
			goto out;

2205
		cmd = F_GETLK64;
2206
		file_lock.fl_flags |= FL_OFDLCK;
2207
		file_lock.fl_owner = filp;
2208 2209
	}

2210 2211 2212 2213
	error = vfs_test_lock(filp, &file_lock);
	if (error)
		goto out;

2214 2215 2216 2217
	flock.l_type = file_lock.fl_type;
	if (file_lock.fl_type != F_UNLCK)
		posix_lock_to_flock64(&flock, &file_lock);

L
Linus Torvalds 已提交
2218 2219 2220
	error = -EFAULT;
	if (!copy_to_user(l, &flock, sizeof(flock)))
		error = 0;
2221 2222

	locks_release_private(&file_lock);
L
Linus Torvalds 已提交
2223 2224 2225 2226 2227 2228 2229
out:
	return error;
}

/* Apply the lock described by l to an open file descriptor.
 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
 */
2230 2231
int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
		struct flock64 __user *l)
L
Linus Torvalds 已提交
2232 2233 2234 2235
{
	struct file_lock *file_lock = locks_alloc_lock();
	struct flock64 flock;
	struct inode *inode;
2236
	struct file *f;
L
Linus Torvalds 已提交
2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248
	int error;

	if (file_lock == NULL)
		return -ENOLCK;

	/*
	 * This might block, so we do it before checking the inode.
	 */
	error = -EFAULT;
	if (copy_from_user(&flock, l, sizeof(flock)))
		goto out;

A
Al Viro 已提交
2249
	inode = file_inode(filp);
L
Linus Torvalds 已提交
2250 2251 2252 2253

	/* Don't allow mandatory locks on files that may be memory mapped
	 * and shared.
	 */
2254
	if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
L
Linus Torvalds 已提交
2255 2256 2257 2258
		error = -EAGAIN;
		goto out;
	}

2259
again:
L
Linus Torvalds 已提交
2260 2261 2262
	error = flock64_to_posix_lock(filp, file_lock, &flock);
	if (error)
		goto out;
2263

2264 2265 2266 2267
	error = check_fmode_for_setlk(file_lock);
	if (error)
		goto out;

2268 2269
	/*
	 * If the cmd is requesting file-private locks, then set the
2270
	 * FL_OFDLCK flag and override the owner.
2271 2272
	 */
	switch (cmd) {
2273
	case F_OFD_SETLK:
2274 2275 2276 2277
		error = -EINVAL;
		if (flock.l_pid != 0)
			goto out;

2278
		cmd = F_SETLK64;
2279
		file_lock->fl_flags |= FL_OFDLCK;
2280
		file_lock->fl_owner = filp;
2281
		break;
2282
	case F_OFD_SETLKW:
2283 2284 2285 2286
		error = -EINVAL;
		if (flock.l_pid != 0)
			goto out;

2287
		cmd = F_SETLKW64;
2288
		file_lock->fl_flags |= FL_OFDLCK;
2289
		file_lock->fl_owner = filp;
2290 2291
		/* Fallthrough */
	case F_SETLKW64:
L
Linus Torvalds 已提交
2292 2293
		file_lock->fl_flags |= FL_SLEEP;
	}
2294

M
Miklos Szeredi 已提交
2295
	error = do_lock_file_wait(filp, cmd, file_lock);
L
Linus Torvalds 已提交
2296

2297 2298 2299 2300
	/*
	 * Attempt to detect a close/fcntl race and recover by
	 * releasing the lock that was just acquired.
	 */
2301 2302 2303 2304
	spin_lock(&current->files->file_lock);
	f = fcheck(fd);
	spin_unlock(&current->files->file_lock);
	if (!error && f != filp && flock.l_type != F_UNLCK) {
2305 2306
		flock.l_type = F_UNLCK;
		goto again;
L
Linus Torvalds 已提交
2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321
	}

out:
	locks_free_lock(file_lock);
	return error;
}
#endif /* BITS_PER_LONG == 32 */

/*
 * This function is called when the file is being removed
 * from the task's fd array.  POSIX locks belonging to this task
 * are deleted at this time.
 */
void locks_remove_posix(struct file *filp, fl_owner_t owner)
{
2322
	struct file_lock lock;
L
Linus Torvalds 已提交
2323 2324 2325 2326 2327 2328

	/*
	 * If there are no locks held on this file, we don't need to call
	 * posix_lock_file().  Another process could be setting a lock on this
	 * file at the same time, but we wouldn't remove that lock anyway.
	 */
A
Al Viro 已提交
2329
	if (!file_inode(filp)->i_flock)
L
Linus Torvalds 已提交
2330 2331 2332
		return;

	lock.fl_type = F_UNLCK;
2333
	lock.fl_flags = FL_POSIX | FL_CLOSE;
L
Linus Torvalds 已提交
2334 2335 2336 2337 2338 2339 2340 2341
	lock.fl_start = 0;
	lock.fl_end = OFFSET_MAX;
	lock.fl_owner = owner;
	lock.fl_pid = current->tgid;
	lock.fl_file = filp;
	lock.fl_ops = NULL;
	lock.fl_lmops = NULL;

2342
	vfs_lock_file(filp, F_SETLK, &lock, NULL);
L
Linus Torvalds 已提交
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352

	if (lock.fl_ops && lock.fl_ops->fl_release_private)
		lock.fl_ops->fl_release_private(&lock);
}

EXPORT_SYMBOL(locks_remove_posix);

/*
 * This function is called on the last close of an open file.
 */
2353
void locks_remove_file(struct file *filp)
L
Linus Torvalds 已提交
2354
{
A
Al Viro 已提交
2355
	struct inode * inode = file_inode(filp);
L
Linus Torvalds 已提交
2356 2357
	struct file_lock *fl;
	struct file_lock **before;
2358
	LIST_HEAD(dispose);
L
Linus Torvalds 已提交
2359 2360 2361 2362

	if (!inode->i_flock)
		return;

2363
	locks_remove_posix(filp, filp);
2364

A
Al Viro 已提交
2365
	if (filp->f_op->flock) {
L
Linus Torvalds 已提交
2366
		struct file_lock fl = {
2367
			.fl_owner = filp,
L
Linus Torvalds 已提交
2368 2369 2370 2371 2372 2373 2374
			.fl_pid = current->tgid,
			.fl_file = filp,
			.fl_flags = FL_FLOCK,
			.fl_type = F_UNLCK,
			.fl_end = OFFSET_MAX,
		};
		filp->f_op->flock(filp, F_SETLKW, &fl);
2375 2376
		if (fl.fl_ops && fl.fl_ops->fl_release_private)
			fl.fl_ops->fl_release_private(&fl);
L
Linus Torvalds 已提交
2377 2378
	}

2379
	spin_lock(&inode->i_lock);
L
Linus Torvalds 已提交
2380 2381 2382 2383 2384
	before = &inode->i_flock;

	while ((fl = *before) != NULL) {
		if (fl->fl_file == filp) {
			if (IS_LEASE(fl)) {
2385
				lease_modify(before, F_UNLCK, &dispose);
L
Linus Torvalds 已提交
2386 2387
				continue;
			}
2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403

			/*
			 * There's a leftover lock on the list of a type that
			 * we didn't expect to see. Most likely a classic
			 * POSIX lock that ended up not getting released
			 * properly, or that raced onto the list somehow. Log
			 * some info about it and then just remove it from
			 * the list.
			 */
			WARN(!IS_FLOCK(fl),
				"leftover lock: dev=%u:%u ino=%lu type=%hhd flags=0x%x start=%lld end=%lld\n",
				MAJOR(inode->i_sb->s_dev),
				MINOR(inode->i_sb->s_dev), inode->i_ino,
				fl->fl_type, fl->fl_flags,
				fl->fl_start, fl->fl_end);

2404
			locks_delete_lock(before, &dispose);
2405
			continue;
L
Linus Torvalds 已提交
2406 2407 2408
 		}
		before = &fl->fl_next;
	}
2409
	spin_unlock(&inode->i_lock);
2410
	locks_dispose_list(&dispose);
L
Linus Torvalds 已提交
2411 2412 2413 2414 2415 2416 2417 2418
}

/**
 *	posix_unblock_lock - stop waiting for a file lock
 *	@waiter: the lock which was waiting
 *
 *	lockd needs to block waiting for locks.
 */
J
J. Bruce Fields 已提交
2419
int
2420
posix_unblock_lock(struct file_lock *waiter)
L
Linus Torvalds 已提交
2421
{
J
J. Bruce Fields 已提交
2422 2423
	int status = 0;

2424
	spin_lock(&blocked_lock_lock);
2425
	if (waiter->fl_next)
L
Linus Torvalds 已提交
2426
		__locks_delete_block(waiter);
J
J. Bruce Fields 已提交
2427 2428
	else
		status = -ENOENT;
2429
	spin_unlock(&blocked_lock_lock);
J
J. Bruce Fields 已提交
2430
	return status;
L
Linus Torvalds 已提交
2431 2432 2433
}
EXPORT_SYMBOL(posix_unblock_lock);

M
Marc Eshel 已提交
2434 2435 2436 2437 2438 2439 2440 2441 2442
/**
 * vfs_cancel_lock - file byte range unblock lock
 * @filp: The file to apply the unblock to
 * @fl: The lock to be unblocked
 *
 * Used by lock managers to cancel blocked requests
 */
int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
{
A
Al Viro 已提交
2443
	if (filp->f_op->lock)
M
Marc Eshel 已提交
2444 2445 2446 2447 2448 2449
		return filp->f_op->lock(filp, F_CANCELLK, fl);
	return 0;
}

EXPORT_SYMBOL_GPL(vfs_cancel_lock);

2450
#ifdef CONFIG_PROC_FS
2451
#include <linux/proc_fs.h>
2452 2453
#include <linux/seq_file.h>

2454 2455 2456 2457 2458
struct locks_iterator {
	int	li_cpu;
	loff_t	li_pos;
};

2459
static void lock_get_status(struct seq_file *f, struct file_lock *fl,
2460
			    loff_t id, char *pfx)
L
Linus Torvalds 已提交
2461 2462
{
	struct inode *inode = NULL;
2463 2464 2465
	unsigned int fl_pid;

	if (fl->fl_nspid)
2466
		fl_pid = pid_vnr(fl->fl_nspid);
2467 2468
	else
		fl_pid = fl->fl_pid;
L
Linus Torvalds 已提交
2469 2470

	if (fl->fl_file != NULL)
A
Al Viro 已提交
2471
		inode = file_inode(fl->fl_file);
L
Linus Torvalds 已提交
2472

2473
	seq_printf(f, "%lld:%s ", id, pfx);
L
Linus Torvalds 已提交
2474
	if (IS_POSIX(fl)) {
2475
		if (fl->fl_flags & FL_ACCESS)
2476
			seq_puts(f, "ACCESS");
2477
		else if (IS_OFDLCK(fl))
2478
			seq_puts(f, "OFDLCK");
2479
		else
2480
			seq_puts(f, "POSIX ");
2481 2482

		seq_printf(f, " %s ",
L
Linus Torvalds 已提交
2483
			     (inode == NULL) ? "*NOINODE*" :
2484
			     mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
L
Linus Torvalds 已提交
2485 2486
	} else if (IS_FLOCK(fl)) {
		if (fl->fl_type & LOCK_MAND) {
2487
			seq_puts(f, "FLOCK  MSNFS     ");
L
Linus Torvalds 已提交
2488
		} else {
2489
			seq_puts(f, "FLOCK  ADVISORY  ");
L
Linus Torvalds 已提交
2490 2491
		}
	} else if (IS_LEASE(fl)) {
2492 2493 2494 2495 2496
		if (fl->fl_flags & FL_DELEG)
			seq_puts(f, "DELEG  ");
		else
			seq_puts(f, "LEASE  ");

J
J. Bruce Fields 已提交
2497
		if (lease_breaking(fl))
2498
			seq_puts(f, "BREAKING  ");
L
Linus Torvalds 已提交
2499
		else if (fl->fl_file)
2500
			seq_puts(f, "ACTIVE    ");
L
Linus Torvalds 已提交
2501
		else
2502
			seq_puts(f, "BREAKER   ");
L
Linus Torvalds 已提交
2503
	} else {
2504
		seq_puts(f, "UNKNOWN UNKNOWN  ");
L
Linus Torvalds 已提交
2505 2506
	}
	if (fl->fl_type & LOCK_MAND) {
2507
		seq_printf(f, "%s ",
L
Linus Torvalds 已提交
2508 2509 2510 2511
			       (fl->fl_type & LOCK_READ)
			       ? (fl->fl_type & LOCK_WRITE) ? "RW   " : "READ "
			       : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
	} else {
2512
		seq_printf(f, "%s ",
J
J. Bruce Fields 已提交
2513
			       (lease_breaking(fl))
2514 2515
			       ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
			       : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
L
Linus Torvalds 已提交
2516 2517 2518
	}
	if (inode) {
#ifdef WE_CAN_BREAK_LSLK_NOW
2519
		seq_printf(f, "%d %s:%ld ", fl_pid,
L
Linus Torvalds 已提交
2520 2521 2522
				inode->i_sb->s_id, inode->i_ino);
#else
		/* userspace relies on this representation of dev_t ;-( */
2523
		seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
L
Linus Torvalds 已提交
2524 2525 2526 2527
				MAJOR(inode->i_sb->s_dev),
				MINOR(inode->i_sb->s_dev), inode->i_ino);
#endif
	} else {
2528
		seq_printf(f, "%d <none>:0 ", fl_pid);
L
Linus Torvalds 已提交
2529 2530 2531
	}
	if (IS_POSIX(fl)) {
		if (fl->fl_end == OFFSET_MAX)
2532
			seq_printf(f, "%Ld EOF\n", fl->fl_start);
L
Linus Torvalds 已提交
2533
		else
2534
			seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
L
Linus Torvalds 已提交
2535
	} else {
2536
		seq_puts(f, "0 EOF\n");
L
Linus Torvalds 已提交
2537 2538 2539
	}
}

2540
static int locks_show(struct seq_file *f, void *v)
L
Linus Torvalds 已提交
2541
{
2542
	struct locks_iterator *iter = f->private;
2543
	struct file_lock *fl, *bfl;
L
Linus Torvalds 已提交
2544

2545
	fl = hlist_entry(v, struct file_lock, fl_link);
L
Linus Torvalds 已提交
2546

2547
	lock_get_status(f, fl, iter->li_pos, "");
L
Linus Torvalds 已提交
2548

2549
	list_for_each_entry(bfl, &fl->fl_block, fl_block)
2550
		lock_get_status(f, bfl, iter->li_pos, " ->");
2551

2552 2553
	return 0;
}
L
Linus Torvalds 已提交
2554

2555
static void *locks_start(struct seq_file *f, loff_t *pos)
2556
	__acquires(&blocked_lock_lock)
2557
{
2558
	struct locks_iterator *iter = f->private;
2559

2560 2561
	iter->li_pos = *pos + 1;
	lg_global_lock(&file_lock_lglock);
2562
	spin_lock(&blocked_lock_lock);
2563
	return seq_hlist_start_percpu(&file_lock_list, &iter->li_cpu, *pos);
2564
}
L
Linus Torvalds 已提交
2565

2566 2567
static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
{
2568 2569 2570 2571
	struct locks_iterator *iter = f->private;

	++iter->li_pos;
	return seq_hlist_next_percpu(v, &file_lock_list, &iter->li_cpu, pos);
2572
}
L
Linus Torvalds 已提交
2573

2574
static void locks_stop(struct seq_file *f, void *v)
2575
	__releases(&blocked_lock_lock)
2576
{
2577
	spin_unlock(&blocked_lock_lock);
2578
	lg_global_unlock(&file_lock_lglock);
L
Linus Torvalds 已提交
2579 2580
}

2581
static const struct seq_operations locks_seq_operations = {
2582 2583 2584 2585 2586
	.start	= locks_start,
	.next	= locks_next,
	.stop	= locks_stop,
	.show	= locks_show,
};
2587 2588 2589

static int locks_open(struct inode *inode, struct file *filp)
{
2590 2591
	return seq_open_private(filp, &locks_seq_operations,
					sizeof(struct locks_iterator));
2592 2593 2594 2595 2596 2597
}

static const struct file_operations proc_locks_operations = {
	.open		= locks_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
2598
	.release	= seq_release_private,
2599 2600 2601 2602 2603 2604 2605 2606
};

static int __init proc_locks_init(void)
{
	proc_create("locks", 0, NULL, &proc_locks_operations);
	return 0;
}
module_init(proc_locks_init);
2607 2608
#endif

L
Linus Torvalds 已提交
2609 2610
static int __init filelock_init(void)
{
2611 2612
	int i;

L
Linus Torvalds 已提交
2613
	filelock_cache = kmem_cache_create("file_lock_cache",
M
Miklos Szeredi 已提交
2614 2615
			sizeof(struct file_lock), 0, SLAB_PANIC, NULL);

2616 2617 2618 2619 2620
	lg_lock_init(&file_lock_lglock, "file_lock_lglock");

	for_each_possible_cpu(i)
		INIT_HLIST_HEAD(per_cpu_ptr(&file_lock_list, i));

L
Linus Torvalds 已提交
2621 2622 2623 2624
	return 0;
}

core_initcall(filelock_init);