file.c 24.7 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
L
Linus Torvalds 已提交
2 3 4 5 6 7 8 9
/*
 *  linux/fs/file.c
 *
 *  Copyright (C) 1998-1999, Stephen Tweedie and Bill Hawes
 *
 *  Manage the dynamic fd arrays in the process files_struct.
 */

10
#include <linux/syscalls.h>
11
#include <linux/export.h>
L
Linus Torvalds 已提交
12 13
#include <linux/fs.h>
#include <linux/mm.h>
14
#include <linux/sched/signal.h>
L
Linus Torvalds 已提交
15 16
#include <linux/slab.h>
#include <linux/file.h>
A
Al Viro 已提交
17
#include <linux/fdtable.h>
L
Linus Torvalds 已提交
18
#include <linux/bitops.h>
19 20 21
#include <linux/spinlock.h>
#include <linux/rcupdate.h>

22 23
unsigned int sysctl_nr_open __read_mostly = 1024*1024;
unsigned int sysctl_nr_open_min = BITS_PER_LONG;
24 25
/* our min() is unusable in constant expressions ;-/ */
#define __const_min(x, y) ((x) < (y) ? (x) : (y))
26 27
unsigned int sysctl_nr_open_max =
	__const_min(INT_MAX, ~(size_t)0/sizeof(void *)) & -BITS_PER_LONG;
28

29
static void __free_fdtable(struct fdtable *fdt)
L
Linus Torvalds 已提交
30
{
A
Al Viro 已提交
31 32
	kvfree(fdt->fd);
	kvfree(fdt->open_fds);
33
	kfree(fdt);
34
}
L
Linus Torvalds 已提交
35

36
static void free_fdtable_rcu(struct rcu_head *rcu)
37
{
38
	__free_fdtable(container_of(rcu, struct fdtable, rcu));
39 40
}

41 42 43
#define BITBIT_NR(nr)	BITS_TO_LONGS(BITS_TO_LONGS(nr))
#define BITBIT_SIZE(nr)	(BITBIT_NR(nr) * sizeof(long))

44
/*
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
 * Copy 'count' fd bits from the old table to the new table and clear the extra
 * space if any.  This does not copy the file pointers.  Called with the files
 * spinlock held for write.
 */
static void copy_fd_bitmaps(struct fdtable *nfdt, struct fdtable *ofdt,
			    unsigned int count)
{
	unsigned int cpy, set;

	cpy = count / BITS_PER_BYTE;
	set = (nfdt->max_fds - count) / BITS_PER_BYTE;
	memcpy(nfdt->open_fds, ofdt->open_fds, cpy);
	memset((char *)nfdt->open_fds + cpy, 0, set);
	memcpy(nfdt->close_on_exec, ofdt->close_on_exec, cpy);
	memset((char *)nfdt->close_on_exec + cpy, 0, set);

	cpy = BITBIT_SIZE(count);
	set = BITBIT_SIZE(nfdt->max_fds) - cpy;
	memcpy(nfdt->full_fds_bits, ofdt->full_fds_bits, cpy);
	memset((char *)nfdt->full_fds_bits + cpy, 0, set);
}

/*
 * Copy all file descriptors from the old table to the new, expanded table and
 * clear the extra space.  Called with the files spinlock held for write.
70
 */
71
static void copy_fdtable(struct fdtable *nfdt, struct fdtable *ofdt)
72
{
73
	size_t cpy, set;
74

75 76 77 78 79
	BUG_ON(nfdt->max_fds < ofdt->max_fds);

	cpy = ofdt->max_fds * sizeof(struct file *);
	set = (nfdt->max_fds - ofdt->max_fds) * sizeof(struct file *);
	memcpy(nfdt->fd, ofdt->fd, cpy);
80
	memset((char *)nfdt->fd + cpy, 0, set);
81

82
	copy_fd_bitmaps(nfdt, ofdt, ofdt->max_fds);
L
Linus Torvalds 已提交
83 84
}

