file.c 29.9 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
#include <linux/fs.h>
C
Christian Brauner 已提交
13
#include <linux/kernel.h>
L
Linus Torvalds 已提交
14
#include <linux/mm.h>
15
#include <linux/sched/signal.h>
L
Linus Torvalds 已提交
16 17
#include <linux/slab.h>
#include <linux/file.h>
A
Al Viro 已提交
18
#include <linux/fdtable.h>
L
Linus Torvalds 已提交
19
#include <linux/bitops.h>
20 21
#include <linux/spinlock.h>
#include <linux/rcupdate.h>
22
#include <linux/close_range.h>
23
#include <net/sock.h>
24

25 26
#include "internal.h"

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

34
static void __free_fdtable(struct fdtable *fdt)
L
Linus Torvalds 已提交
35
{
A
Al Viro 已提交
36 37
	kvfree(fdt->fd);
	kvfree(fdt->open_fds);
38
	kfree(fdt);
39
}
L
Linus Torvalds 已提交
40

41
static void free_fdtable_rcu(struct rcu_head *rcu)
42
{
43
	__free_fdtable(container_of(rcu, struct fdtable, rcu));
44 45
}

46 47 48
#define BITBIT_NR(nr)	BITS_TO_LONGS(BITS_TO_LONGS(nr))
#define BITBIT_SIZE(nr)	(BITBIT_NR(nr) * sizeof(long))

49
/*
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
 * 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.
75
 */
76
static void copy_fdtable(struct fdtable *nfdt, struct fdtable *ofdt)
77
{
78
	size_t cpy, set;
79

80 81 82 83 84
	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);
85
	memset((char *)nfdt->fd + cpy, 0, set);
86

87
	copy_fd_bitmaps(nfdt, ofdt, ofdt->max_fds);
L
Linus Torvalds 已提交
88 89
}

90
static struct fdtable * alloc_fdtable(unsigned int nr)
L
Linus Torvalds 已提交
91
{
92
	struct fdtable *fdt;
93
	void *data;
L
Linus Torvalds 已提交
94

95
	/*
96 97 98 99 100
	 * 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.
101
	 */
102 103 104
	nr /= (1024 / sizeof(struct file *));
	nr = roundup_pow_of_two(nr + 1);
	nr *= (1024 / sizeof(struct file *));
A
Al Viro 已提交
105 106 107 108 109 110 111 112 113 114
	/*
	 * 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;
115

116
	fdt = kmalloc(sizeof(struct fdtable), GFP_KERNEL_ACCOUNT);
117
	if (!fdt)
118
		goto out;
119
	fdt->max_fds = nr;
120
	data = kvmalloc_array(nr, sizeof(struct file *), GFP_KERNEL_ACCOUNT);
121 122
	if (!data)
		goto out_fdt;
123 124
	fdt->fd = data;

125 126 127
	data = kvmalloc(max_t(size_t,
				 2 * nr / BITS_PER_BYTE + BITBIT_SIZE(nr), L1_CACHE_BYTES),
				 GFP_KERNEL_ACCOUNT);
128 129
	if (!data)
		goto out_arr;
130
	fdt->open_fds = data;
131
	data += nr / BITS_PER_BYTE;
132
	fdt->close_on_exec = data;
133 134
	data += nr / BITS_PER_BYTE;
	fdt->full_fds_bits = data;
135

136
	return fdt;
137 138

out_arr:
A
Al Viro 已提交
139
	kvfree(fdt->fd);
140
out_fdt:
141
	kfree(fdt);
142
out:
143 144
	return NULL;
}
L
Linus Torvalds 已提交
145

146
/*
147 148 149 150 151
 * 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.
152
 */
153
static int expand_fdtable(struct files_struct *files, unsigned int nr)
154 155 156
	__releases(files->file_lock)
	__acquires(files->file_lock)
{
157
	struct fdtable *new_fdt, *cur_fdt;
158 159

	spin_unlock(&files->file_lock);
160
	new_fdt = alloc_fdtable(nr);
161

162
	/* make sure all fd_install() have seen resize_in_progress
163 164 165
	 * or have finished their rcu_read_lock_sched() section.
	 */
	if (atomic_read(&files->count) > 1)
166
		synchronize_rcu();
167

168
	spin_lock(&files->file_lock);
169 170
	if (!new_fdt)
		return -ENOMEM;
A
Al Viro 已提交
171 172 173 174 175
	/*
	 * 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)) {
176
		__free_fdtable(new_fdt);
A
Al Viro 已提交
177 178
		return -EMFILE;
	}
179
	cur_fdt = files_fdtable(files);
180 181 182 183 184
	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);
185
	/* coupled with smp_rmb() in fd_install() */
186
	smp_wmb();
187
	return 1;
L
Linus Torvalds 已提交
188 189 190 191
}

/*
 * Expand files.
192 193 194 195 196
 * 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 已提交
197
 */
198
static int expand_files(struct files_struct *files, unsigned int nr)
199 200
	__releases(files->file_lock)
	__acquires(files->file_lock)
L
Linus Torvalds 已提交
201
{
202
	struct fdtable *fdt;
203
	int expanded = 0;
L
Linus Torvalds 已提交
204

205
repeat:
206
	fdt = files_fdtable(files);
A
Al Viro 已提交
207

208
	/* Do we need to expand? */
209
	if (nr < fdt->max_fds)
210
		return expanded;
A
Al Viro 已提交
211

212
	/* Can we expand? */
213
	if (nr >= sysctl_nr_open)
214 215
		return -EMFILE;

216 217 218 219 220 221 222 223
	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;
	}

224
	/* All good, so we try */
225 226 227 228 229 230
	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 已提交
231
}
232

