new wrapper: alloc_file_pseudo()
[muen/linux.git] / fs / file_table.c
1 /*
2  *  linux/fs/file_table.c
3  *
4  *  Copyright (C) 1991, 1992  Linus Torvalds
5  *  Copyright (C) 1997 David S. Miller (davem@caip.rutgers.edu)
6  */
7
8 #include <linux/string.h>
9 #include <linux/slab.h>
10 #include <linux/file.h>
11 #include <linux/fdtable.h>
12 #include <linux/init.h>
13 #include <linux/module.h>
14 #include <linux/fs.h>
15 #include <linux/security.h>
16 #include <linux/cred.h>
17 #include <linux/eventpoll.h>
18 #include <linux/rcupdate.h>
19 #include <linux/mount.h>
20 #include <linux/capability.h>
21 #include <linux/cdev.h>
22 #include <linux/fsnotify.h>
23 #include <linux/sysctl.h>
24 #include <linux/percpu_counter.h>
25 #include <linux/percpu.h>
26 #include <linux/task_work.h>
27 #include <linux/ima.h>
28 #include <linux/swap.h>
29
30 #include <linux/atomic.h>
31
32 #include "internal.h"
33
34 /* sysctl tunables... */
35 struct files_stat_struct files_stat = {
36         .max_files = NR_FILE
37 };
38
39 /* SLAB cache for file structures */
40 static struct kmem_cache *filp_cachep __read_mostly;
41
42 static struct percpu_counter nr_files __cacheline_aligned_in_smp;
43
44 static void file_free_rcu(struct rcu_head *head)
45 {
46         struct file *f = container_of(head, struct file, f_u.fu_rcuhead);
47
48         put_cred(f->f_cred);
49         kmem_cache_free(filp_cachep, f);
50 }
51
52 static inline void file_free(struct file *f)
53 {
54         security_file_free(f);
55         percpu_counter_dec(&nr_files);
56         call_rcu(&f->f_u.fu_rcuhead, file_free_rcu);
57 }
58
59 /*
60  * Return the total number of open files in the system
61  */
62 static long get_nr_files(void)
63 {
64         return percpu_counter_read_positive(&nr_files);
65 }
66
67 /*
68  * Return the maximum number of open files in the system
69  */
70 unsigned long get_max_files(void)
71 {
72         return files_stat.max_files;
73 }
74 EXPORT_SYMBOL_GPL(get_max_files);
75
76 /*
77  * Handle nr_files sysctl
78  */
79 #if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
80 int proc_nr_files(struct ctl_table *table, int write,
81                      void __user *buffer, size_t *lenp, loff_t *ppos)
82 {
83         files_stat.nr_files = get_nr_files();
84         return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
85 }
86 #else
87 int proc_nr_files(struct ctl_table *table, int write,
88                      void __user *buffer, size_t *lenp, loff_t *ppos)
89 {
90         return -ENOSYS;
91 }
92 #endif
93
94 /* Find an unused file structure and return a pointer to it.
95  * Returns an error pointer if some error happend e.g. we over file
96  * structures limit, run out of memory or operation is not permitted.
97  *
98  * Be very careful using this.  You are responsible for
99  * getting write access to any mount that you might assign
100  * to this filp, if it is opened for write.  If this is not
101  * done, you will imbalance int the mount's writer count
102  * and a warning at __fput() time.
103  */
104 struct file *alloc_empty_file(int flags, const struct cred *cred)
105 {
106         static long old_max;
107         struct file *f;
108         int error;
109
110         /*
111          * Privileged users can go above max_files
112          */
113         if (get_nr_files() >= files_stat.max_files && !capable(CAP_SYS_ADMIN)) {
114                 /*
115                  * percpu_counters are inaccurate.  Do an expensive check before
116                  * we go and fail.
117                  */
118                 if (percpu_counter_sum_positive(&nr_files) >= files_stat.max_files)
119                         goto over;
120         }
121
122         f = kmem_cache_zalloc(filp_cachep, GFP_KERNEL);
123         if (unlikely(!f))
124                 return ERR_PTR(-ENOMEM);
125
126         f->f_cred = get_cred(cred);
127         error = security_file_alloc(f);
128         if (unlikely(error)) {
129                 file_free_rcu(&f->f_u.fu_rcuhead);
130                 return ERR_PTR(error);
131         }
132
133         atomic_long_set(&f->f_count, 1);
134         rwlock_init(&f->f_owner.lock);
135         spin_lock_init(&f->f_lock);
136         mutex_init(&f->f_pos_lock);
137         eventpoll_init_file(f);
138         f->f_flags = flags;
139         f->f_mode = OPEN_FMODE(flags);
140         /* f->f_version: 0 */
141         percpu_counter_inc(&nr_files);
142         return f;
143
144 over:
145         /* Ran out of filps - report that */
146         if (get_nr_files() > old_max) {
147                 pr_info("VFS: file-max limit %lu reached\n", get_max_files());
148                 old_max = get_nr_files();
149         }
150         return ERR_PTR(-ENFILE);
151 }
152
153 /**
154  * alloc_file - allocate and initialize a 'struct file'
155  *
156  * @path: the (dentry, vfsmount) pair for the new file
157  * @flags: O_... flags with which the new file will be opened
158  * @fop: the 'struct file_operations' for the new file
159  */
160 struct file *alloc_file(const struct path *path, int flags,
161                 const struct file_operations *fop)
162 {
163         struct file *file;
164
165         file = alloc_empty_file(flags, current_cred());
166         if (IS_ERR(file))
167                 return file;
168
169         file->f_path = *path;
170         file->f_inode = path->dentry->d_inode;
171         file->f_mapping = path->dentry->d_inode->i_mapping;
172         file->f_wb_err = filemap_sample_wb_err(file->f_mapping);
173         if ((file->f_mode & FMODE_READ) &&
174              likely(fop->read || fop->read_iter))
175                 file->f_mode |= FMODE_CAN_READ;
176         if ((file->f_mode & FMODE_WRITE) &&
177              likely(fop->write || fop->write_iter))
178                 file->f_mode |= FMODE_CAN_WRITE;
179         file->f_mode |= FMODE_OPENED;
180         file->f_op = fop;
181         if ((file->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_READ)
182                 i_readcount_inc(path->dentry->d_inode);
183         return file;
184 }
185 EXPORT_SYMBOL(alloc_file);
186
187 struct file *alloc_file_pseudo(struct inode *inode, struct vfsmount *mnt,
188                                 const char *name, int flags,
189                                 const struct file_operations *fops)
190 {
191         static const struct dentry_operations anon_ops = {
192                 .d_dname = simple_dname
193         };
194         struct qstr this = QSTR_INIT(name, strlen(name));
195         struct path path;
196         struct file *file;
197
198         path.dentry = d_alloc_pseudo(mnt->mnt_sb, &this);
199         if (!path.dentry)
200                 return ERR_PTR(-ENOMEM);
201         if (!mnt->mnt_sb->s_d_op)
202                 d_set_d_op(path.dentry, &anon_ops);
203         path.mnt = mntget(mnt);
204         d_instantiate(path.dentry, inode);
205         file = alloc_file(&path, flags, fops);
206         if (IS_ERR(file)) {
207                 ihold(inode);
208                 path_put(&path);
209         }
210         return file;
211 }
212 EXPORT_SYMBOL(alloc_file_pseudo);
213
214 /* the real guts of fput() - releasing the last reference to file
215  */
216 static void __fput(struct file *file)
217 {
218         struct dentry *dentry = file->f_path.dentry;
219         struct vfsmount *mnt = file->f_path.mnt;
220         struct inode *inode = file->f_inode;
221
222         if (unlikely(!(file->f_mode & FMODE_OPENED)))
223                 goto out;
224
225         might_sleep();
226
227         fsnotify_close(file);
228         /*
229          * The function eventpoll_release() should be the first called
230          * in the file cleanup chain.
231          */
232         eventpoll_release(file);
233         locks_remove_file(file);
234
235         ima_file_free(file);
236         if (unlikely(file->f_flags & FASYNC)) {
237                 if (file->f_op->fasync)
238                         file->f_op->fasync(-1, file, 0);
239         }
240         if (file->f_op->release)
241                 file->f_op->release(inode, file);
242         if (unlikely(S_ISCHR(inode->i_mode) && inode->i_cdev != NULL &&
243                      !(file->f_mode & FMODE_PATH))) {
244                 cdev_put(inode->i_cdev);
245         }
246         fops_put(file->f_op);
247         put_pid(file->f_owner.pid);
248         if ((file->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_READ)
249                 i_readcount_dec(inode);
250         if (file->f_mode & FMODE_WRITER) {
251                 put_write_access(inode);
252                 __mnt_drop_write(mnt);
253         }
254         dput(dentry);
255         mntput(mnt);
256 out:
257         file_free(file);
258 }
259
260 static LLIST_HEAD(delayed_fput_list);
261 static void delayed_fput(struct work_struct *unused)
262 {
263         struct llist_node *node = llist_del_all(&delayed_fput_list);
264         struct file *f, *t;
265
266         llist_for_each_entry_safe(f, t, node, f_u.fu_llist)
267                 __fput(f);
268 }
269
270 static void ____fput(struct callback_head *work)
271 {
272         __fput(container_of(work, struct file, f_u.fu_rcuhead));
273 }
274
275 /*
276  * If kernel thread really needs to have the final fput() it has done
277  * to complete, call this.  The only user right now is the boot - we
278  * *do* need to make sure our writes to binaries on initramfs has
279  * not left us with opened struct file waiting for __fput() - execve()
280  * won't work without that.  Please, don't add more callers without
281  * very good reasons; in particular, never call that with locks
282  * held and never call that from a thread that might need to do
283  * some work on any kind of umount.
284  */
285 void flush_delayed_fput(void)
286 {
287         delayed_fput(NULL);
288 }
289
290 static DECLARE_DELAYED_WORK(delayed_fput_work, delayed_fput);
291
292 void fput(struct file *file)
293 {
294         if (atomic_long_dec_and_test(&file->f_count)) {
295                 struct task_struct *task = current;
296
297                 if (likely(!in_interrupt() && !(task->flags & PF_KTHREAD))) {
298                         init_task_work(&file->f_u.fu_rcuhead, ____fput);
299                         if (!task_work_add(task, &file->f_u.fu_rcuhead, true))
300                                 return;
301                         /*
302                          * After this task has run exit_task_work(),
303                          * task_work_add() will fail.  Fall through to delayed
304                          * fput to avoid leaking *file.
305                          */
306                 }
307
308                 if (llist_add(&file->f_u.fu_llist, &delayed_fput_list))
309                         schedule_delayed_work(&delayed_fput_work, 1);
310         }
311 }
312
313 /*
314  * synchronous analog of fput(); for kernel threads that might be needed
315  * in some umount() (and thus can't use flush_delayed_fput() without
316  * risking deadlocks), need to wait for completion of __fput() and know
317  * for this specific struct file it won't involve anything that would
318  * need them.  Use only if you really need it - at the very least,
319  * don't blindly convert fput() by kernel thread to that.
320  */
321 void __fput_sync(struct file *file)
322 {
323         if (atomic_long_dec_and_test(&file->f_count)) {
324                 struct task_struct *task = current;
325                 BUG_ON(!(task->flags & PF_KTHREAD));
326                 __fput(file);
327         }
328 }
329
330 EXPORT_SYMBOL(fput);
331
332 void __init files_init(void)
333 {
334         filp_cachep = kmem_cache_create("filp", sizeof(struct file), 0,
335                         SLAB_HWCACHE_ALIGN | SLAB_PANIC | SLAB_ACCOUNT, NULL);
336         percpu_counter_init(&nr_files, 0, GFP_KERNEL);
337 }
338
339 /*
340  * One file with associated inode and dcache is very roughly 1K. Per default
341  * do not use more than 10% of our memory for files.
342  */
343 void __init files_maxfiles_init(void)
344 {
345         unsigned long n;
346         unsigned long memreserve = (totalram_pages - nr_free_pages()) * 3/2;
347
348         memreserve = min(memreserve, totalram_pages - 1);
349         n = ((totalram_pages - memreserve) * (PAGE_SIZE / 1024)) / 10;
350
351         files_stat.max_files = max_t(unsigned long, n, NR_FILE);
352 }