85
static struct fdtable * alloc_fdtable(unsigned int nr)
L
Linus Torvalds 已提交
86
{
87
	struct fdtable *fdt;
88
	void *data;
L
Linus Torvalds 已提交
89

90
	/*
91 92 93 94 95
	 * Figure out how many fds we actually want to support in this fdtable.
	 * Allocation steps are keyed to the size of the fdarray, since it
	 * grows far faster than any of the other dynamic data. We try to fit
	 * the fdarray into comfortable page-tuned chunks: starting at 1024B
	 * and growing in powers of two from there on.
96
	 */
97 98 99
	nr /= (1024 / sizeof(struct file *));
	nr = roundup_pow_of_two(nr + 1);
	nr *= (1024 / sizeof(struct file *));
A
Al Viro 已提交
100 101 102 103 104 105 106 107 108 109
	/*
	 * Note that this can drive nr *below* what we had passed if sysctl_nr_open
	 * had been set lower between the check in expand_files() and here.  Deal
	 * with that in caller, it's cheaper that way.
	 *
	 * We make sure that nr remains a multiple of BITS_PER_LONG - otherwise
	 * bitmaps handling below becomes unpleasant, to put it mildly...
	 */
	if (unlikely(nr > sysctl_nr_open))
		nr = ((sysctl_nr_open - 1) | (BITS_PER_LONG - 1)) + 1;
110

111
	fdt = kmalloc(sizeof(struct fdtable), GFP_KERNEL_ACCOUNT);
112
	if (!fdt)
113
		goto out;
114
	fdt->max_fds = nr;
115
	data = kvmalloc_array(nr, sizeof(struct file *), GFP_KERNEL_ACCOUNT);
116 117
	if (!data)
		goto out_fdt;
118 119
	fdt->fd = data;

120 121 122
	data = kvmalloc(max_t(size_t,
				 2 * nr / BITS_PER_BYTE + BITBIT_SIZE(nr), L1_CACHE_BYTES),
				 GFP_KERNEL_ACCOUNT);
123 124
	if (!data)
		goto out_arr;
125
	fdt->open_fds = data;
126
	data += nr / BITS_PER_BYTE;
127
	fdt->close_on_exec = data;
128 129
	data += nr / BITS_PER_BYTE;
	fdt->full_fds_bits = data;
130

131
	return fdt;
132 133

out_arr:
A
Al Viro 已提交
134
	kvfree(fdt->fd);
135
out_fdt:
136
	kfree(fdt);
137
out:
138 139
	return NULL;
}
L
Linus Torvalds 已提交
140

141
/*
142 143 144 145 146
 * Expand the file descriptor table.
 * This function will allocate a new fdtable and both fd array and fdset, of
 * the given size.
 * Return <0 error code on error; 1 on successful completion.
 * The files->file_lock should be held on entry, and will be held on exit.
147
 */
148
static int expand_fdtable(struct files_struct *files, unsigned int nr)
149 150 151
	__releases(files->file_lock)
	__acquires(files->file_lock)
{
152
	struct fdtable *new_fdt, *cur_fdt;
153 154

	spin_unlock(&files->file_lock);
155
	new_fdt = alloc_fdtable(nr);
156 157 158 159 160

	/* make sure all __fd_install() have seen resize_in_progress
	 * or have finished their rcu_read_lock_sched() section.
	 */
	if (atomic_read(&files->count) > 1)
161
		synchronize_rcu();
162

163
	spin_lock(&files->file_lock);
164 165
	if (!new_fdt)
		return -ENOMEM;
A
Al Viro 已提交
166 167 168 169 170
	/*
	 * extremely unlikely race - sysctl_nr_open decreased between the check in
	 * caller and alloc_fdtable().  Cheaper to catch it here...
	 */
	if (unlikely(new_fdt->max_fds <= nr)) {
171
		__free_fdtable(new_fdt);
A
Al Viro 已提交
172 173
		return -EMFILE;
	}
174
	cur_fdt = files_fdtable(files);
175 176 177 178 179 180 181
	BUG_ON(nr < cur_fdt->max_fds);
	copy_fdtable(new_fdt, cur_fdt);
	rcu_assign_pointer(files->fdt, new_fdt);
	if (cur_fdt != &files->fdtab)
		call_rcu(&cur_fdt->rcu, free_fdtable_rcu);
	/* coupled with smp_rmb() in __fd_install() */
	smp_wmb();
182
	return 1;
L
Linus Torvalds 已提交
183 184 185 186
}

/*
 * Expand files.
187 188 189 190 191
 * This function will expand the file structures, if the requested size exceeds
 * the current capacity and there is room for expansion.
 * Return <0 error code on error; 0 when nothing done; 1 when files were
 * expanded and execution may have blocked.
 * The files->file_lock should be held on entry, and will be held on exit.
L
Linus Torvalds 已提交
192
 */
193
static int expand_files(struct files_struct *files, unsigned int nr)
194 195
	__releases(files->file_lock)
	__acquires(files->file_lock)
L
Linus Torvalds 已提交
196
{
197
	struct fdtable *fdt;
198
	int expanded = 0;
L
Linus Torvalds 已提交
199

200
repeat:
201
	fdt = files_fdtable(files);
A
Al Viro 已提交
202

203
	/* Do we need to expand? */
204
	if (nr < fdt->max_fds)
205
		return expanded;
A
Al Viro 已提交
206

207
	/* Can we expand? */
208
	if (nr >= sysctl_nr_open)
209 210
		return -EMFILE;

211 212 213 214 215 216 217 218
	if (unlikely(files->resize_in_progress)) {
		spin_unlock(&files->file_lock);
		expanded = 1;
		wait_event(files->resize_wait, !files->resize_in_progress);
		spin_lock(&files->file_lock);
		goto repeat;
	}

219
	/* All good, so we try */
220 221 222 223 224 225
	files->resize_in_progress = true;
	expanded = expand_fdtable(files, nr);
	files->resize_in_progress = false;

	wake_up_all(&files->resize_wait);
	return expanded;
L
Linus Torvalds 已提交
226
}
227