233
static inline void __set_close_on_exec(unsigned int fd, struct fdtable *fdt)
234 235 236 237
{
	__set_bit(fd, fdt->close_on_exec);
}

238
static inline void __clear_close_on_exec(unsigned int fd, struct fdtable *fdt)
239
{
240 241
	if (test_bit(fd, fdt->close_on_exec))
		__clear_bit(fd, fdt->close_on_exec);
242 243
}

244
static inline void __set_open_fd(unsigned int fd, struct fdtable *fdt)
245 246
{
	__set_bit(fd, fdt->open_fds);
247 248 249
	fd /= BITS_PER_LONG;
	if (!~fdt->open_fds[fd])
		__set_bit(fd, fdt->full_fds_bits);
250 251
}

252
static inline void __clear_open_fd(unsigned int fd, struct fdtable *fdt)
253 254
{
	__clear_bit(fd, fdt->open_fds);
255
	__clear_bit(fd / BITS_PER_LONG, fdt->full_fds_bits);
256 257
}

258
static unsigned int count_open_files(struct fdtable *fdt)
A
Al Viro 已提交
259
{
260 261
	unsigned int size = fdt->max_fds;
	unsigned int i;
A
Al Viro 已提交
262 263

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

272 273 274 275 276 277 278 279 280 281
static unsigned int sane_fdtable_size(struct fdtable *fdt, unsigned int max_fds)
{
	unsigned int count;

	count = count_open_files(fdt);
	if (max_fds < NR_OPEN_DEFAULT)
		max_fds = NR_OPEN_DEFAULT;
	return min(count, max_fds);
}

A
Al Viro 已提交
282 283 284 285 286
/*
 * 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.
 */
287
struct files_struct *dup_fd(struct files_struct *oldf, unsigned int max_fds, int *errorp)
A
Al Viro 已提交
288 289 290
{
	struct files_struct *newf;
	struct file **old_fds, **new_fds;
291
	unsigned int open_files, i;
A
Al Viro 已提交
292 293 294
	struct fdtable *old_fdt, *new_fdt;

	*errorp = -ENOMEM;
A
Al Viro 已提交
295
	newf = kmem_cache_alloc(files_cachep, GFP_KERNEL);
A
Al Viro 已提交
296 297 298
	if (!newf)
		goto out;

A
Al Viro 已提交
299 300 301
	atomic_set(&newf->count, 1);

	spin_lock_init(&newf->file_lock);
302 303
	newf->resize_in_progress = false;
	init_waitqueue_head(&newf->resize_wait);
A
Al Viro 已提交
304 305 306
	newf->next_fd = 0;
	new_fdt = &newf->fdtab;
	new_fdt->max_fds = NR_OPEN_DEFAULT;
307 308
	new_fdt->close_on_exec = newf->close_on_exec_init;
	new_fdt->open_fds = newf->open_fds_init;
309
	new_fdt->full_fds_bits = newf->full_fds_bits_init;
A
Al Viro 已提交
310 311
	new_fdt->fd = &newf->fd_array[0];

A
Al Viro 已提交
312 313
	spin_lock(&oldf->file_lock);
	old_fdt = files_fdtable(oldf);
314
	open_files = sane_fdtable_size(old_fdt, max_fds);
A
Al Viro 已提交
315 316 317 318

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

322 323
		if (new_fdt != &newf->fdtab)
			__free_fdtable(new_fdt);
A
Al Viro 已提交
324

A
Al Viro 已提交
325 326 327 328 329 330 331 332
		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)) {
333
			__free_fdtable(new_fdt);
A
Al Viro 已提交
334
			*errorp = -EMFILE;
A
Al Viro 已提交
335
			goto out_release;
A
Al Viro 已提交
336 337
		}

