blob: 5295535b60c60768ccb91034b3ba290dc1a57f1a [file] [log] [blame]
Al Viro9f3acc32008-04-24 07:44:08 -04001/*
2 * descriptor table internals; you almost certainly want file.h instead.
3 */
4
5#ifndef __LINUX_FDTABLE_H
6#define __LINUX_FDTABLE_H
7
Al Viro9f3acc32008-04-24 07:44:08 -04008#include <linux/posix_types.h>
9#include <linux/compiler.h>
10#include <linux/spinlock.h>
11#include <linux/rcupdate.h>
12#include <linux/types.h>
Ingo Molnar21e54452009-03-25 16:29:05 +010013#include <linux/init.h>
Paul E. McKenney2c666df2010-04-29 20:48:47 -070014#include <linux/fs.h>
Ingo Molnar21e54452009-03-25 16:29:05 +010015
Arun Sharma600634972011-07-26 16:09:06 -070016#include <linux/atomic.h>
Al Viro9f3acc32008-04-24 07:44:08 -040017
18/*
19 * The default fd array needs to be at least BITS_PER_LONG,
20 * as this is the granularity returned by copy_fdset().
21 */
22#define NR_OPEN_DEFAULT BITS_PER_LONG
23
Al Viro9f3acc32008-04-24 07:44:08 -040024struct fdtable {
25 unsigned int max_fds;
Arnd Bergmann4d2deb42010-02-24 20:01:56 +010026 struct file __rcu **fd; /* current fd array */
David Howells1fd36ad2012-02-16 17:49:54 +000027 unsigned long *close_on_exec;
28 unsigned long *open_fds;
Linus Torvaldsf3f86e32015-10-30 16:53:57 -070029 unsigned long *full_fds_bits;
Al Viro9f3acc32008-04-24 07:44:08 -040030 struct rcu_head rcu;
Al Viro9f3acc32008-04-24 07:44:08 -040031};
32
David Howells1dce27c2012-02-16 17:49:42 +000033static inline bool close_on_exec(int fd, const struct fdtable *fdt)
34{
David Howells1fd36ad2012-02-16 17:49:54 +000035 return test_bit(fd, fdt->close_on_exec);
David Howells1dce27c2012-02-16 17:49:42 +000036}
37
David Howells1dce27c2012-02-16 17:49:42 +000038static inline bool fd_is_open(int fd, const struct fdtable *fdt)
39{
David Howells1fd36ad2012-02-16 17:49:54 +000040 return test_bit(fd, fdt->open_fds);
David Howells1dce27c2012-02-16 17:49:42 +000041}
42
Al Viro9f3acc32008-04-24 07:44:08 -040043/*
44 * Open file table structure
45 */
46struct files_struct {
47 /*
48 * read mostly part
49 */
50 atomic_t count;
Eric Dumazet8a812522015-06-30 15:54:08 +020051 bool resize_in_progress;
52 wait_queue_head_t resize_wait;
53
Arnd Bergmann4d2deb42010-02-24 20:01:56 +010054 struct fdtable __rcu *fdt;
Al Viro9f3acc32008-04-24 07:44:08 -040055 struct fdtable fdtab;
56 /*
57 * written part on a separate cache line in SMP
58 */
59 spinlock_t file_lock ____cacheline_aligned_in_smp;
60 int next_fd;
David Howells1fd36ad2012-02-16 17:49:54 +000061 unsigned long close_on_exec_init[1];
62 unsigned long open_fds_init[1];
Linus Torvaldsf3f86e32015-10-30 16:53:57 -070063 unsigned long full_fds_bits_init[1];
Arnd Bergmann4d2deb42010-02-24 20:01:56 +010064 struct file __rcu * fd_array[NR_OPEN_DEFAULT];
Al Viro9f3acc32008-04-24 07:44:08 -040065};
66
Al Viro9f3acc32008-04-24 07:44:08 -040067struct file_operations;
68struct vfsmount;
69struct dentry;
70
Oleg Nesterova8d4b832014-01-11 19:19:32 +010071#define rcu_dereference_check_fdtable(files, fdtfd) \
72 rcu_dereference_check((fdtfd), lockdep_is_held(&(files)->file_lock))
73
74#define files_fdtable(files) \
75 rcu_dereference_check_fdtable((files), (files)->fdt)
76
77/*
78 * The caller must ensure that fd table isn't shared or hold rcu or file lock
79 */
80static inline struct file *__fcheck_files(struct files_struct *files, unsigned int fd)
Al Viro9f3acc32008-04-24 07:44:08 -040081{
Oleg Nesterova8d4b832014-01-11 19:19:32 +010082 struct fdtable *fdt = rcu_dereference_raw(files->fdt);
Al Viro9f3acc32008-04-24 07:44:08 -040083
84 if (fd < fdt->max_fds)
Oleg Nesterova8d4b832014-01-11 19:19:32 +010085 return rcu_dereference_raw(fdt->fd[fd]);
86 return NULL;
87}
88
89static inline struct file *fcheck_files(struct files_struct *files, unsigned int fd)
90{
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -070091 RCU_LOCKDEP_WARN(!rcu_read_lock_held() &&
92 !lockdep_is_held(&files->file_lock),
Oleg Nesterova8d4b832014-01-11 19:19:32 +010093 "suspicious rcu_dereference_check() usage");
94 return __fcheck_files(files, fd);
Al Viro9f3acc32008-04-24 07:44:08 -040095}
96
97/*
98 * Check whether the specified fd has an open file.
99 */
100#define fcheck(fd) fcheck_files(current->files, fd)
101
102struct task_struct;
103
104struct files_struct *get_files_struct(struct task_struct *);
105void put_files_struct(struct files_struct *fs);
106void reset_files_struct(struct files_struct *);
107int unshare_files(struct files_struct **);
Al Viro02afc6262008-05-08 19:42:56 -0400108struct files_struct *dup_fd(struct files_struct *, int *);
Al Viro6a6d27d2012-08-21 09:56:33 -0400109void do_close_on_exec(struct files_struct *);
Al Viroc3c073f2012-08-21 22:32:06 -0400110int iterate_fd(struct files_struct *, unsigned,
111 int (*)(const void *, struct file *, unsigned),
112 const void *);
Al Viro9f3acc32008-04-24 07:44:08 -0400113
Al Virodcfadfa2012-08-12 17:27:30 -0400114extern int __alloc_fd(struct files_struct *files,
115 unsigned start, unsigned end, unsigned flags);
Al Virof869e8a2012-08-15 21:06:33 -0400116extern void __fd_install(struct files_struct *files,
117 unsigned int fd, struct file *file);
Al Viro483ce1d2012-08-19 12:04:24 -0400118extern int __close_fd(struct files_struct *files,
119 unsigned int fd);
Al Virodcfadfa2012-08-12 17:27:30 -0400120
Al Viro9f3acc32008-04-24 07:44:08 -0400121extern struct kmem_cache *files_cachep;
122
123#endif /* __LINUX_FDTABLE_H */