228
static inline void __set_close_on_exec(unsigned int fd, struct fdtable *fdt)
229 230 231 232
{
	__set_bit(fd, fdt->close_on_exec);
}

233
static inline void __clear_close_on_exec(unsigned int fd, struct fdtable *fdt)
234
{
235 236
	if (test_bit(fd, fdt->close_on_exec))
		__clear_bit(fd, fdt->close_on_exec);
237 238
}

239
static inline void __set_open_fd(unsigned int fd, struct fdtable *fdt)
240 241
{
	__set_bit(fd, fdt->open_fds);
242 243 244
	fd /= BITS_PER_LONG;
	if (!~fdt->open_fds[fd])
		__set_bit(fd, fdt->full_fds_bits);
245 246
}

247
static inline void __clear_open_fd(unsigned int fd, struct fdtable *fdt)
248 249
{
	__clear_bit(fd, fdt->open_fds);
250
	__clear_bit(fd / BITS_PER_LONG, fdt->full_fds_bits);
251 252
}

253
static unsigned int count_open_files(struct fdtable *fdt)
A
Al Viro 已提交
254
{
255 256
	unsigned int size = fdt->max_fds;
	unsigned int i;
A
Al Viro 已提交
257 258

	/* Find the last open fd */
259 260
	for (i = size / BITS_PER_LONG; i > 0; ) {
		if (fdt->open_fds[--i])
A
Al Viro 已提交
261 262
			break;
	}
263
	i = (i + 1) * BITS_PER_LONG;
A
Al Viro 已提交
264 265 266 267 268 269 270 271 272 273 274 275
	return i;
}

/*
 * Allocate a new files structure and copy contents from the
 * passed in files structure.
 * errorp will be valid only when the returned files_struct is NULL.
 */
struct files_struct *dup_fd(struct files_struct *oldf, int *errorp)
{
	struct files_struct *newf;
	struct file **old_fds, **new_fds;
276
	unsigned int open_files, i;
A
Al Viro 已提交
277 278 279
	struct fdtable *old_fdt, *new_fdt;

	*errorp = -ENOMEM;
A
Al Viro 已提交
280
	newf = kmem_cache_alloc(files_cachep, GFP_KERNEL);
A
Al Viro 已提交
281 282 283
	if (!newf)
		goto out;

A
Al Viro 已提交
284 285 286
	atomic_set(&newf->count, 1);

	spin_lock_init(&newf->file_lock);
287 288
	newf->resize_in_progress = false;
	init_waitqueue_head(&newf->resize_wait);
A
Al Viro 已提交
289 290 291
	newf->next_fd = 0;
	new_fdt = &newf->fdtab;
	new_fdt->max_fds = NR_OPEN_DEFAULT;
292 293
	new_fdt->close_on_exec = newf->close_on_exec_init;
	new_fdt->open_fds = newf->open_fds_init;
294
	new_fdt->full_fds_bits = newf->full_fds_bits_init;
A
Al Viro 已提交
295 296
	new_fdt->fd = &newf->fd_array[0];

A
Al Viro 已提交
297 298 299 300 301 302 303
	spin_lock(&oldf->file_lock);
	old_fdt = files_fdtable(oldf);
	open_files = count_open_files(old_fdt);

	/*
	 * Check whether we need to allocate a larger fd array and fd set.
	 */
A
Al Viro 已提交
304
	while (unlikely(open_files > new_fdt->max_fds)) {
A
Al Viro 已提交
305
		spin_unlock(&oldf->file_lock);
A
Al Viro 已提交
306

307 308
		if (new_fdt != &newf->fdtab)
			__free_fdtable(new_fdt);
A
Al Viro 已提交
309

A
Al Viro 已提交
310 311 312 313 314 315 316 317
		new_fdt = alloc_fdtable(open_files - 1);
		if (!new_fdt) {
			*errorp = -ENOMEM;
			goto out_release;
		}

		/* beyond sysctl_nr_open; nothing to do */
		if (unlikely(new_fdt->max_fds < open_files)) {
318
			__free_fdtable(new_fdt);
A
Al Viro 已提交
319
			*errorp = -EMFILE;
A
Al Viro 已提交
320
			goto out_release;
A
Al Viro 已提交
321 322
		}

A
Al Viro 已提交
323 324 325 326 327 328 329
		/*
		 * Reacquire the oldf lock and a pointer to its fd table
		 * who knows it may have a new bigger fd table. We need
		 * the latest pointer.
		 */
		spin_lock(&oldf->file_lock);
		old_fdt = files_fdtable(oldf);
A
Al Viro 已提交
330
		open_files = count_open_files(old_fdt);
A
Al Viro 已提交
331 332
	}

333 334
	copy_fd_bitmaps(new_fdt, old_fdt, open_files);

A
Al Viro 已提交
335 336 337 338 339 340 341 342 343 344 345 346 347 348
	old_fds = old_fdt->fd;
	new_fds = new_fdt->fd;

