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