Branch data Line data Source code
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/eventpoll.h>
17 : : #include <linux/rcupdate.h>
18 : : #include <linux/mount.h>
19 : : #include <linux/capability.h>
20 : : #include <linux/cdev.h>
21 : : #include <linux/fsnotify.h>
22 : : #include <linux/sysctl.h>
23 : : #include <linux/lglock.h>
24 : : #include <linux/percpu_counter.h>
25 : : #include <linux/percpu.h>
26 : : #include <linux/hardirq.h>
27 : : #include <linux/task_work.h>
28 : : #include <linux/ima.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 : 0 : 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 : 4482588 : put_cred(f->f_cred);
49 : 4503553 : kmem_cache_free(filp_cachep, f);
50 : 4509271 : }
51 : :
52 : : static inline void file_free(struct file *f)
53 : : {
54 : : percpu_counter_dec(&nr_files);
55 : : file_check_state(f);
56 : 4516118 : 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 : 8995835 : return percpu_counter_read_positive(&nr_files);
65 : : }
66 : :
67 : : /*
68 : : * Return the maximum number of open files in the system
69 : : */
70 : 0 : unsigned long get_max_files(void)
71 : : {
72 : 487251 : 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 : 0 : int proc_nr_files(ctl_table *table, int write,
81 : : void __user *buffer, size_t *lenp, loff_t *ppos)
82 : : {
83 : 0 : files_stat.nr_files = get_nr_files();
84 : 2 : return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
85 : : }
86 : : #else
87 : : int proc_nr_files(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 : 0 : struct file *get_empty_filp(void)
105 : : {
106 : 4493195 : const struct cred *cred = current_cred();
107 : : static long old_max;
108 : : struct file *f;
109 : : int error;
110 : :
111 : : /*
112 : : * Privileged users can go above max_files
113 : : */
114 [ - + ][ # # ]: 4502638 : if (get_nr_files() >= files_stat.max_files && !capable(CAP_SYS_ADMIN)) {
115 : : /*
116 : : * percpu_counters are inaccurate. Do an expensive check before
117 : : * we go and fail.
118 : : */
119 [ # # ]: 0 : if (percpu_counter_sum_positive(&nr_files) >= files_stat.max_files)
120 : : goto over;
121 : : }
122 : :
123 : 4502638 : f = kmem_cache_zalloc(filp_cachep, GFP_KERNEL);
124 [ + ]: 4493140 : if (unlikely(!f))
125 : : return ERR_PTR(-ENOMEM);
126 : :
127 : : percpu_counter_inc(&nr_files);
128 : 4465318 : f->f_cred = get_cred(cred);
129 : 4465318 : error = security_file_alloc(f);
130 [ - + ]: 4509983 : if (unlikely(error)) {
131 : : file_free(f);
132 : 0 : return ERR_PTR(error);
133 : : }
134 : :
135 : : atomic_long_set(&f->f_count, 1);
136 : 4509983 : rwlock_init(&f->f_owner.lock);
137 : 4509983 : spin_lock_init(&f->f_lock);
138 : 4509983 : mutex_init(&f->f_pos_lock);
139 : : eventpoll_init_file(f);
140 : : /* f->f_version: 0 */
141 : 4514981 : return f;
142 : :
143 : : over:
144 : : /* Ran out of filps - report that */
145 [ # # ]: 0 : if (get_nr_files() > old_max) {
146 : 0 : pr_info("VFS: file-max limit %lu reached\n", get_max_files());
147 : 0 : old_max = get_nr_files();
148 : : }
149 : : return ERR_PTR(-ENFILE);
150 : : }
151 : :
152 : : /**
153 : : * alloc_file - allocate and initialize a 'struct file'
154 : : * @mnt: the vfsmount on which the file will reside
155 : : * @dentry: the dentry representing the new file
156 : : * @mode: the mode with which the new file will be opened
157 : : * @fop: the 'struct file_operations' for the new file
158 : : *
159 : : * Use this instead of get_empty_filp() to get a new
160 : : * 'struct file'. Do so because of the same initialization
161 : : * pitfalls reasons listed for init_file(). This is a
162 : : * preferred interface to using init_file().
163 : : *
164 : : * If all the callers of init_file() are eliminated, its
165 : : * code should be moved into this function.
166 : : */
167 : 0 : struct file *alloc_file(struct path *path, fmode_t mode,
168 : : const struct file_operations *fop)
169 : : {
170 : : struct file *file;
171 : :
172 : 1403651 : file = get_empty_filp();
173 [ + ]: 1414219 : if (IS_ERR(file))
174 : : return file;
175 : :
176 : 1415591 : file->f_path = *path;
177 : 1415591 : file->f_inode = path->dentry->d_inode;
178 : 1415591 : file->f_mapping = path->dentry->d_inode->i_mapping;
179 : 1415591 : file->f_mode = mode;
180 : 1415591 : file->f_op = fop;
181 : :
182 : : /*
183 : : * These mounts don't really matter in practice
184 : : * for r/o bind mounts. They aren't userspace-
185 : : * visible. We do this for consistency, and so
186 : : * that we can do debugging checks at __fput()
187 : : */
188 [ + + ][ + ]: 1415591 : if ((mode & FMODE_WRITE) && !special_file(path->dentry->d_inode->i_mode)) {
[ + + ][ + + ]
189 : : file_take_write(file);
190 [ - + ]: 1415591 : WARN_ON(mnt_clone_write(path->mnt));
191 : : }
192 : : if ((mode & (FMODE_READ | FMODE_WRITE)) == FMODE_READ)
193 : : i_readcount_inc(path->dentry->d_inode);
194 : : return file;
195 : : }
196 : : EXPORT_SYMBOL(alloc_file);
197 : :
198 : : /**
199 : : * drop_file_write_access - give up ability to write to a file
200 : : * @file: the file to which we will stop writing
201 : : *
202 : : * This is a central place which will give up the ability
203 : : * to write to @file, along with access to write through
204 : : * its vfsmount.
205 : : */
206 : 3235335 : static void drop_file_write_access(struct file *file)
207 : : {
208 : 3235335 : struct vfsmount *mnt = file->f_path.mnt;
209 : 3235335 : struct dentry *dentry = file->f_path.dentry;
210 : 3235335 : struct inode *inode = dentry->d_inode;
211 : :
212 : : put_write_access(inode);
213 : :
214 [ + + ][ + + ]: 3233689 : if (special_file(inode->i_mode))
[ + + ]
215 : : return;
216 : : if (file_check_writeable(file) != 0)
217 : : return;
218 : 2358437 : __mnt_drop_write(mnt);
219 : : file_release_write(file);
220 : : }
221 : :
222 : : /* the real guts of fput() - releasing the last reference to file
223 : : */
224 : 0 : static void __fput(struct file *file)
225 : : {
226 : 3864725 : struct dentry *dentry = file->f_path.dentry;
227 : 3864725 : struct vfsmount *mnt = file->f_path.mnt;
228 : 3864725 : struct inode *inode = file->f_inode;
229 : :
230 : : might_sleep();
231 : :
232 : : fsnotify_close(file);
233 : : /*
234 : : * The function eventpoll_release() should be the first called
235 : : * in the file cleanup chain.
236 : : */
237 : : eventpoll_release(file);
238 : 3874341 : locks_remove_flock(file);
239 : :
240 [ - + ]: 3878466 : if (unlikely(file->f_flags & FASYNC)) {
241 [ # # ]: 0 : if (file->f_op->fasync)
242 : 0 : file->f_op->fasync(-1, file, 0);
243 : : }
244 : : ima_file_free(file);
245 [ + + ]: 3882563 : if (file->f_op->release)
246 : 2986258 : file->f_op->release(inode, file);
247 : 3871948 : security_file_free(file);
248 [ + + ][ + + ]: 3885561 : if (unlikely(S_ISCHR(inode->i_mode) && inode->i_cdev != NULL &&
[ + + ][ + - ]
249 : : !(file->f_mode & FMODE_PATH))) {
250 : 16478 : cdev_put(inode->i_cdev);
251 : : }
252 [ + - ]: 3885610 : fops_put(file->f_op);
253 : 3868096 : put_pid(file->f_owner.pid);
254 : : if ((file->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_READ)
255 : : i_readcount_dec(inode);
256 [ + + ]: 3881352 : if (file->f_mode & FMODE_WRITE)
257 : 3229743 : drop_file_write_access(file);
258 : 3894757 : file->f_path.dentry = NULL;
259 : 3894757 : file->f_path.mnt = NULL;
260 : 3894757 : file->f_inode = NULL;
261 : : file_free(file);
262 : 3882173 : dput(dentry);
263 : 3870519 : mntput(mnt);
264 : 3868410 : }
265 : :
266 : : static LLIST_HEAD(delayed_fput_list);
267 : 0 : static void delayed_fput(struct work_struct *unused)
268 : : {
269 : : struct llist_node *node = llist_del_all(&delayed_fput_list);
270 : : struct llist_node *next;
271 : :
272 [ # # ]: 0 : for (; node; node = next) {
273 : : next = llist_next(node);
274 : 0 : __fput(llist_entry(node, struct file, f_u.fu_llist));
275 : : }
276 : 0 : }
277 : :
278 : 0 : static void ____fput(struct callback_head *work)
279 : : {
280 : 3860842 : __fput(container_of(work, struct file, f_u.fu_rcuhead));
281 : 3860016 : }
282 : :
283 : : /*
284 : : * If kernel thread really needs to have the final fput() it has done
285 : : * to complete, call this. The only user right now is the boot - we
286 : : * *do* need to make sure our writes to binaries on initramfs has
287 : : * not left us with opened struct file waiting for __fput() - execve()
288 : : * won't work without that. Please, don't add more callers without
289 : : * very good reasons; in particular, never call that with locks
290 : : * held and never call that from a thread that might need to do
291 : : * some work on any kind of umount.
292 : : */
293 : 0 : void flush_delayed_fput(void)
294 : : {
295 : 0 : delayed_fput(NULL);
296 : 0 : }
297 : :
298 : : static DECLARE_DELAYED_WORK(delayed_fput_work, delayed_fput);
299 : :
300 : 0 : void fput(struct file *file)
301 : : {
302 [ + + ]: 27146228 : if (atomic_long_dec_and_test(&file->f_count)) {
303 : 3871953 : struct task_struct *task = current;
304 : :
305 [ + ][ + + ]: 3871953 : if (likely(!in_interrupt() && !(task->flags & PF_KTHREAD))) {
306 : : init_task_work(&file->f_u.fu_rcuhead, ____fput);
307 [ - + ]: 3875930 : if (!task_work_add(task, &file->f_u.fu_rcuhead, true))
308 : 27157711 : return;
309 : : /*
310 : : * After this task has run exit_task_work(),
311 : : * task_work_add() will fail. Fall through to delayed
312 : : * fput to avoid leaking *file.
313 : : */
314 : : }
315 : :
316 [ # # ]: 0 : if (llist_add(&file->f_u.fu_llist, &delayed_fput_list))
317 : : schedule_delayed_work(&delayed_fput_work, 1);
318 : : }
319 : : }
320 : :
321 : : /*
322 : : * synchronous analog of fput(); for kernel threads that might be needed
323 : : * in some umount() (and thus can't use flush_delayed_fput() without
324 : : * risking deadlocks), need to wait for completion of __fput() and know
325 : : * for this specific struct file it won't involve anything that would
326 : : * need them. Use only if you really need it - at the very least,
327 : : * don't blindly convert fput() by kernel thread to that.
328 : : */
329 : 0 : void __fput_sync(struct file *file)
330 : : {
331 [ # # ]: 0 : if (atomic_long_dec_and_test(&file->f_count)) {
332 : 0 : struct task_struct *task = current;
333 [ # # ]: 0 : BUG_ON(!(task->flags & PF_KTHREAD));
334 : 0 : __fput(file);
335 : : }
336 : 0 : }
337 : :
338 : : EXPORT_SYMBOL(fput);
339 : :
340 : 0 : void put_filp(struct file *file)
341 : : {
342 [ + - ]: 632786 : if (atomic_long_dec_and_test(&file->f_count)) {
343 : 632786 : security_file_free(file);
344 : : file_free(file);
345 : : }
346 : 0 : }
347 : :
348 : 0 : void __init files_init(unsigned long mempages)
349 : : {
350 : : unsigned long n;
351 : :
352 : 0 : filp_cachep = kmem_cache_create("filp", sizeof(struct file), 0,
353 : : SLAB_HWCACHE_ALIGN | SLAB_PANIC, NULL);
354 : :
355 : : /*
356 : : * One file with associated inode and dcache is very roughly 1K.
357 : : * Per default don't use more than 10% of our memory for files.
358 : : */
359 : :
360 : 0 : n = (mempages * (PAGE_SIZE / 1024)) / 10;
361 : 0 : files_stat.max_files = max_t(unsigned long, n, NR_FILE);
362 : 0 : files_defer_init();
363 : 0 : percpu_counter_init(&nr_files, 0);
364 : 0 : }
|