	for (i = open_files; i != 0; i--) {
		struct file *f = *old_fds++;
		if (f) {
			get_file(f);
		} else {
			/*
			 * The fd may be claimed in the fd bitmap but not yet
			 * instantiated in the files array if a sibling thread
			 * is partway through open().  So make sure that this
			 * fd is available to the new process.
			 */
349
			__clear_open_fd(open_files - i, new_fdt);
A
Al Viro 已提交
350 351 352 353 354
		}
		rcu_assign_pointer(*new_fds++, f);
	}
	spin_unlock(&oldf->file_lock);

355 356
	/* clear the remainder */
	memset(new_fds, 0, (new_fdt->max_fds - open_files) * sizeof(struct file *));
A
Al Viro 已提交
357

A
Al Viro 已提交
358 359
	rcu_assign_pointer(newf->fdt, new_fdt);

A
Al Viro 已提交
360 361 362 363 364 365 366 367
	return newf;

out_release:
	kmem_cache_free(files_cachep, newf);
out:
	return NULL;
}

368
static struct fdtable *close_files(struct files_struct * files)
369 370 371 372
{
	/*
	 * It is safe to dereference the fd table without RCU or
	 * ->file_lock because this is the last reference to the
373
	 * files structure.
374
	 */
375
	struct fdtable *fdt = rcu_dereference_raw(files->fdt);
376
	unsigned int i, j = 0;
377

378 379 380 381 382 383 384 385 386 387 388
	for (;;) {
		unsigned long set;
		i = j * BITS_PER_LONG;
		if (i >= fdt->max_fds)
			break;
		set = fdt->open_fds[j++];
		while (set) {
			if (set & 1) {
				struct file * file = xchg(&fdt->fd[i], NULL);
				if (file) {
					filp_close(file, files);
389
					cond_resched();
390 391 392 393 394 395
				}
			}
			i++;
			set >>= 1;
		}
	}
396 397

	return fdt;
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
}

struct files_struct *get_files_struct(struct task_struct *task)
{
	struct files_struct *files;

	task_lock(task);
	files = task->files;
	if (files)
		atomic_inc(&files->count);
	task_unlock(task);

	return files;
}

void put_files_struct(struct files_struct *files)
{
	if (atomic_dec_and_test(&files->count)) {
416 417
		struct fdtable *fdt = close_files(files);

418 419 420 421
		/* free the arrays if they are not embedded */
		if (fdt != &files->fdtab)
			__free_fdtable(fdt);
		kmem_cache_free(files_cachep, files);
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
	}
}

void reset_files_struct(struct files_struct *files)
{
	struct task_struct *tsk = current;
	struct files_struct *old;

	old = tsk->files;
	task_lock(tsk);
	tsk->files = files;
	task_unlock(tsk);
	put_files_struct(old);
}

void exit_files(struct task_struct *tsk)
{
	struct files_struct * files = tsk->files;

	if (files) {
		task_lock(tsk);
		tsk->files = NULL;
		task_unlock(tsk);
		put_files_struct(files);
	}
}

A
Al Viro 已提交
449 450 451 452 453 454
struct files_struct init_files = {
	.count		= ATOMIC_INIT(1),
	.fdt		= &init_files.fdtab,
	.fdtab		= {
		.max_fds	= NR_OPEN_DEFAULT,
		.fd		= &init_files.fd_array[0],
455 456
		.close_on_exec	= init_files.close_on_exec_init,
		.open_fds	= init_files.open_fds_init,
457
		.full_fds_bits	= init_files.full_fds_bits_init,
A
Al Viro 已提交
458
	},
459
	.file_lock	= __SPIN_LOCK_UNLOCKED(init_files.file_lock),
460
	.resize_wait	= __WAIT_QUEUE_HEAD_INITIALIZER(init_files.resize_wait),
A
Al Viro 已提交
461
};
462

463
static unsigned int find_next_fd(struct fdtable *fdt, unsigned int start)
464
{
465 466 467
	unsigned int maxfd = fdt->max_fds;
	unsigned int maxbit = maxfd / BITS_PER_LONG;
	unsigned int bitbit = start / BITS_PER_LONG;
468 469 470 471 472 473 474 475 476

	bitbit = find_next_zero_bit(fdt->full_fds_bits, maxbit, bitbit) * BITS_PER_LONG;
	if (bitbit > maxfd)
		return maxfd;
	if (bitbit > start)
		start = bitbit;
	return find_next_zero_bit(fdt->open_fds, maxfd, start);
}

477 478 479
/*
 * allocate a file descriptor, mark it busy.
 */