A
Al Viro 已提交
338 339 340 341 342 343 344
		/*
		 * 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);
345
		open_files = sane_fdtable_size(old_fdt, max_fds);
A
Al Viro 已提交
346 347
	}

348 349
	copy_fd_bitmaps(new_fdt, old_fdt, open_files);

A
Al Viro 已提交
350 351 352 353 354 355 356 357 358 359 360 361 362 363
	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.
			 */
364
			__clear_open_fd(open_files - i, new_fdt);
A
Al Viro 已提交
365 366 367 368 369
		}
		rcu_assign_pointer(*new_fds++, f);
	}
	spin_unlock(&oldf->file_lock);

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

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

A
Al Viro 已提交
375 376 377 378 379 380 381 382
	return newf;

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

383
static struct fdtable *close_files(struct files_struct * files)
384 385 386 387
{
	/*
	 * It is safe to dereference the fd table without RCU or
	 * ->file_lock because this is the last reference to the
388
	 * files structure.
389
	 */
390
	struct fdtable *fdt = rcu_dereference_raw(files->fdt);
391
	unsigned int i, j = 0;
392

393 394 395 396 397 398 399 400 401 402 403
	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);
404
					cond_resched();
405 406 407 408 409 410
				}
			}
			i++;
			set >>= 1;
		}
	}
411 412

	return fdt;
413 414 415 416 417
}

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

420 421 422 423
		/* free the arrays if they are not embedded */
		if (fdt != &files->fdtab)
			__free_fdtable(fdt);
		kmem_cache_free(files_cachep, files);
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
	}
}

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 已提交
439 440 441 442 443 444
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],
445 446
		.close_on_exec	= init_files.close_on_exec_init,
		.open_fds	= init_files.open_fds_init,
447
		.full_fds_bits	= init_files.full_fds_bits_init,
A
Al Viro 已提交
448
	},
449
	.file_lock	= __SPIN_LOCK_UNLOCKED(init_files.file_lock),
450
	.resize_wait	= __WAIT_QUEUE_HEAD_INITIALIZER(init_files.resize_wait),
A
Al Viro 已提交
451
};
452

453
static unsigned int find_next_fd(struct fdtable *fdt, unsigned int start)
454
{
455 456 457
	unsigned int maxfd = fdt->max_fds;
	unsigned int maxbit = maxfd / BITS_PER_LONG;
	unsigned int bitbit = start / BITS_PER_LONG;
458 459 460 461 462 463 464 465 466

	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);
}

467 468 469
/*
 * allocate a file descriptor, mark it busy.
 */
