include/linux/fdtable.h

   1 /*
   2  * descriptor table internals; you almost certainly want file.h instead.
   3  */
   4
   5 #ifndef __LINUX_FDTABLE_H
   6 #define __LINUX_FDTABLE_H
   7
   8 #include <linux/posix_types.h>
   9 #include <linux/compiler.h>
  10 #include <linux/spinlock.h>
  11 #include <linux/rcupdate.h>
  12 #include <linux/nospec.h>
  13 #include <linux/types.h>
  14 #include <linux/init.h>
  15 #include <linux/fs.h>
  16
  17 #include <linux/atomic.h>
  18
  19 /*
  20  * The default fd array needs to be at least BITS_PER_LONG,
  21  * as this is the granularity returned by copy_fdset().
  22  */
  23 #define NR_OPEN_DEFAULT BITS_PER_LONG
  24
  25 /*
  26  * The embedded_fd_set is a small fd_set,
  27  * suitable for most tasks (which open <= BITS_PER_LONG files)
  28  */
  29 struct embedded_fd_set {
  30         unsigned long fds_bits[1];
  31 };
  32
  33 struct fdtable {
  34         unsigned int max_fds;
  35         struct file __rcu **fd;      /* current fd array */
  36         fd_set *close_on_exec;
  37         fd_set *open_fds;
  38         struct rcu_head rcu;
  39         struct fdtable *next;
  40 };
  41
  42 /*
  43  * Open file table structure
  44  */
  45 struct files_struct {
  46   /*
  47    * read mostly part
  48    */
  49         atomic_t count;
  50         struct fdtable __rcu *fdt;
  51         struct fdtable fdtab;
  52   /*
  53    * written part on a separate cache line in SMP
  54    */
  55         spinlock_t file_lock ____cacheline_aligned_in_smp;
  56         int next_fd;
  57         struct embedded_fd_set close_on_exec_init;
  58         struct embedded_fd_set open_fds_init;
  59         struct file __rcu * fd_array[NR_OPEN_DEFAULT];
  60 };
  61
  62 #define rcu_dereference_check_fdtable(files, fdtfd) \
  63         (rcu_dereference_check((fdtfd), \
  64                                lockdep_is_held(&(files)->file_lock) || \
  65                                atomic_read(&(files)->count) == 1 || \
  66                                rcu_my_thread_group_empty()))
  67
  68 #define files_fdtable(files) \
  69                 (rcu_dereference_check_fdtable((files), (files)->fdt))
  70
  71 struct file_operations;
  72 struct vfsmount;
  73 struct dentry;
  74
  75 extern int expand_files(struct files_struct *, int nr);
  76 extern void free_fdtable_rcu(struct rcu_head *rcu);
  77 extern void __init files_defer_init(void);
  78
  79 static inline void free_fdtable(struct fdtable *fdt)
  80 {
  81         call_rcu(&fdt->rcu, free_fdtable_rcu);
  82 }
  83
  84 static inline struct file * fcheck_files(struct files_struct *files, unsigned int fd)
  85 {
  86         struct file * file = NULL;
  87         struct fdtable *fdt = files_fdtable(files);
  88
  89         if (fd < fdt->max_fds) {
  90                 fd = array_index_nospec(fd, fdt->max_fds);
  91                 file = rcu_dereference_check_fdtable(files, fdt->fd[fd]);
  92         }
  93         return file;
  94 }
  95
  96 /*
  97  * Check whether the specified fd has an open file.
  98  */
  99 #define fcheck(fd)      fcheck_files(current->files, fd)
 100
 101 struct task_struct;
 102
 103 struct files_struct *get_files_struct(struct task_struct *);
 104 void put_files_struct(struct files_struct *fs);
 105 void reset_files_struct(struct files_struct *);
 106 int unshare_files(struct files_struct **);
 107 struct files_struct *dup_fd(struct files_struct *, int *);
 108
 109 extern struct kmem_cache *files_cachep;
 110
 111 #endif /* __LINUX_FDTABLE_H */