A
Al Viro 已提交
480 481
int __alloc_fd(struct files_struct *files,
	       unsigned start, unsigned end, unsigned flags)
482 483 484 485 486 487 488 489 490 491 492 493 494
{
	unsigned int fd;
	int error;
	struct fdtable *fdt;

	spin_lock(&files->file_lock);
repeat:
	fdt = files_fdtable(files);
	fd = start;
	if (fd < files->next_fd)
		fd = files->next_fd;

	if (fd < fdt->max_fds)
495
		fd = find_next_fd(fdt, fd);
496

497 498 499 500 501 502 503 504
	/*
	 * N.B. For clone tasks sharing a files structure, this test
	 * will limit the total number of files that can be opened.
	 */
	error = -EMFILE;
	if (fd >= end)
		goto out;

505 506 507 508 509 510 511 512 513 514 515 516 517 518
	error = expand_files(files, fd);
	if (error < 0)
		goto out;

	/*
	 * If we needed to expand the fs array we
	 * might have blocked - try again.
	 */
	if (error)
		goto repeat;

	if (start <= files->next_fd)
		files->next_fd = fd + 1;

519
	__set_open_fd(fd, fdt);
520
	if (flags & O_CLOEXEC)
521
		__set_close_on_exec(fd, fdt);
522
	else
523
		__clear_close_on_exec(fd, fdt);
524 525 526
	error = fd;
#if 1
	/* Sanity check */
527
	if (rcu_access_pointer(fdt->fd[fd]) != NULL) {
528 529 530 531 532 533 534 535 536 537
		printk(KERN_WARNING "alloc_fd: slot %d not NULL!\n", fd);
		rcu_assign_pointer(fdt->fd[fd], NULL);
	}
#endif

out:
	spin_unlock(&files->file_lock);
	return error;
}

538
static int alloc_fd(unsigned start, unsigned flags)
A
Al Viro 已提交
539 540 541 542
{
	return __alloc_fd(current->files, start, rlimit(RLIMIT_NOFILE), flags);
}

543 544 545 546 547
int __get_unused_fd_flags(unsigned flags, unsigned long nofile)
{
	return __alloc_fd(current->files, 0, nofile, flags);
}

A
Al Viro 已提交
548
int get_unused_fd_flags(unsigned flags)
549
{
550
	return __get_unused_fd_flags(flags, rlimit(RLIMIT_NOFILE));
551
}
A
Al Viro 已提交
552
EXPORT_SYMBOL(get_unused_fd_flags);
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582

static void __put_unused_fd(struct files_struct *files, unsigned int fd)
{
	struct fdtable *fdt = files_fdtable(files);
	__clear_open_fd(fd, fdt);
	if (fd < files->next_fd)
		files->next_fd = fd;
}

void put_unused_fd(unsigned int fd)
{
	struct files_struct *files = current->files;
	spin_lock(&files->file_lock);
	__put_unused_fd(files, fd);
	spin_unlock(&files->file_lock);
}

EXPORT_SYMBOL(put_unused_fd);

/*
 * Install a file pointer in the fd array.
 *
 * The VFS is full of places where we drop the files lock between
 * setting the open_fds bitmap and installing the file in the file
 * array.  At any such point, we are vulnerable to a dup2() race
 * installing a file in the array before us.  We need to detect this and
 * fput() the struct file we are about to overwrite in this case.
 *
 * It should never happen - if we allow dup2() do it, _really_ bad things
 * will follow.
583 584 585 586 587 588 589
 *
 * NOTE: __fd_install() variant is really, really low-level; don't
 * use it unless you are forced to by truly lousy API shoved down
 * your throat.  'files' *MUST* be either current->files or obtained
 * by get_files_struct(current) done by whoever had given it to you,
 * or really bad things will happen.  Normally you want to use
 * fd_install() instead.
590 591
 */

592 593
void __fd_install(struct files_struct *files, unsigned int fd,
		struct file *file)
594 595
{
	struct fdtable *fdt;
596 597 598

	rcu_read_lock_sched();

599
	if (unlikely(files->resize_in_progress)) {
600
		rcu_read_unlock_sched();
601 602 603 604 605 606
		spin_lock(&files->file_lock);
		fdt = files_fdtable(files);
		BUG_ON(fdt->fd[fd] != NULL);
		rcu_assign_pointer(fdt->fd[fd], file);
		spin_unlock(&files->file_lock);
		return;
607 608 609 610
	}
	/* coupled with smp_wmb() in expand_fdtable() */
	smp_rmb();
	fdt = rcu_dereference_sched(files->fdt);
611 612
	BUG_ON(fdt->fd[fd] != NULL);
	rcu_assign_pointer(fdt->fd[fd], file);
613
	rcu_read_unlock_sched();
614 615
}

616 617 618 619 620
void fd_install(unsigned int fd, struct file *file)
{
	__fd_install(current->files, fd, file);
}