470
static int alloc_fd(unsigned start, unsigned end, unsigned flags)
471
{
472
	struct files_struct *files = current->files;
473 474 475 476 477 478 479 480 481 482 483 484
	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)
485
		fd = find_next_fd(fdt, fd);
486

487 488 489 490 491 492 493 494
	/*
	 * 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;

495 496 497 498 499 500 501 502 503 504 505 506 507 508
	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;

509
	__set_open_fd(fd, fdt);
510
	if (flags & O_CLOEXEC)
511
		__set_close_on_exec(fd, fdt);
512
	else
513
		__clear_close_on_exec(fd, fdt);
514 515 516
	error = fd;
#if 1
	/* Sanity check */
517
	if (rcu_access_pointer(fdt->fd[fd]) != NULL) {
518 519 520 521 522 523 524 525 526 527
		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;
}

528 529
int __get_unused_fd_flags(unsigned flags, unsigned long nofile)
{
530
	return alloc_fd(0, nofile, flags);
531 532
}

A
Al Viro 已提交
533
int get_unused_fd_flags(unsigned flags)
534
{
535
	return __get_unused_fd_flags(flags, rlimit(RLIMIT_NOFILE));
536
}
A
Al Viro 已提交
537
EXPORT_SYMBOL(get_unused_fd_flags);
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567

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.
568
 *
569 570
 * This consumes the "file" refcount, so callers should treat it
 * as if they had called fput(file).
571 572
 */

573
void fd_install(unsigned int fd, struct file *file)
574
{
575
	struct files_struct *files = current->files;
576
	struct fdtable *fdt;
577 578 579

	rcu_read_lock_sched();

580
	if (unlikely(files->resize_in_progress)) {
581
		rcu_read_unlock_sched();
582 583 584 585 586 587
		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;
588 589 590 591
	}
	/* coupled with smp_wmb() in expand_fdtable() */
	smp_rmb();
	fdt = rcu_dereference_sched(files->fdt);
592 593
	BUG_ON(fdt->fd[fd] != NULL);
	rcu_assign_pointer(fdt->fd[fd], file);
594
	rcu_read_unlock_sched();
595 596 597
}

EXPORT_SYMBOL(fd_install);
A
Al Viro 已提交
598

599 600 601 602 603 604 605 606 607 608
/**
 * pick_file - return file associatd with fd
 * @files: file struct to retrieve file from
 * @fd: file descriptor to retrieve file for
 *
 * If this functions returns an EINVAL error pointer the fd was beyond the
 * current maximum number of file descriptors for that fdtable.
 *
 * Returns: The file associated with @fd, on error returns an error pointer.
 */
C
Christian Brauner 已提交
609
static struct file *pick_file(struct files_struct *files, unsigned fd)
610
{
611
	struct file *file;
612 613 614 615
	struct fdtable *fdt;

	spin_lock(&files->file_lock);
	fdt = files_fdtable(files);
616 617
	if (fd >= fdt->max_fds) {
		file = ERR_PTR(-EINVAL);
618
		goto out_unlock;
619
	}
620
	file = fdt->fd[fd];
621 622
	if (!file) {
		file = ERR_PTR(-EBADF);
623
		goto out_unlock;
624
	}
625 626 627 628 629
	rcu_assign_pointer(fdt->fd[fd], NULL);
	__put_unused_fd(files, fd);

out_unlock:
	spin_unlock(&files->file_lock);
C
Christian Brauner 已提交
630 631 632
	return file;
}

633
int close_fd(unsigned fd)
C
Christian Brauner 已提交
634
{
635
	struct files_struct *files = current->files;
C
Christian Brauner 已提交
636 637 638
	struct file *file;

	file = pick_file(files, fd);
639
	if (IS_ERR(file))
C
Christian Brauner 已提交
640 641 642
		return -EBADF;

	return filp_close(file, files);
643
}
644
EXPORT_SYMBOL(close_fd); /* for ksys_close() */
645

646 647 648 649 650 651 652 653 654 655 656 657 658
/**
 * last_fd - return last valid index into fd table
 * @cur_fds: files struct
 *
 * Context: Either rcu read lock or files_lock must be held.
 *
 * Returns: Last valid index into fdtable.
 */
