[PATCH] r/o bind mounts: create helper to drop file write access
[linux-2.6.git] / include / linux / file.h
1 /*
2  * Wrapper functions for accessing the file_struct fd array.
3  */
4
5 #ifndef __LINUX_FILE_H
6 #define __LINUX_FILE_H
7
8 #include <asm/atomic.h>
9 #include <linux/posix_types.h>
10 #include <linux/compiler.h>
11 #include <linux/spinlock.h>
12 #include <linux/rcupdate.h>
13 #include <linux/types.h>
14
15 /*
16  * The default fd array needs to be at least BITS_PER_LONG,
17  * as this is the granularity returned by copy_fdset().
18  */
19 #define NR_OPEN_DEFAULT BITS_PER_LONG
20
21 /*
22  * The embedded_fd_set is a small fd_set,
23  * suitable for most tasks (which open <= BITS_PER_LONG files)
24  */
25 struct embedded_fd_set {
26         unsigned long fds_bits[1];
27 };
28
29 struct fdtable {
30         unsigned int max_fds;
31         struct file ** fd;      /* current fd array */
32         fd_set *close_on_exec;
33         fd_set *open_fds;
34         struct rcu_head rcu;
35         struct fdtable *next;
36 };
37
38 /*
39  * Open file table structure
40  */
41 struct files_struct {
42   /*
43    * read mostly part
44    */
45         atomic_t count;
46         struct fdtable *fdt;
47         struct fdtable fdtab;
48   /*
49    * written part on a separate cache line in SMP
50    */
51         spinlock_t file_lock ____cacheline_aligned_in_smp;
52         int next_fd;
53         struct embedded_fd_set close_on_exec_init;
54         struct embedded_fd_set open_fds_init;
55         struct file * fd_array[NR_OPEN_DEFAULT];
56 };
57
58 #define files_fdtable(files) (rcu_dereference((files)->fdt))
59
60 extern struct kmem_cache *filp_cachep;
61
62 extern void __fput(struct file *);
63 extern void fput(struct file *);
64 extern void drop_file_write_access(struct file *file);
65
66 struct file_operations;
67 struct vfsmount;
68 struct dentry;
69 extern int init_file(struct file *, struct vfsmount *mnt,
70                 struct dentry *dentry, mode_t mode,
71                 const struct file_operations *fop);
72 extern struct file *alloc_file(struct vfsmount *, struct dentry *dentry,
73                 mode_t mode, const struct file_operations *fop);
74
75 static inline void fput_light(struct file *file, int fput_needed)
76 {
77         if (unlikely(fput_needed))
78                 fput(file);
79 }
80
81 extern struct file *fget(unsigned int fd);
82 extern struct file *fget_light(unsigned int fd, int *fput_needed);
83 extern void set_close_on_exec(unsigned int fd, int flag);
84 extern void put_filp(struct file *);
85 extern int get_unused_fd(void);
86 extern int get_unused_fd_flags(int flags);
87 extern void put_unused_fd(unsigned int fd);
88 struct kmem_cache;
89
90 extern int expand_files(struct files_struct *, int nr);
91 extern void free_fdtable_rcu(struct rcu_head *rcu);
92 extern void __init files_defer_init(void);
93
94 static inline void free_fdtable(struct fdtable *fdt)
95 {
96         call_rcu(&fdt->rcu, free_fdtable_rcu);
97 }
98
99 static inline struct file * fcheck_files(struct files_struct *files, unsigned int fd)
100 {
101         struct file * file = NULL;
102         struct fdtable *fdt = files_fdtable(files);
103
104         if (fd < fdt->max_fds)
105                 file = rcu_dereference(fdt->fd[fd]);
106         return file;
107 }
108
109 /*
110  * Check whether the specified fd has an open file.
111  */
112 #define fcheck(fd)      fcheck_files(current->files, fd)
113
114 extern void fd_install(unsigned int fd, struct file *file);
115
116 struct task_struct;
117
118 struct files_struct *get_files_struct(struct task_struct *);
119 void put_files_struct(struct files_struct *fs);
120 void reset_files_struct(struct task_struct *, struct files_struct *);
121
122 extern struct kmem_cache *files_cachep;
123
124 #endif /* __LINUX_FILE_H */