621
EXPORT_SYMBOL(fd_install);
A
Al Viro 已提交
622

623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
/*
 * The same warnings as for __alloc_fd()/__fd_install() apply here...
 */
int __close_fd(struct files_struct *files, unsigned fd)
{
	struct file *file;
	struct fdtable *fdt;

	spin_lock(&files->file_lock);
	fdt = files_fdtable(files);
	if (fd >= fdt->max_fds)
		goto out_unlock;
	file = fdt->fd[fd];
	if (!file)
		goto out_unlock;
	rcu_assign_pointer(fdt->fd[fd], NULL);
	__put_unused_fd(files, fd);
	spin_unlock(&files->file_lock);
	return filp_close(file, files);

out_unlock:
	spin_unlock(&files->file_lock);
	return -EBADF;
}
647
EXPORT_SYMBOL(__close_fd); /* for ksys_close() */
648

649
/*
650 651 652
 * variant of __close_fd that gets a ref on the file for later fput.
 * The caller must ensure that filp_close() called on the file, and then
 * an fput().
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
 */
int __close_fd_get_file(unsigned int fd, struct file **res)
{
	struct files_struct *files = current->files;
	struct file *file;
	struct fdtable *fdt;

	spin_lock(&files->file_lock);
	fdt = files_fdtable(files);
	if (fd >= fdt->max_fds)
		goto out_unlock;
	file = fdt->fd[fd];
	if (!file)
		goto out_unlock;
	rcu_assign_pointer(fdt->fd[fd], NULL);
	__put_unused_fd(files, fd);
	spin_unlock(&files->file_lock);
	get_file(file);
	*res = file;
672
	return 0;
673 674 675 676 677 678 679

out_unlock:
	spin_unlock(&files->file_lock);
	*res = NULL;
	return -ENOENT;
}

680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
void do_close_on_exec(struct files_struct *files)
{
	unsigned i;
	struct fdtable *fdt;

	/* exec unshares first */
	spin_lock(&files->file_lock);
	for (i = 0; ; i++) {
		unsigned long set;
		unsigned fd = i * BITS_PER_LONG;
		fdt = files_fdtable(files);
		if (fd >= fdt->max_fds)
			break;
		set = fdt->close_on_exec[i];
		if (!set)
			continue;
		fdt->close_on_exec[i] = 0;
		for ( ; set ; fd++, set >>= 1) {
			struct file *file;
			if (!(set & 1))
				continue;
			file = fdt->fd[fd];
			if (!file)
				continue;
			rcu_assign_pointer(fdt->fd[fd], NULL);
			__put_unused_fd(files, fd);
			spin_unlock(&files->file_lock);
			filp_close(file, files);
			cond_resched();
			spin_lock(&files->file_lock);
		}

	}
	spin_unlock(&files->file_lock);
}

716 717
static struct file *__fget_files(struct files_struct *files, unsigned int fd,
				 fmode_t mask, unsigned int refs)
A
Al Viro 已提交
718
{
719
	struct file *file;
A
Al Viro 已提交
720 721

	rcu_read_lock();
722
loop:
A
Al Viro 已提交
723 724
	file = fcheck_files(files, fd);
	if (file) {
725 726 727 728 729
		/* File object ref couldn't be taken.
		 * dup2() atomicity guarantee is the reason
		 * we loop to catch the new file (or NULL pointer)
		 */
		if (file->f_mode & mask)
A
Al Viro 已提交
730
			file = NULL;
J
Jens Axboe 已提交
731
		else if (!get_file_rcu_many(file, refs))
732
			goto loop;
A
Al Viro 已提交
733 734 735 736 737 738
	}
	rcu_read_unlock();

	return file;
}

739 740 741 742 743 744
static inline struct file *__fget(unsigned int fd, fmode_t mask,
				  unsigned int refs)
{
	return __fget_files(current->files, fd, mask, refs);
}

J
Jens Axboe 已提交
745 746 747 748 749
struct file *fget_many(unsigned int fd, unsigned int refs)
{
	return __fget(fd, FMODE_PATH, refs);
}

750 751
struct file *fget(unsigned int fd)
{
J
Jens Axboe 已提交
752
	return __fget(fd, FMODE_PATH, 1);
753
}
A
Al Viro 已提交
754 755 756 757
EXPORT_SYMBOL(fget);

struct file *fget_raw(unsigned int fd)
{
J
Jens Axboe 已提交
758
	return __fget(fd, 0, 1);
A
Al Viro 已提交
759 760 761
}
EXPORT_SYMBOL(fget_raw);

762 763 764 765 766 767 768 769 770 771 772 773
struct file *fget_task(struct task_struct *task, unsigned int fd)
{
	struct file *file = NULL;

	task_lock(task);
	if (task->files)
		file = __fget_files(task->files, fd, 0, 1);
	task_unlock(task);

	return file;
}