static inline unsigned last_fd(struct fdtable *fdt)
{
	return fdt->max_fds - 1;
}

659 660 661 662 663
static inline void __range_cloexec(struct files_struct *cur_fds,
				   unsigned int fd, unsigned int max_fd)
{
	struct fdtable *fdt;

664
	/* make sure we're using the correct maximum value */
665 666
	spin_lock(&cur_fds->file_lock);
	fdt = files_fdtable(cur_fds);
667 668 669
	max_fd = min(last_fd(fdt), max_fd);
	if (fd <= max_fd)
		bitmap_set(fdt->close_on_exec, fd, max_fd - fd + 1);
670 671 672 673 674 675 676 677 678 679
	spin_unlock(&cur_fds->file_lock);
}

static inline void __range_close(struct files_struct *cur_fds, unsigned int fd,
				 unsigned int max_fd)
{
	while (fd <= max_fd) {
		struct file *file;

		file = pick_file(cur_fds, fd++);
680 681 682 683
		if (!IS_ERR(file)) {
			/* found a valid file to close */
			filp_close(file, cur_fds);
			cond_resched();
684
			continue;
685
		}
686

687 688 689
		/* beyond the last fd in that table */
		if (PTR_ERR(file) == -EINVAL)
			return;
690 691 692
	}
}

C
Christian Brauner 已提交
693 694 695 696 697 698 699 700 701
/**
 * __close_range() - Close all file descriptors in a given range.
 *
 * @fd:     starting file descriptor to close
 * @max_fd: last file descriptor to close
 *
 * This closes a range of file descriptors. All file descriptors
 * from @fd up to and including @max_fd are closed.
 */
702
int __close_range(unsigned fd, unsigned max_fd, unsigned int flags)
C
Christian Brauner 已提交
703
{
704 705 706
	struct task_struct *me = current;
	struct files_struct *cur_fds = me->files, *fds = NULL;

707
	if (flags & ~(CLOSE_RANGE_UNSHARE | CLOSE_RANGE_CLOEXEC))
708
		return -EINVAL;
C
Christian Brauner 已提交
709 710 711 712

	if (fd > max_fd)
		return -EINVAL;

713 714 715 716 717
	if (flags & CLOSE_RANGE_UNSHARE) {
		int ret;
		unsigned int max_unshare_fds = NR_OPEN_MAX;

		/*
718 719 720
		 * If the caller requested all fds to be made cloexec we always
		 * copy all of the file descriptors since they still want to
		 * use them.
721
		 */
722 723 724 725 726 727 728 729 730 731 732
		if (!(flags & CLOSE_RANGE_CLOEXEC)) {
			/*
			 * If the requested range is greater than the current
			 * maximum, we're closing everything so only copy all
			 * file descriptors beneath the lowest file descriptor.
			 */
			rcu_read_lock();
			if (max_fd >= last_fd(files_fdtable(cur_fds)))
				max_unshare_fds = fd;
			rcu_read_unlock();
		}
733 734 735 736 737 738 739 740 741 742 743 744 745

		ret = unshare_fd(CLONE_FILES, max_unshare_fds, &fds);
		if (ret)
			return ret;

		/*
		 * We used to share our file descriptor table, and have now
		 * created a private one, make sure we're using it below.
		 */
		if (fds)
			swap(cur_fds, fds);
	}

746 747 748 749
	if (flags & CLOSE_RANGE_CLOEXEC)
		__range_cloexec(cur_fds, fd, max_fd);
	else
		__range_close(cur_fds, fd, max_fd);
C
Christian Brauner 已提交
750

751 752 753 754 755 756 757 758 759 760 761
	if (fds) {
		/*
		 * We're done closing the files we were supposed to. Time to install
		 * the new file descriptor table and drop the old one.
		 */
		task_lock(me);
		me->files = cur_fds;
		task_unlock(me);
		put_files_struct(fds);
	}

C
Christian Brauner 已提交
762 763 764
	return 0;
}

