• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  *  linux/fs/file.c
3  *
4  *  Copyright (C) 1998-1999, Stephen Tweedie and Bill Hawes
5  *
6  *  Manage the dynamic fd arrays in the process files_struct.
7  */
8 
9 #include <linux/syscalls.h>
10 #include <linux/export.h>
11 #include <linux/fs.h>
12 #include <linux/mm.h>
13 #include <linux/mmzone.h>
14 #include <linux/time.h>
15 #include <linux/sched.h>
16 #include <linux/slab.h>
17 #include <linux/vmalloc.h>
18 #include <linux/file.h>
19 #include <linux/fdtable.h>
20 #include <linux/bitops.h>
21 #include <linux/interrupt.h>
22 #include <linux/spinlock.h>
23 #include <linux/rcupdate.h>
24 #include <linux/workqueue.h>
25 
26 int sysctl_nr_open __read_mostly = 1024*1024;
27 int sysctl_nr_open_min = BITS_PER_LONG;
28 /* our max() is unusable in constant expressions ;-/ */
29 #define __const_max(x, y) ((x) < (y) ? (x) : (y))
30 int sysctl_nr_open_max = __const_max(INT_MAX, ~(size_t)0/sizeof(void *)) &
31 			 -BITS_PER_LONG;
32 
alloc_fdmem(size_t size)33 static void *alloc_fdmem(size_t size)
34 {
35 	/*
36 	 * Very large allocations can stress page reclaim, so fall back to
37 	 * vmalloc() if the allocation size will be considered "large" by the VM.
38 	 */
39 	if (size <= (PAGE_SIZE << PAGE_ALLOC_COSTLY_ORDER)) {
40 		void *data = kmalloc(size, GFP_KERNEL|__GFP_NOWARN|__GFP_NORETRY);
41 		if (data != NULL)
42 			return data;
43 	}
44 	return vmalloc(size);
45 }
46 
__free_fdtable(struct fdtable * fdt)47 static void __free_fdtable(struct fdtable *fdt)
48 {
49 	kvfree(fdt->fd);
50 	kvfree(fdt->open_fds);
51 	kfree(fdt);
52 }
53 
free_fdtable_rcu(struct rcu_head * rcu)54 static void free_fdtable_rcu(struct rcu_head *rcu)
55 {
56 	__free_fdtable(container_of(rcu, struct fdtable, rcu));
57 }
58 
59 #define BITBIT_NR(nr)	BITS_TO_LONGS(BITS_TO_LONGS(nr))
60 #define BITBIT_SIZE(nr)	(BITBIT_NR(nr) * sizeof(long))
61 
62 /*
63  * Copy 'count' fd bits from the old table to the new table and clear the extra
64  * space if any.  This does not copy the file pointers.  Called with the files
65  * spinlock held for write.
66  */
copy_fd_bitmaps(struct fdtable * nfdt,struct fdtable * ofdt,unsigned int count)67 static void copy_fd_bitmaps(struct fdtable *nfdt, struct fdtable *ofdt,
68 			    unsigned int count)
69 {
70 	unsigned int cpy, set;
71 
72 	cpy = count / BITS_PER_BYTE;
73 	set = (nfdt->max_fds - count) / BITS_PER_BYTE;
74 	memcpy(nfdt->open_fds, ofdt->open_fds, cpy);
75 	memset((char *)nfdt->open_fds + cpy, 0, set);
76 	memcpy(nfdt->close_on_exec, ofdt->close_on_exec, cpy);
77 	memset((char *)nfdt->close_on_exec + cpy, 0, set);
78 
79 	cpy = BITBIT_SIZE(count);
80 	set = BITBIT_SIZE(nfdt->max_fds) - cpy;
81 	memcpy(nfdt->full_fds_bits, ofdt->full_fds_bits, cpy);
82 	memset((char *)nfdt->full_fds_bits + cpy, 0, set);
83 }
84 
85 /*
86  * Copy all file descriptors from the old table to the new, expanded table and
87  * clear the extra space.  Called with the files spinlock held for write.
88  */
copy_fdtable(struct fdtable * nfdt,struct fdtable * ofdt)89 static void copy_fdtable(struct fdtable *nfdt, struct fdtable *ofdt)
90 {
91 	size_t cpy, set;
92 
93 	BUG_ON(nfdt->max_fds < ofdt->max_fds);
94 
95 	cpy = ofdt->max_fds * sizeof(struct file *);
96 	set = (nfdt->max_fds - ofdt->max_fds) * sizeof(struct file *);
97 	memcpy(nfdt->fd, ofdt->fd, cpy);
98 	memset((char *)nfdt->fd + cpy, 0, set);
99 
100 	copy_fd_bitmaps(nfdt, ofdt, ofdt->max_fds);
101 }
102 
alloc_fdtable(unsigned int nr)103 static struct fdtable * alloc_fdtable(unsigned int nr)
104 {
105 	struct fdtable *fdt;
106 	void *data;
107 
108 	/*
109 	 * Figure out how many fds we actually want to support in this fdtable.
110 	 * Allocation steps are keyed to the size of the fdarray, since it
111 	 * grows far faster than any of the other dynamic data. We try to fit
112 	 * the fdarray into comfortable page-tuned chunks: starting at 1024B
113 	 * and growing in powers of two from there on.
114 	 */
115 	nr /= (1024 / sizeof(struct file *));
116 	nr = roundup_pow_of_two(nr + 1);
117 	nr *= (1024 / sizeof(struct file *));
118 	/*
119 	 * Note that this can drive nr *below* what we had passed if sysctl_nr_open
120 	 * had been set lower between the check in expand_files() and here.  Deal
121 	 * with that in caller, it's cheaper that way.
122 	 *
123 	 * We make sure that nr remains a multiple of BITS_PER_LONG - otherwise
124 	 * bitmaps handling below becomes unpleasant, to put it mildly...
125 	 */
126 	if (unlikely(nr > sysctl_nr_open))
127 		nr = ((sysctl_nr_open - 1) | (BITS_PER_LONG - 1)) + 1;
128 
129 	fdt = kmalloc(sizeof(struct fdtable), GFP_KERNEL);
130 	if (!fdt)
131 		goto out;
132 	fdt->max_fds = nr;
133 	data = alloc_fdmem(nr * sizeof(struct file *));
134 	if (!data)
135 		goto out_fdt;
136 	fdt->fd = data;
137 
138 	data = alloc_fdmem(max_t(size_t,
139 				 2 * nr / BITS_PER_BYTE + BITBIT_SIZE(nr), L1_CACHE_BYTES));
140 	if (!data)
141 		goto out_arr;
142 	fdt->open_fds = data;
143 	data += nr / BITS_PER_BYTE;
144 	fdt->close_on_exec = data;
145 	data += nr / BITS_PER_BYTE;
146 	fdt->full_fds_bits = data;
147 
148 	return fdt;
149 
150 out_arr:
151 	kvfree(fdt->fd);
152 out_fdt:
153 	kfree(fdt);
154 out:
155 	return NULL;
156 }
157 
158 /*
159  * Expand the file descriptor table.
160  * This function will allocate a new fdtable and both fd array and fdset, of
161  * the given size.
162  * Return <0 error code on error; 1 on successful completion.
163  * The files->file_lock should be held on entry, and will be held on exit.
164  */
expand_fdtable(struct files_struct * files,int nr)165 static int expand_fdtable(struct files_struct *files, int nr)
166 	__releases(files->file_lock)
167 	__acquires(files->file_lock)
168 {
169 	struct fdtable *new_fdt, *cur_fdt;
170 
171 	spin_unlock(&files->file_lock);
172 	new_fdt = alloc_fdtable(nr);
173 
174 	/* make sure all __fd_install() have seen resize_in_progress
175 	 * or have finished their rcu_read_lock_sched() section.
176 	 */
177 	if (atomic_read(&files->count) > 1)
178 		synchronize_sched();
179 
180 	spin_lock(&files->file_lock);
181 	if (!new_fdt)
182 		return -ENOMEM;
183 	/*
184 	 * extremely unlikely race - sysctl_nr_open decreased between the check in
185 	 * caller and alloc_fdtable().  Cheaper to catch it here...
186 	 */
187 	if (unlikely(new_fdt->max_fds <= nr)) {
188 		__free_fdtable(new_fdt);
189 		return -EMFILE;
190 	}
191 	cur_fdt = files_fdtable(files);
192 	BUG_ON(nr < cur_fdt->max_fds);
193 	copy_fdtable(new_fdt, cur_fdt);
194 	rcu_assign_pointer(files->fdt, new_fdt);
195 	if (cur_fdt != &files->fdtab)
196 		call_rcu(&cur_fdt->rcu, free_fdtable_rcu);
197 	/* coupled with smp_rmb() in __fd_install() */
198 	smp_wmb();
199 	return 1;
200 }
201 
202 /*
203  * Expand files.
204  * This function will expand the file structures, if the requested size exceeds
205  * the current capacity and there is room for expansion.
206  * Return <0 error code on error; 0 when nothing done; 1 when files were
207  * expanded and execution may have blocked.
208  * The files->file_lock should be held on entry, and will be held on exit.
209  */
expand_files(struct files_struct * files,int nr)210 static int expand_files(struct files_struct *files, int nr)
211 	__releases(files->file_lock)
212 	__acquires(files->file_lock)
213 {
214 	struct fdtable *fdt;
215 	int expanded = 0;
216 
217 repeat:
218 	fdt = files_fdtable(files);
219 
220 	/* Do we need to expand? */
221 	if (nr < fdt->max_fds)
222 		return expanded;
223 
224 	/* Can we expand? */
225 	if (nr >= sysctl_nr_open)
226 		return -EMFILE;
227 
228 	if (unlikely(files->resize_in_progress)) {
229 		spin_unlock(&files->file_lock);
230 		expanded = 1;
231 		wait_event(files->resize_wait, !files->resize_in_progress);
232 		spin_lock(&files->file_lock);
233 		goto repeat;
234 	}
235 
236 	/* All good, so we try */
237 	files->resize_in_progress = true;
238 	expanded = expand_fdtable(files, nr);
239 	files->resize_in_progress = false;
240 
241 	wake_up_all(&files->resize_wait);
242 	return expanded;
243 }
244 
__set_close_on_exec(int fd,struct fdtable * fdt)245 static inline void __set_close_on_exec(int fd, struct fdtable *fdt)
246 {
247 	__set_bit(fd, fdt->close_on_exec);
248 }
249 
__clear_close_on_exec(int fd,struct fdtable * fdt)250 static inline void __clear_close_on_exec(int fd, struct fdtable *fdt)
251 {
252 	if (test_bit(fd, fdt->close_on_exec))
253 		__clear_bit(fd, fdt->close_on_exec);
254 }
255 
__set_open_fd(unsigned int fd,struct fdtable * fdt)256 static inline void __set_open_fd(unsigned int fd, struct fdtable *fdt)
257 {
258 	__set_bit(fd, fdt->open_fds);
259 	fd /= BITS_PER_LONG;
260 	if (!~fdt->open_fds[fd])
261 		__set_bit(fd, fdt->full_fds_bits);
262 }
263 
__clear_open_fd(unsigned int fd,struct fdtable * fdt)264 static inline void __clear_open_fd(unsigned int fd, struct fdtable *fdt)
265 {
266 	__clear_bit(fd, fdt->open_fds);
267 	__clear_bit(fd / BITS_PER_LONG, fdt->full_fds_bits);
268 }
269 
count_open_files(struct fdtable * fdt)270 static int count_open_files(struct fdtable *fdt)
271 {
272 	int size = fdt->max_fds;
273 	int i;
274 
275 	/* Find the last open fd */
276 	for (i = size / BITS_PER_LONG; i > 0; ) {
277 		if (fdt->open_fds[--i])
278 			break;
279 	}
280 	i = (i + 1) * BITS_PER_LONG;
281 	return i;
282 }
283 
284 /*
285  * Allocate a new files structure and copy contents from the
286  * passed in files structure.
287  * errorp will be valid only when the returned files_struct is NULL.
288  */
dup_fd(struct files_struct * oldf,int * errorp)289 struct files_struct *dup_fd(struct files_struct *oldf, int *errorp)
290 {
291 	struct files_struct *newf;
292 	struct file **old_fds, **new_fds;
293 	int open_files, i;
294 	struct fdtable *old_fdt, *new_fdt;
295 
296 	*errorp = -ENOMEM;
297 	newf = kmem_cache_alloc(files_cachep, GFP_KERNEL);
298 	if (!newf)
299 		goto out;
300 
301 	atomic_set(&newf->count, 1);
302 
303 	spin_lock_init(&newf->file_lock);
304 	newf->resize_in_progress = false;
305 	init_waitqueue_head(&newf->resize_wait);
306 	newf->next_fd = 0;
307 	new_fdt = &newf->fdtab;
308 	new_fdt->max_fds = NR_OPEN_DEFAULT;
309 	new_fdt->close_on_exec = newf->close_on_exec_init;
310 	new_fdt->open_fds = newf->open_fds_init;
311 	new_fdt->full_fds_bits = newf->full_fds_bits_init;
312 	new_fdt->fd = &newf->fd_array[0];
313 
314 	spin_lock(&oldf->file_lock);
315 	old_fdt = files_fdtable(oldf);
316 	open_files = count_open_files(old_fdt);
317 
318 	/*
319 	 * Check whether we need to allocate a larger fd array and fd set.
320 	 */
321 	while (unlikely(open_files > new_fdt->max_fds)) {
322 		spin_unlock(&oldf->file_lock);
323 
324 		if (new_fdt != &newf->fdtab)
325 			__free_fdtable(new_fdt);
326 
327 		new_fdt = alloc_fdtable(open_files - 1);
328 		if (!new_fdt) {
329 			*errorp = -ENOMEM;
330 			goto out_release;
331 		}
332 
333 		/* beyond sysctl_nr_open; nothing to do */
334 		if (unlikely(new_fdt->max_fds < open_files)) {
335 			__free_fdtable(new_fdt);
336 			*errorp = -EMFILE;
337 			goto out_release;
338 		}
339 
340 		/*
341 		 * Reacquire the oldf lock and a pointer to its fd table
342 		 * who knows it may have a new bigger fd table. We need
343 		 * the latest pointer.
344 		 */
345 		spin_lock(&oldf->file_lock);
346 		old_fdt = files_fdtable(oldf);
347 		open_files = count_open_files(old_fdt);
348 	}
349 
350 	copy_fd_bitmaps(new_fdt, old_fdt, open_files);
351 
352 	old_fds = old_fdt->fd;
353 	new_fds = new_fdt->fd;
354 
355 	for (i = open_files; i != 0; i--) {
356 		struct file *f = *old_fds++;
357 		if (f) {
358 			get_file(f);
359 		} else {
360 			/*
361 			 * The fd may be claimed in the fd bitmap but not yet
362 			 * instantiated in the files array if a sibling thread
363 			 * is partway through open().  So make sure that this
364 			 * fd is available to the new process.
365 			 */
366 			__clear_open_fd(open_files - i, new_fdt);
367 		}
368 		rcu_assign_pointer(*new_fds++, f);
369 	}
370 	spin_unlock(&oldf->file_lock);
371 
372 	/* clear the remainder */
373 	memset(new_fds, 0, (new_fdt->max_fds - open_files) * sizeof(struct file *));
374 
375 	rcu_assign_pointer(newf->fdt, new_fdt);
376 
377 	return newf;
378 
379 out_release:
380 	kmem_cache_free(files_cachep, newf);
381 out:
382 	return NULL;
383 }
384 
close_files(struct files_struct * files)385 static struct fdtable *close_files(struct files_struct * files)
386 {
387 	/*
388 	 * It is safe to dereference the fd table without RCU or
389 	 * ->file_lock because this is the last reference to the
390 	 * files structure.
391 	 */
392 	struct fdtable *fdt = rcu_dereference_raw(files->fdt);
393 	int i, j = 0;
394 
395 	for (;;) {
396 		unsigned long set;
397 		i = j * BITS_PER_LONG;
398 		if (i >= fdt->max_fds)
399 			break;
400 		set = fdt->open_fds[j++];
401 		while (set) {
402 			if (set & 1) {
403 				struct file * file = xchg(&fdt->fd[i], NULL);
404 				if (file) {
405 					filp_close(file, files);
406 					cond_resched_rcu_qs();
407 				}
408 			}
409 			i++;
410 			set >>= 1;
411 		}
412 	}
413 
414 	return fdt;
415 }
416 
get_files_struct(struct task_struct * task)417 struct files_struct *get_files_struct(struct task_struct *task)
418 {
419 	struct files_struct *files;
420 
421 	task_lock(task);
422 	files = task->files;
423 	if (files)
424 		atomic_inc(&files->count);
425 	task_unlock(task);
426 
427 	return files;
428 }
429 
put_files_struct(struct files_struct * files)430 void put_files_struct(struct files_struct *files)
431 {
432 	if (atomic_dec_and_test(&files->count)) {
433 		struct fdtable *fdt = close_files(files);
434 
435 		/* free the arrays if they are not embedded */
436 		if (fdt != &files->fdtab)
437 			__free_fdtable(fdt);
438 		kmem_cache_free(files_cachep, files);
439 	}
440 }
441 
reset_files_struct(struct files_struct * files)442 void reset_files_struct(struct files_struct *files)
443 {
444 	struct task_struct *tsk = current;
445 	struct files_struct *old;
446 
447 	old = tsk->files;
448 	task_lock(tsk);
449 	tsk->files = files;
450 	task_unlock(tsk);
451 	put_files_struct(old);
452 }
453 
exit_files(struct task_struct * tsk)454 void exit_files(struct task_struct *tsk)
455 {
456 	struct files_struct * files = tsk->files;
457 
458 	if (files) {
459 		task_lock(tsk);
460 		tsk->files = NULL;
461 		task_unlock(tsk);
462 		put_files_struct(files);
463 	}
464 }
465 
466 struct files_struct init_files = {
467 	.count		= ATOMIC_INIT(1),
468 	.fdt		= &init_files.fdtab,
469 	.fdtab		= {
470 		.max_fds	= NR_OPEN_DEFAULT,
471 		.fd		= &init_files.fd_array[0],
472 		.close_on_exec	= init_files.close_on_exec_init,
473 		.open_fds	= init_files.open_fds_init,
474 		.full_fds_bits	= init_files.full_fds_bits_init,
475 	},
476 	.file_lock	= __SPIN_LOCK_UNLOCKED(init_files.file_lock),
477 	.resize_wait	= __WAIT_QUEUE_HEAD_INITIALIZER(init_files.resize_wait),
478 };
479 
find_next_fd(struct fdtable * fdt,unsigned long start)480 static unsigned long find_next_fd(struct fdtable *fdt, unsigned long start)
481 {
482 	unsigned long maxfd = fdt->max_fds;
483 	unsigned long maxbit = maxfd / BITS_PER_LONG;
484 	unsigned long bitbit = start / BITS_PER_LONG;
485 
486 	bitbit = find_next_zero_bit(fdt->full_fds_bits, maxbit, bitbit) * BITS_PER_LONG;
487 	if (bitbit > maxfd)
488 		return maxfd;
489 	if (bitbit > start)
490 		start = bitbit;
491 	return find_next_zero_bit(fdt->open_fds, maxfd, start);
492 }
493 
494 /*
495  * allocate a file descriptor, mark it busy.
496  */
__alloc_fd(struct files_struct * files,unsigned start,unsigned end,unsigned flags)497 int __alloc_fd(struct files_struct *files,
498 	       unsigned start, unsigned end, unsigned flags)
499 {
500 	unsigned int fd;
501 	int error;
502 	struct fdtable *fdt;
503 
504 	spin_lock(&files->file_lock);
505 repeat:
506 	fdt = files_fdtable(files);
507 	fd = start;
508 	if (fd < files->next_fd)
509 		fd = files->next_fd;
510 
511 	if (fd < fdt->max_fds)
512 		fd = find_next_fd(fdt, fd);
513 
514 	/*
515 	 * N.B. For clone tasks sharing a files structure, this test
516 	 * will limit the total number of files that can be opened.
517 	 */
518 	error = -EMFILE;
519 	if (fd >= end)
520 		goto out;
521 
522 	error = expand_files(files, fd);
523 	if (error < 0)
524 		goto out;
525 
526 	/*
527 	 * If we needed to expand the fs array we
528 	 * might have blocked - try again.
529 	 */
530 	if (error)
531 		goto repeat;
532 
533 	if (start <= files->next_fd)
534 		files->next_fd = fd + 1;
535 
536 	__set_open_fd(fd, fdt);
537 	if (flags & O_CLOEXEC)
538 		__set_close_on_exec(fd, fdt);
539 	else
540 		__clear_close_on_exec(fd, fdt);
541 	error = fd;
542 #if 1
543 	/* Sanity check */
544 	if (rcu_access_pointer(fdt->fd[fd]) != NULL) {
545 		printk(KERN_WARNING "alloc_fd: slot %d not NULL!\n", fd);
546 		rcu_assign_pointer(fdt->fd[fd], NULL);
547 	}
548 #endif
549 
550 out:
551 	spin_unlock(&files->file_lock);
552 	return error;
553 }
554 
alloc_fd(unsigned start,unsigned flags)555 static int alloc_fd(unsigned start, unsigned flags)
556 {
557 	return __alloc_fd(current->files, start, rlimit(RLIMIT_NOFILE), flags);
558 }
559 
get_unused_fd_flags(unsigned flags)560 int get_unused_fd_flags(unsigned flags)
561 {
562 	return __alloc_fd(current->files, 0, rlimit(RLIMIT_NOFILE), flags);
563 }
564 EXPORT_SYMBOL(get_unused_fd_flags);
565 
__put_unused_fd(struct files_struct * files,unsigned int fd)566 static void __put_unused_fd(struct files_struct *files, unsigned int fd)
567 {
568 	struct fdtable *fdt = files_fdtable(files);
569 	__clear_open_fd(fd, fdt);
570 	if (fd < files->next_fd)
571 		files->next_fd = fd;
572 }
573 
put_unused_fd(unsigned int fd)574 void put_unused_fd(unsigned int fd)
575 {
576 	struct files_struct *files = current->files;
577 	spin_lock(&files->file_lock);
578 	__put_unused_fd(files, fd);
579 	spin_unlock(&files->file_lock);
580 }
581 
582 EXPORT_SYMBOL(put_unused_fd);
583 
584 /*
585  * Install a file pointer in the fd array.
586  *
587  * The VFS is full of places where we drop the files lock between
588  * setting the open_fds bitmap and installing the file in the file
589  * array.  At any such point, we are vulnerable to a dup2() race
590  * installing a file in the array before us.  We need to detect this and
591  * fput() the struct file we are about to overwrite in this case.
592  *
593  * It should never happen - if we allow dup2() do it, _really_ bad things
594  * will follow.
595  *
596  * NOTE: __fd_install() variant is really, really low-level; don't
597  * use it unless you are forced to by truly lousy API shoved down
598  * your throat.  'files' *MUST* be either current->files or obtained
599  * by get_files_struct(current) done by whoever had given it to you,
600  * or really bad things will happen.  Normally you want to use
601  * fd_install() instead.
602  */
603 
__fd_install(struct files_struct * files,unsigned int fd,struct file * file)604 void __fd_install(struct files_struct *files, unsigned int fd,
605 		struct file *file)
606 {
607 	struct fdtable *fdt;
608 
609 	might_sleep();
610 	rcu_read_lock_sched();
611 
612 	while (unlikely(files->resize_in_progress)) {
613 		rcu_read_unlock_sched();
614 		wait_event(files->resize_wait, !files->resize_in_progress);
615 		rcu_read_lock_sched();
616 	}
617 	/* coupled with smp_wmb() in expand_fdtable() */
618 	smp_rmb();
619 	fdt = rcu_dereference_sched(files->fdt);
620 	BUG_ON(fdt->fd[fd] != NULL);
621 	rcu_assign_pointer(fdt->fd[fd], file);
622 	rcu_read_unlock_sched();
623 }
624 
fd_install(unsigned int fd,struct file * file)625 void fd_install(unsigned int fd, struct file *file)
626 {
627 	__fd_install(current->files, fd, file);
628 }
629 
630 EXPORT_SYMBOL(fd_install);
631 
632 /*
633  * The same warnings as for __alloc_fd()/__fd_install() apply here...
634  */
__close_fd(struct files_struct * files,unsigned fd)635 int __close_fd(struct files_struct *files, unsigned fd)
636 {
637 	struct file *file;
638 	struct fdtable *fdt;
639 
640 	spin_lock(&files->file_lock);
641 	fdt = files_fdtable(files);
642 	if (fd >= fdt->max_fds)
643 		goto out_unlock;
644 	file = fdt->fd[fd];
645 	if (!file)
646 		goto out_unlock;
647 	rcu_assign_pointer(fdt->fd[fd], NULL);
648 	__clear_close_on_exec(fd, fdt);
649 	__put_unused_fd(files, fd);
650 	spin_unlock(&files->file_lock);
651 	return filp_close(file, files);
652 
653 out_unlock:
654 	spin_unlock(&files->file_lock);
655 	return -EBADF;
656 }
657 
do_close_on_exec(struct files_struct * files)658 void do_close_on_exec(struct files_struct *files)
659 {
660 	unsigned i;
661 	struct fdtable *fdt;
662 
663 	/* exec unshares first */
664 	spin_lock(&files->file_lock);
665 	for (i = 0; ; i++) {
666 		unsigned long set;
667 		unsigned fd = i * BITS_PER_LONG;
668 		fdt = files_fdtable(files);
669 		if (fd >= fdt->max_fds)
670 			break;
671 		set = fdt->close_on_exec[i];
672 		if (!set)
673 			continue;
674 		fdt->close_on_exec[i] = 0;
675 		for ( ; set ; fd++, set >>= 1) {
676 			struct file *file;
677 			if (!(set & 1))
678 				continue;
679 			file = fdt->fd[fd];
680 			if (!file)
681 				continue;
682 			rcu_assign_pointer(fdt->fd[fd], NULL);
683 			__put_unused_fd(files, fd);
684 			spin_unlock(&files->file_lock);
685 			filp_close(file, files);
686 			cond_resched();
687 			spin_lock(&files->file_lock);
688 		}
689 
690 	}
691 	spin_unlock(&files->file_lock);
692 }
693 
__fget(unsigned int fd,fmode_t mask,unsigned int refs)694 static struct file *__fget(unsigned int fd, fmode_t mask, unsigned int refs)
695 {
696 	struct files_struct *files = current->files;
697 	struct file *file;
698 
699 	rcu_read_lock();
700 loop:
701 	file = fcheck_files(files, fd);
702 	if (file) {
703 		/* File object ref couldn't be taken.
704 		 * dup2() atomicity guarantee is the reason
705 		 * we loop to catch the new file (or NULL pointer)
706 		 */
707 		if (file->f_mode & mask)
708 			file = NULL;
709 		else if (!get_file_rcu_many(file, refs))
710 			goto loop;
711 		else if (__fcheck_files(files, fd) != file) {
712 			fput_many(file, refs);
713 			goto loop;
714 		}
715 	}
716 	rcu_read_unlock();
717 
718 	return file;
719 }
720 
fget_many(unsigned int fd,unsigned int refs)721 struct file *fget_many(unsigned int fd, unsigned int refs)
722 {
723 	return __fget(fd, FMODE_PATH, refs);
724 }
725 
fget(unsigned int fd)726 struct file *fget(unsigned int fd)
727 {
728 	return __fget(fd, FMODE_PATH, 1);
729 }
730 EXPORT_SYMBOL(fget);
731 
fget_raw(unsigned int fd)732 struct file *fget_raw(unsigned int fd)
733 {
734 	return __fget(fd, 0, 1);
735 }
736 EXPORT_SYMBOL(fget_raw);
737 
738 /*
739  * Lightweight file lookup - no refcnt increment if fd table isn't shared.
740  *
741  * You can use this instead of fget if you satisfy all of the following
742  * conditions:
743  * 1) You must call fput_light before exiting the syscall and returning control
744  *    to userspace (i.e. you cannot remember the returned struct file * after
745  *    returning to userspace).
746  * 2) You must not call filp_close on the returned struct file * in between
747  *    calls to fget_light and fput_light.
748  * 3) You must not clone the current task in between the calls to fget_light
749  *    and fput_light.
750  *
751  * The fput_needed flag returned by fget_light should be passed to the
752  * corresponding fput_light.
753  */
__fget_light(unsigned int fd,fmode_t mask)754 static unsigned long __fget_light(unsigned int fd, fmode_t mask)
755 {
756 	struct files_struct *files = current->files;
757 	struct file *file;
758 
759 	if (atomic_read(&files->count) == 1) {
760 		file = __fcheck_files(files, fd);
761 		if (!file || unlikely(file->f_mode & mask))
762 			return 0;
763 		return (unsigned long)file;
764 	} else {
765 		file = __fget(fd, mask, 1);
766 		if (!file)
767 			return 0;
768 		return FDPUT_FPUT | (unsigned long)file;
769 	}
770 }
__fdget(unsigned int fd)771 unsigned long __fdget(unsigned int fd)
772 {
773 	return __fget_light(fd, FMODE_PATH);
774 }
775 EXPORT_SYMBOL(__fdget);
776 
__fdget_raw(unsigned int fd)777 unsigned long __fdget_raw(unsigned int fd)
778 {
779 	return __fget_light(fd, 0);
780 }
781 
__fdget_pos(unsigned int fd)782 unsigned long __fdget_pos(unsigned int fd)
783 {
784 	unsigned long v = __fdget(fd);
785 	struct file *file = (struct file *)(v & ~3);
786 
787 	if (file && (file->f_mode & FMODE_ATOMIC_POS)) {
788 		if (file_count(file) > 1) {
789 			v |= FDPUT_POS_UNLOCK;
790 			mutex_lock(&file->f_pos_lock);
791 		}
792 	}
793 	return v;
794 }
795 
796 /*
797  * We only lock f_pos if we have threads or if the file might be
798  * shared with another process. In both cases we'll have an elevated
799  * file count (done either by fdget() or by fork()).
800  */
801 
set_close_on_exec(unsigned int fd,int flag)802 void set_close_on_exec(unsigned int fd, int flag)
803 {
804 	struct files_struct *files = current->files;
805 	struct fdtable *fdt;
806 	spin_lock(&files->file_lock);
807 	fdt = files_fdtable(files);
808 	if (flag)
809 		__set_close_on_exec(fd, fdt);
810 	else
811 		__clear_close_on_exec(fd, fdt);
812 	spin_unlock(&files->file_lock);
813 }
814 
get_close_on_exec(unsigned int fd)815 bool get_close_on_exec(unsigned int fd)
816 {
817 	struct files_struct *files = current->files;
818 	struct fdtable *fdt;
819 	bool res;
820 	rcu_read_lock();
821 	fdt = files_fdtable(files);
822 	res = close_on_exec(fd, fdt);
823 	rcu_read_unlock();
824 	return res;
825 }
826 
do_dup2(struct files_struct * files,struct file * file,unsigned fd,unsigned flags)827 static int do_dup2(struct files_struct *files,
828 	struct file *file, unsigned fd, unsigned flags)
829 __releases(&files->file_lock)
830 {
831 	struct file *tofree;
832 	struct fdtable *fdt;
833 
834 	/*
835 	 * We need to detect attempts to do dup2() over allocated but still
836 	 * not finished descriptor.  NB: OpenBSD avoids that at the price of
837 	 * extra work in their equivalent of fget() - they insert struct
838 	 * file immediately after grabbing descriptor, mark it larval if
839 	 * more work (e.g. actual opening) is needed and make sure that
840 	 * fget() treats larval files as absent.  Potentially interesting,
841 	 * but while extra work in fget() is trivial, locking implications
842 	 * and amount of surgery on open()-related paths in VFS are not.
843 	 * FreeBSD fails with -EBADF in the same situation, NetBSD "solution"
844 	 * deadlocks in rather amusing ways, AFAICS.  All of that is out of
845 	 * scope of POSIX or SUS, since neither considers shared descriptor
846 	 * tables and this condition does not arise without those.
847 	 */
848 	fdt = files_fdtable(files);
849 	tofree = fdt->fd[fd];
850 	if (!tofree && fd_is_open(fd, fdt))
851 		goto Ebusy;
852 	get_file(file);
853 	rcu_assign_pointer(fdt->fd[fd], file);
854 	__set_open_fd(fd, fdt);
855 	if (flags & O_CLOEXEC)
856 		__set_close_on_exec(fd, fdt);
857 	else
858 		__clear_close_on_exec(fd, fdt);
859 	spin_unlock(&files->file_lock);
860 
861 	if (tofree)
862 		filp_close(tofree, files);
863 
864 	return fd;
865 
866 Ebusy:
867 	spin_unlock(&files->file_lock);
868 	return -EBUSY;
869 }
870 
replace_fd(unsigned fd,struct file * file,unsigned flags)871 int replace_fd(unsigned fd, struct file *file, unsigned flags)
872 {
873 	int err;
874 	struct files_struct *files = current->files;
875 
876 	if (!file)
877 		return __close_fd(files, fd);
878 
879 	if (fd >= rlimit(RLIMIT_NOFILE))
880 		return -EBADF;
881 
882 	spin_lock(&files->file_lock);
883 	err = expand_files(files, fd);
884 	if (unlikely(err < 0))
885 		goto out_unlock;
886 	return do_dup2(files, file, fd, flags);
887 
888 out_unlock:
889 	spin_unlock(&files->file_lock);
890 	return err;
891 }
892 
SYSCALL_DEFINE3(dup3,unsigned int,oldfd,unsigned int,newfd,int,flags)893 SYSCALL_DEFINE3(dup3, unsigned int, oldfd, unsigned int, newfd, int, flags)
894 {
895 	int err = -EBADF;
896 	struct file *file;
897 	struct files_struct *files = current->files;
898 
899 	if ((flags & ~O_CLOEXEC) != 0)
900 		return -EINVAL;
901 
902 	if (unlikely(oldfd == newfd))
903 		return -EINVAL;
904 
905 	if (newfd >= rlimit(RLIMIT_NOFILE))
906 		return -EBADF;
907 
908 	spin_lock(&files->file_lock);
909 	err = expand_files(files, newfd);
910 	file = fcheck(oldfd);
911 	if (unlikely(!file))
912 		goto Ebadf;
913 	if (unlikely(err < 0)) {
914 		if (err == -EMFILE)
915 			goto Ebadf;
916 		goto out_unlock;
917 	}
918 	return do_dup2(files, file, newfd, flags);
919 
920 Ebadf:
921 	err = -EBADF;
922 out_unlock:
923 	spin_unlock(&files->file_lock);
924 	return err;
925 }
926 
SYSCALL_DEFINE2(dup2,unsigned int,oldfd,unsigned int,newfd)927 SYSCALL_DEFINE2(dup2, unsigned int, oldfd, unsigned int, newfd)
928 {
929 	if (unlikely(newfd == oldfd)) { /* corner case */
930 		struct files_struct *files = current->files;
931 		int retval = oldfd;
932 
933 		rcu_read_lock();
934 		if (!fcheck_files(files, oldfd))
935 			retval = -EBADF;
936 		rcu_read_unlock();
937 		return retval;
938 	}
939 	return sys_dup3(oldfd, newfd, 0);
940 }
941 
SYSCALL_DEFINE1(dup,unsigned int,fildes)942 SYSCALL_DEFINE1(dup, unsigned int, fildes)
943 {
944 	int ret = -EBADF;
945 	struct file *file = fget_raw(fildes);
946 
947 	if (file) {
948 		ret = get_unused_fd_flags(0);
949 		if (ret >= 0)
950 			fd_install(ret, file);
951 		else
952 			fput(file);
953 	}
954 	return ret;
955 }
956 
f_dupfd(unsigned int from,struct file * file,unsigned flags)957 int f_dupfd(unsigned int from, struct file *file, unsigned flags)
958 {
959 	int err;
960 	if (from >= rlimit(RLIMIT_NOFILE))
961 		return -EINVAL;
962 	err = alloc_fd(from, flags);
963 	if (err >= 0) {
964 		get_file(file);
965 		fd_install(err, file);
966 	}
967 	return err;
968 }
969 
iterate_fd(struct files_struct * files,unsigned n,int (* f)(const void *,struct file *,unsigned),const void * p)970 int iterate_fd(struct files_struct *files, unsigned n,
971 		int (*f)(const void *, struct file *, unsigned),
972 		const void *p)
973 {
974 	struct fdtable *fdt;
975 	int res = 0;
976 	if (!files)
977 		return 0;
978 	spin_lock(&files->file_lock);
979 	for (fdt = files_fdtable(files); n < fdt->max_fds; n++) {
980 		struct file *file;
981 		file = rcu_dereference_check_fdtable(files, fdt->fd[n]);
982 		if (!file)
983 			continue;
984 		res = f(p, file, n);
985 		if (res)
986 			break;
987 	}
988 	spin_unlock(&files->file_lock);
989 	return res;
990 }
991 EXPORT_SYMBOL(iterate_fd);
992