A
Al Viro 已提交
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
/*
 * Lightweight file lookup - no refcnt increment if fd table isn't shared.
 *
 * You can use this instead of fget if you satisfy all of the following
 * conditions:
 * 1) You must call fput_light before exiting the syscall and returning control
 *    to userspace (i.e. you cannot remember the returned struct file * after
 *    returning to userspace).
 * 2) You must not call filp_close on the returned struct file * in between
 *    calls to fget_light and fput_light.
 * 3) You must not clone the current task in between the calls to fget_light
 *    and fput_light.
 *
 * The fput_needed flag returned by fget_light should be passed to the
 * corresponding fput_light.
 */
A
Al Viro 已提交
790
static unsigned long __fget_light(unsigned int fd, fmode_t mask)
A
Al Viro 已提交
791 792
{
	struct files_struct *files = current->files;
793
	struct file *file;
A
Al Viro 已提交
794 795

	if (atomic_read(&files->count) == 1) {
796
		file = __fcheck_files(files, fd);
A
Al Viro 已提交
797 798 799
		if (!file || unlikely(file->f_mode & mask))
			return 0;
		return (unsigned long)file;
A
Al Viro 已提交
800
	} else {
J
Jens Axboe 已提交
801
		file = __fget(fd, mask, 1);
A
Al Viro 已提交
802 803 804
		if (!file)
			return 0;
		return FDPUT_FPUT | (unsigned long)file;
A
Al Viro 已提交
805 806
	}
}
A
Al Viro 已提交
807
unsigned long __fdget(unsigned int fd)
808
{
A
Al Viro 已提交
809
	return __fget_light(fd, FMODE_PATH);
810
}
A
Al Viro 已提交
811
EXPORT_SYMBOL(__fdget);
A
Al Viro 已提交
812

A
Al Viro 已提交
813
unsigned long __fdget_raw(unsigned int fd)
A
Al Viro 已提交
814
{
A
Al Viro 已提交
815
	return __fget_light(fd, 0);
A
Al Viro 已提交
816
}
817

A
Al Viro 已提交
818 819
unsigned long __fdget_pos(unsigned int fd)
{
820 821
	unsigned long v = __fdget(fd);
	struct file *file = (struct file *)(v & ~3);
A
Al Viro 已提交
822

823
	if (file && (file->f_mode & FMODE_ATOMIC_POS)) {
A
Al Viro 已提交
824 825 826 827 828
		if (file_count(file) > 1) {
			v |= FDPUT_POS_UNLOCK;
			mutex_lock(&file->f_pos_lock);
		}
	}
829
	return v;
A
Al Viro 已提交
830 831
}

832 833 834 835 836
void __f_unlock_pos(struct file *f)
{
	mutex_unlock(&f->f_pos_lock);
}

A
Al Viro 已提交
837 838 839 840 841 842
/*
 * We only lock f_pos if we have threads or if the file might be
 * shared with another process. In both cases we'll have an elevated
 * file count (done either by fdget() or by fork()).
 */

843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
void set_close_on_exec(unsigned int fd, int flag)
{
	struct files_struct *files = current->files;
	struct fdtable *fdt;
	spin_lock(&files->file_lock);
	fdt = files_fdtable(files);
	if (flag)
		__set_close_on_exec(fd, fdt);
	else
		__clear_close_on_exec(fd, fdt);
	spin_unlock(&files->file_lock);
}

bool get_close_on_exec(unsigned int fd)
{
	struct files_struct *files = current->files;
	struct fdtable *fdt;
	bool res;
	rcu_read_lock();
	fdt = files_fdtable(files);
	res = close_on_exec(fd, fdt);
	rcu_read_unlock();
	return res;
}

A
Al Viro 已提交
868 869
static int do_dup2(struct files_struct *files,
	struct file *file, unsigned fd, unsigned flags)
A
Al Viro 已提交
870
__releases(&files->file_lock)
871
{
A
Al Viro 已提交
872
	struct file *tofree;
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
	struct fdtable *fdt;

	/*
	 * We need to detect attempts to do dup2() over allocated but still
	 * not finished descriptor.  NB: OpenBSD avoids that at the price of
	 * extra work in their equivalent of fget() - they insert struct
	 * file immediately after grabbing descriptor, mark it larval if
	 * more work (e.g. actual opening) is needed and make sure that
	 * fget() treats larval files as absent.  Potentially interesting,
	 * but while extra work in fget() is trivial, locking implications
	 * and amount of surgery on open()-related paths in VFS are not.
	 * FreeBSD fails with -EBADF in the same situation, NetBSD "solution"
	 * deadlocks in rather amusing ways, AFAICS.  All of that is out of
	 * scope of POSIX or SUS, since neither considers shared descriptor
	 * tables and this condition does not arise without those.
	 */
	fdt = files_fdtable(files);
A
Al Viro 已提交
890 891 892
	tofree = fdt->fd[fd];
	if (!tofree && fd_is_open(fd, fdt))
		goto Ebusy;
893
	get_file(file);
A
Al Viro 已提交
894 895
	rcu_assign_pointer(fdt->fd[fd], file);
	__set_open_fd(fd, fdt);
896
	if (flags & O_CLOEXEC)
A
Al Viro 已提交
897
		__set_close_on_exec(fd, fdt);
898
	else
A
Al Viro 已提交
899
		__clear_close_on_exec(fd, fdt);
900 901 902 903 904
	spin_unlock(&files->file_lock);

	if (tofree)
		filp_close(tofree, files);

A
Al Viro 已提交
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
	return fd;

Ebusy:
	spin_unlock(&files->file_lock);
	return -EBUSY;
}