765
/*
766 767
 * See close_fd_get_file() below, this variant assumes current->files->file_lock
 * is held.
768
 */
769
int __close_fd_get_file(unsigned int fd, struct file **res)
770 771 772 773 774 775 776
{
	struct files_struct *files = current->files;
	struct file *file;
	struct fdtable *fdt;

	fdt = files_fdtable(files);
	if (fd >= fdt->max_fds)
777
		goto out_err;
778 779
	file = fdt->fd[fd];
	if (!file)
780
		goto out_err;
781 782 783 784
	rcu_assign_pointer(fdt->fd[fd], NULL);
	__put_unused_fd(files, fd);
	get_file(file);
	*res = file;
785
	return 0;
786
out_err:
787 788 789 790
	*res = NULL;
	return -ENOENT;
}

791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
/*
 * 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().
 */
int close_fd_get_file(unsigned int fd, struct file **res)
{
	struct files_struct *files = current->files;
	int ret;

	spin_lock(&files->file_lock);
	ret = __close_fd_get_file(fd, res);
	spin_unlock(&files->file_lock);

	return ret;
}

808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843
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);
}

844 845
static struct file *__fget_files(struct files_struct *files, unsigned int fd,
				 fmode_t mask, unsigned int refs)
A
Al Viro 已提交
846
{
847
	struct file *file;
A
Al Viro 已提交
848 849

	rcu_read_lock();
850
loop:
851
	file = files_lookup_fd_rcu(files, fd);
A
Al Viro 已提交
852
	if (file) {
853 854 855 856 857
		/* 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 已提交
858
			file = NULL;
J
Jens Axboe 已提交
859
		else if (!get_file_rcu_many(file, refs))
860
			goto loop;
861 862 863 864
		else if (files_lookup_fd_raw(files, fd) != file) {
			fput_many(file, refs);
			goto loop;
		}
A
Al Viro 已提交
865 866 867 868 869 870
	}
	rcu_read_unlock();

	return file;
}

871 872 873 874 875 876
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 已提交
877 878 879 880 881
struct file *fget_many(unsigned int fd, unsigned int refs)
{
	return __fget(fd, FMODE_PATH, refs);
}

882 883
struct file *fget(unsigned int fd)
{
J
Jens Axboe 已提交
884
	return __fget(fd, FMODE_PATH, 1);
885
}
A
Al Viro 已提交
886 887 888 889
EXPORT_SYMBOL(fget);

struct file *fget_raw(unsigned int fd)
{
J
Jens Axboe 已提交
890
	return __fget(fd, 0, 1);
A
Al Viro 已提交
891 892 893
}
EXPORT_SYMBOL(fget_raw);

894 895 896 897 898 899 900 901 902 903 904 905
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;
}

906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
struct file *task_lookup_fd_rcu(struct task_struct *task, unsigned int fd)
{
	/* Must be called with rcu_read_lock held */
	struct files_struct *files;
	struct file *file = NULL;

	task_lock(task);
	files = task->files;
	if (files)
		file = files_lookup_fd_rcu(files, fd);
	task_unlock(task);

	return file;
}

921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
struct file *task_lookup_next_fd_rcu(struct task_struct *task, unsigned int *ret_fd)
{
	/* Must be called with rcu_read_lock held */
	struct files_struct *files;
	unsigned int fd = *ret_fd;
	struct file *file = NULL;

	task_lock(task);
	files = task->files;
	if (files) {
		for (; fd < files_fdtable(files)->max_fds; fd++) {
			file = files_lookup_fd_rcu(files, fd);
			if (file)
				break;
		}
	}
	task_unlock(task);
	*ret_fd = fd;
	return file;
}

A
Al Viro 已提交
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
/*
 * 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 已提交
958
static unsigned long __fget_light(unsigned int fd, fmode_t mask)
A
Al Viro 已提交
959 960
{
	struct files_struct *files = current->files;
961
	struct file *file;
A
Al Viro 已提交
962 963

	if (atomic_read(&files->count) == 1) {
964
		file = files_lookup_fd_raw(files, fd);
A
Al Viro 已提交
965 966 967
		if (!file || unlikely(file->f_mode & mask))
			return 0;
		return (unsigned long)file;
A
Al Viro 已提交
968
	} else {
J
Jens Axboe 已提交
969
		file = __fget(fd, mask, 1);
A
Al Viro 已提交
970 971 972
		if (!file)
			return 0;
		return FDPUT_FPUT | (unsigned long)file;
A
Al Viro 已提交
973 974
	}
}
A
Al Viro 已提交
975
unsigned long __fdget(unsigned int fd)
976
{
A
Al Viro 已提交
977
	return __fget_light(fd, FMODE_PATH);
978
}
A
Al Viro 已提交
979
EXPORT_SYMBOL(__fdget);
A
Al Viro 已提交
980

A
Al Viro 已提交
981
unsigned long __fdget_raw(unsigned int fd)
A
Al Viro 已提交
982
{
A
Al Viro 已提交
983
	return __fget_light(fd, 0);
A
Al Viro 已提交
984
}
985

A
Al Viro 已提交
986 987
unsigned long __fdget_pos(unsigned int fd)
{
988 989
	unsigned long v = __fdget(fd);
	struct file *file = (struct file *)(v & ~3);
A
Al Viro 已提交
990

991
	if (file && (file->f_mode & FMODE_ATOMIC_POS)) {
A
Al Viro 已提交
992 993 994 995 996
		if (file_count(file) > 1) {
			v |= FDPUT_POS_UNLOCK;
			mutex_lock(&file->f_pos_lock);
		}
	}
997
	return v;
A
Al Viro 已提交
998 999
}

1000 1001 1002 1003 1004
void __f_unlock_pos(struct file *f)
{
	mutex_unlock(&f->f_pos_lock);
}

A
Al Viro 已提交
1005 1006 1007 1008 1009 1010
/*
 * 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()).
 */

1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
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 已提交
1036 1037
static int do_dup2(struct files_struct *files,
	struct file *file, unsigned fd, unsigned flags)
A
Al Viro 已提交
1038
__releases(&files->file_lock)
1039
{
A
Al Viro 已提交
1040
	struct file *tofree;
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
	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 已提交
1058 1059 1060
	tofree = fdt->fd[fd];
	if (!tofree && fd_is_open(fd, fdt))
		goto Ebusy;
1061
	get_file(file);
A
Al Viro 已提交
1062 1063
	rcu_assign_pointer(fdt->fd[fd], file);
	__set_open_fd(fd, fdt);
1064
	if (flags & O_CLOEXEC)
A
Al Viro 已提交
1065
		__set_close_on_exec(fd, fdt);
1066
	else
A
Al Viro 已提交
1067
		__clear_close_on_exec(fd, fdt);
1068 1069 1070 1071 1072
	spin_unlock(&files->file_lock);

	if (tofree)
		filp_close(tofree, files);

A
Al Viro 已提交
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
	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)
1086
		return close_fd(fd);
A
Al Viro 已提交
1087 1088

	if (fd >= rlimit(RLIMIT_NOFILE))
1089
		return -EBADF;
A
Al Viro 已提交
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101

	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;
}

1102 1103 1104 1105 1106 1107 1108
/**
 * __receive_fd() - Install received file into file descriptor table
 * @file: struct file that was received from another process
 * @ufd: __user pointer to write new fd number to
 * @o_flags: the O_* flags to apply to the new fd entry
 *
 * Installs a received file into the file descriptor table, with appropriate
1109 1110
 * checks and count updates. Optionally writes the fd number to userspace, if
 * @ufd is non-NULL.
1111 1112 1113 1114
 *
 * This helper handles its own reference counting of the incoming
 * struct file.
 *
1115
 * Returns newly install fd or -ve on error.
1116
 */
1117
int __receive_fd(struct file *file, int __user *ufd, unsigned int o_flags)
1118 1119 1120 1121 1122 1123 1124 1125
{
	int new_fd;
	int error;

	error = security_file_receive(file);
	if (error)
		return error;

1126 1127 1128
	new_fd = get_unused_fd_flags(o_flags);
	if (new_fd < 0)
		return new_fd;
1129

1130 1131 1132
	if (ufd) {
		error = put_user(new_fd, ufd);
		if (error) {
1133
			put_unused_fd(new_fd);
1134 1135
			return error;
		}
1136 1137
	}

1138 1139 1140 1141
	fd_install(new_fd, get_file(file));
	__receive_sock(file);
	return new_fd;
}
1142