int replace_fd(unsigned fd, struct file *file, unsigned flags)
{
	int err;
	struct files_struct *files = current->files;

	if (!file)
		return __close_fd(files, fd);

	if (fd >= rlimit(RLIMIT_NOFILE))
921
		return -EBADF;
A
Al Viro 已提交
922 923 924 925 926 927 928 929 930 931 932 933

	spin_lock(&files->file_lock);
	err = expand_files(files, fd);
	if (unlikely(err < 0))
		goto out_unlock;
	return do_dup2(files, file, fd, flags);

out_unlock:
	spin_unlock(&files->file_lock);
	return err;
}

934
static int ksys_dup3(unsigned int oldfd, unsigned int newfd, int flags)
A
Al Viro 已提交
935 936 937 938 939 940 941 942
{
	int err = -EBADF;
	struct file *file;
	struct files_struct *files = current->files;

	if ((flags & ~O_CLOEXEC) != 0)
		return -EINVAL;

943 944 945
	if (unlikely(oldfd == newfd))
		return -EINVAL;

A
Al Viro 已提交
946
	if (newfd >= rlimit(RLIMIT_NOFILE))
947
		return -EBADF;
A
Al Viro 已提交
948 949 950 951 952 953 954 955 956 957 958 959

	spin_lock(&files->file_lock);
	err = expand_files(files, newfd);
	file = fcheck(oldfd);
	if (unlikely(!file))
		goto Ebadf;
	if (unlikely(err < 0)) {
		if (err == -EMFILE)
			goto Ebadf;
		goto out_unlock;
	}
	return do_dup2(files, file, newfd, flags);
960 961 962 963 964 965 966 967

Ebadf:
	err = -EBADF;
out_unlock:
	spin_unlock(&files->file_lock);
	return err;
}

968 969 970 971 972
SYSCALL_DEFINE3(dup3, unsigned int, oldfd, unsigned int, newfd, int, flags)
{
	return ksys_dup3(oldfd, newfd, flags);
}

973 974 975 976 977 978 979 980 981 982 983 984
SYSCALL_DEFINE2(dup2, unsigned int, oldfd, unsigned int, newfd)
{
	if (unlikely(newfd == oldfd)) { /* corner case */
		struct files_struct *files = current->files;
		int retval = oldfd;

		rcu_read_lock();
		if (!fcheck_files(files, oldfd))
			retval = -EBADF;
		rcu_read_unlock();
		return retval;
	}
985
	return ksys_dup3(oldfd, newfd, 0);
986 987
}

988
int ksys_dup(unsigned int fildes)
989 990 991 992 993
{
	int ret = -EBADF;
	struct file *file = fget_raw(fildes);

	if (file) {
994
		ret = get_unused_fd_flags(0);
995 996 997 998 999 1000 1001 1002
		if (ret >= 0)
			fd_install(ret, file);
		else
			fput(file);
	}
	return ret;
}

1003 1004 1005 1006 1007
SYSCALL_DEFINE1(dup, unsigned int, fildes)
{
	return ksys_dup(fildes);
}

1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
int f_dupfd(unsigned int from, struct file *file, unsigned flags)
{
	int err;
	if (from >= rlimit(RLIMIT_NOFILE))
		return -EINVAL;
	err = alloc_fd(from, flags);
	if (err >= 0) {
		get_file(file);
		fd_install(err, file);
	}
	return err;
}
A
Al Viro 已提交
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029

int iterate_fd(struct files_struct *files, unsigned n,
		int (*f)(const void *, struct file *, unsigned),
		const void *p)
{
	struct fdtable *fdt;
	int res = 0;
	if (!files)
		return 0;
	spin_lock(&files->file_lock);
1030 1031 1032 1033 1034 1035 1036 1037
	for (fdt = files_fdtable(files); n < fdt->max_fds; n++) {
		struct file *file;
		file = rcu_dereference_check_fdtable(files, fdt->fd[n]);
		if (!file)
			continue;
		res = f(p, file, n);
		if (res)
			break;
A
Al Viro 已提交
1038 1039 1040 1041 1042
	}
	spin_unlock(&files->file_lock);
	return res;
}
EXPORT_SYMBOL(iterate_fd);