1143 1144 1145 1146 1147 1148 1149 1150 1151 1152
int receive_fd_replace(int new_fd, struct file *file, unsigned int o_flags)
{
	int error;

	error = security_file_receive(file);
	if (error)
		return error;
	error = replace_fd(new_fd, file, o_flags);
	if (error)
		return error;
1153
	__receive_sock(file);
1154
	return new_fd;
1155 1156
}

1157 1158 1159 1160 1161 1162
int receive_fd(struct file *file, unsigned int o_flags)
{
	return __receive_fd(file, NULL, o_flags);
}
EXPORT_SYMBOL_GPL(receive_fd);

1163
static int ksys_dup3(unsigned int oldfd, unsigned int newfd, int flags)
A
Al Viro 已提交
1164 1165 1166 1167 1168 1169 1170 1171
{
	int err = -EBADF;
	struct file *file;
	struct files_struct *files = current->files;

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

1172 1173 1174
	if (unlikely(oldfd == newfd))
		return -EINVAL;

A
Al Viro 已提交
1175
	if (newfd >= rlimit(RLIMIT_NOFILE))
1176
		return -EBADF;
A
Al Viro 已提交
1177 1178 1179

	spin_lock(&files->file_lock);
	err = expand_files(files, newfd);
1180
	file = files_lookup_fd_locked(files, oldfd);
A
Al Viro 已提交
1181 1182 1183 1184 1185 1186 1187 1188
	if (unlikely(!file))
		goto Ebadf;
	if (unlikely(err < 0)) {
		if (err == -EMFILE)
			goto Ebadf;
		goto out_unlock;
	}
	return do_dup2(files, file, newfd, flags);
1189 1190 1191 1192 1193 1194 1195 1196

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

1197 1198 1199 1200 1201
SYSCALL_DEFINE3(dup3, unsigned int, oldfd, unsigned int, newfd, int, flags)
{
	return ksys_dup3(oldfd, newfd, flags);
}

1202 1203 1204 1205 1206 1207 1208
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();
1209
		if (!files_lookup_fd_rcu(files, oldfd))
1210 1211 1212 1213
			retval = -EBADF;
		rcu_read_unlock();
		return retval;
	}
1214
	return ksys_dup3(oldfd, newfd, 0);
1215 1216
}

C
Christoph Hellwig 已提交
1217
SYSCALL_DEFINE1(dup, unsigned int, fildes)
1218 1219 1220 1221 1222
{
	int ret = -EBADF;
	struct file *file = fget_raw(fildes);

	if (file) {
1223
		ret = get_unused_fd_flags(0);
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
		if (ret >= 0)
			fd_install(ret, file);
		else
			fput(file);
	}
	return ret;
}

int f_dupfd(unsigned int from, struct file *file, unsigned flags)
{
1234
	unsigned long nofile = rlimit(RLIMIT_NOFILE);
1235
	int err;
1236
	if (from >= nofile)
1237
		return -EINVAL;
1238
	err = alloc_fd(from, nofile, flags);
1239 1240 1241 1242 1243 1244
	if (err >= 0) {
		get_file(file);
		fd_install(err, file);
	}
	return err;
}
A
Al Viro 已提交
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254

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);
1255 1256 1257 1258 1259 1260 1261 1262
	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 已提交
1263 1264 1265 1266 1267
	}
	spin_unlock(&files->file_lock);
	return res;
}
EXPORT_SYMBOL(iterate_fd);