Commit | Line | Data |
---|---|---|
457c8996 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
1da177e4 LT |
2 | /* |
3 | * linux/fs/file_table.c | |
4 | * | |
5 | * Copyright (C) 1991, 1992 Linus Torvalds | |
6 | * Copyright (C) 1997 David S. Miller (davem@caip.rutgers.edu) | |
7 | */ | |
8 | ||
9 | #include <linux/string.h> | |
10 | #include <linux/slab.h> | |
11 | #include <linux/file.h> | |
9f3acc31 | 12 | #include <linux/fdtable.h> |
1da177e4 LT |
13 | #include <linux/init.h> |
14 | #include <linux/module.h> | |
1da177e4 | 15 | #include <linux/fs.h> |
5970e15d | 16 | #include <linux/filelock.h> |
1da177e4 | 17 | #include <linux/security.h> |
5b825c3a | 18 | #include <linux/cred.h> |
1da177e4 | 19 | #include <linux/eventpoll.h> |
ab2af1f5 | 20 | #include <linux/rcupdate.h> |
1da177e4 | 21 | #include <linux/mount.h> |
16f7e0fe | 22 | #include <linux/capability.h> |
1da177e4 | 23 | #include <linux/cdev.h> |
0eeca283 | 24 | #include <linux/fsnotify.h> |
529bf6be DS |
25 | #include <linux/sysctl.h> |
26 | #include <linux/percpu_counter.h> | |
6416ccb7 | 27 | #include <linux/percpu.h> |
4a9d4b02 | 28 | #include <linux/task_work.h> |
0552f879 | 29 | #include <linux/ima.h> |
4248b0da | 30 | #include <linux/swap.h> |
a3580ac9 | 31 | #include <linux/kmemleak.h> |
529bf6be | 32 | |
60063497 | 33 | #include <linux/atomic.h> |
1da177e4 | 34 | |
e81e3f4d EP |
35 | #include "internal.h" |
36 | ||
1da177e4 | 37 | /* sysctl tunables... */ |
204d5a24 | 38 | static struct files_stat_struct files_stat = { |
1da177e4 LT |
39 | .max_files = NR_FILE |
40 | }; | |
41 | ||
b6b3fdea ED |
42 | /* SLAB cache for file structures */ |
43 | static struct kmem_cache *filp_cachep __read_mostly; | |
44 | ||
529bf6be | 45 | static struct percpu_counter nr_files __cacheline_aligned_in_smp; |
1da177e4 | 46 | |
5c33b183 | 47 | static void file_free_rcu(struct rcu_head *head) |
1da177e4 | 48 | { |
e87f2c26 | 49 | struct file *f = container_of(head, struct file, f_rcuhead); |
d76b0d9b DH |
50 | |
51 | put_cred(f->f_cred); | |
529bf6be | 52 | kmem_cache_free(filp_cachep, f); |
1da177e4 LT |
53 | } |
54 | ||
529bf6be | 55 | static inline void file_free(struct file *f) |
1da177e4 | 56 | { |
e8cff84f | 57 | security_file_free(f); |
d3b1084d MS |
58 | if (!(f->f_mode & FMODE_NOACCOUNT)) |
59 | percpu_counter_dec(&nr_files); | |
e87f2c26 | 60 | call_rcu(&f->f_rcuhead, file_free_rcu); |
1da177e4 LT |
61 | } |
62 | ||
529bf6be DS |
63 | /* |
64 | * Return the total number of open files in the system | |
65 | */ | |
518de9b3 | 66 | static long get_nr_files(void) |
1da177e4 | 67 | { |
529bf6be | 68 | return percpu_counter_read_positive(&nr_files); |
1da177e4 LT |
69 | } |
70 | ||
529bf6be DS |
71 | /* |
72 | * Return the maximum number of open files in the system | |
73 | */ | |
518de9b3 | 74 | unsigned long get_max_files(void) |
ab2af1f5 | 75 | { |
529bf6be | 76 | return files_stat.max_files; |
ab2af1f5 | 77 | } |
529bf6be DS |
78 | EXPORT_SYMBOL_GPL(get_max_files); |
79 | ||
204d5a24 LC |
80 | #if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS) |
81 | ||
529bf6be DS |
82 | /* |
83 | * Handle nr_files sysctl | |
84 | */ | |
204d5a24 LC |
85 | static int proc_nr_files(struct ctl_table *table, int write, void *buffer, |
86 | size_t *lenp, loff_t *ppos) | |
529bf6be DS |
87 | { |
88 | files_stat.nr_files = get_nr_files(); | |
518de9b3 | 89 | return proc_doulongvec_minmax(table, write, buffer, lenp, ppos); |
529bf6be | 90 | } |
204d5a24 LC |
91 | |
92 | static struct ctl_table fs_stat_sysctls[] = { | |
93 | { | |
94 | .procname = "file-nr", | |
95 | .data = &files_stat, | |
96 | .maxlen = sizeof(files_stat), | |
97 | .mode = 0444, | |
98 | .proc_handler = proc_nr_files, | |
99 | }, | |
100 | { | |
101 | .procname = "file-max", | |
102 | .data = &files_stat.max_files, | |
103 | .maxlen = sizeof(files_stat.max_files), | |
104 | .mode = 0644, | |
105 | .proc_handler = proc_doulongvec_minmax, | |
106 | .extra1 = SYSCTL_LONG_ZERO, | |
107 | .extra2 = SYSCTL_LONG_MAX, | |
108 | }, | |
109 | { | |
110 | .procname = "nr_open", | |
111 | .data = &sysctl_nr_open, | |
112 | .maxlen = sizeof(unsigned int), | |
113 | .mode = 0644, | |
114 | .proc_handler = proc_dointvec_minmax, | |
115 | .extra1 = &sysctl_nr_open_min, | |
116 | .extra2 = &sysctl_nr_open_max, | |
117 | }, | |
118 | { } | |
119 | }; | |
120 | ||
121 | static int __init init_fs_stat_sysctls(void) | |
529bf6be | 122 | { |
204d5a24 | 123 | register_sysctl_init("fs", fs_stat_sysctls); |
a3580ac9 LC |
124 | if (IS_ENABLED(CONFIG_BINFMT_MISC)) { |
125 | struct ctl_table_header *hdr; | |
126 | hdr = register_sysctl_mount_point("fs/binfmt_misc"); | |
127 | kmemleak_not_leak(hdr); | |
128 | } | |
204d5a24 | 129 | return 0; |
529bf6be | 130 | } |
204d5a24 | 131 | fs_initcall(init_fs_stat_sysctls); |
529bf6be | 132 | #endif |
ab2af1f5 | 133 | |
d3b1084d MS |
134 | static struct file *__alloc_file(int flags, const struct cred *cred) |
135 | { | |
136 | struct file *f; | |
137 | int error; | |
138 | ||
139 | f = kmem_cache_zalloc(filp_cachep, GFP_KERNEL); | |
140 | if (unlikely(!f)) | |
141 | return ERR_PTR(-ENOMEM); | |
142 | ||
143 | f->f_cred = get_cred(cred); | |
144 | error = security_file_alloc(f); | |
145 | if (unlikely(error)) { | |
e87f2c26 | 146 | file_free_rcu(&f->f_rcuhead); |
d3b1084d MS |
147 | return ERR_PTR(error); |
148 | } | |
149 | ||
150 | atomic_long_set(&f->f_count, 1); | |
151 | rwlock_init(&f->f_owner.lock); | |
152 | spin_lock_init(&f->f_lock); | |
153 | mutex_init(&f->f_pos_lock); | |
d3b1084d MS |
154 | f->f_flags = flags; |
155 | f->f_mode = OPEN_FMODE(flags); | |
156 | /* f->f_version: 0 */ | |
157 | ||
158 | return f; | |
159 | } | |
160 | ||
1da177e4 | 161 | /* Find an unused file structure and return a pointer to it. |
1afc99be AV |
162 | * Returns an error pointer if some error happend e.g. we over file |
163 | * structures limit, run out of memory or operation is not permitted. | |
430e285e DH |
164 | * |
165 | * Be very careful using this. You are responsible for | |
166 | * getting write access to any mount that you might assign | |
167 | * to this filp, if it is opened for write. If this is not | |
168 | * done, you will imbalance int the mount's writer count | |
169 | * and a warning at __fput() time. | |
1da177e4 | 170 | */ |
ea73ea72 | 171 | struct file *alloc_empty_file(int flags, const struct cred *cred) |
1da177e4 | 172 | { |
518de9b3 | 173 | static long old_max; |
1afc99be | 174 | struct file *f; |
1da177e4 LT |
175 | |
176 | /* | |
177 | * Privileged users can go above max_files | |
178 | */ | |
529bf6be DS |
179 | if (get_nr_files() >= files_stat.max_files && !capable(CAP_SYS_ADMIN)) { |
180 | /* | |
181 | * percpu_counters are inaccurate. Do an expensive check before | |
182 | * we go and fail. | |
183 | */ | |
52d9f3b4 | 184 | if (percpu_counter_sum_positive(&nr_files) >= files_stat.max_files) |
529bf6be DS |
185 | goto over; |
186 | } | |
af4d2ecb | 187 | |
d3b1084d MS |
188 | f = __alloc_file(flags, cred); |
189 | if (!IS_ERR(f)) | |
190 | percpu_counter_inc(&nr_files); | |
1da177e4 | 191 | |
af4d2ecb KK |
192 | return f; |
193 | ||
194 | over: | |
1da177e4 | 195 | /* Ran out of filps - report that */ |
529bf6be | 196 | if (get_nr_files() > old_max) { |
518de9b3 | 197 | pr_info("VFS: file-max limit %lu reached\n", get_max_files()); |
529bf6be | 198 | old_max = get_nr_files(); |
1da177e4 | 199 | } |
1afc99be | 200 | return ERR_PTR(-ENFILE); |
1da177e4 LT |
201 | } |
202 | ||
d3b1084d MS |
203 | /* |
204 | * Variant of alloc_empty_file() that doesn't check and modify nr_files. | |
205 | * | |
206 | * Should not be used unless there's a very good reason to do so. | |
207 | */ | |
208 | struct file *alloc_empty_file_noaccount(int flags, const struct cred *cred) | |
209 | { | |
210 | struct file *f = __alloc_file(flags, cred); | |
211 | ||
212 | if (!IS_ERR(f)) | |
213 | f->f_mode |= FMODE_NOACCOUNT; | |
214 | ||
215 | return f; | |
216 | } | |
217 | ||
ce8d2cdf DH |
218 | /** |
219 | * alloc_file - allocate and initialize a 'struct file' | |
a457606a EB |
220 | * |
221 | * @path: the (dentry, vfsmount) pair for the new file | |
c9c554f2 | 222 | * @flags: O_... flags with which the new file will be opened |
ce8d2cdf | 223 | * @fop: the 'struct file_operations' for the new file |
ce8d2cdf | 224 | */ |
ee1904ba | 225 | static struct file *alloc_file(const struct path *path, int flags, |
2c48b9c4 | 226 | const struct file_operations *fop) |
ce8d2cdf DH |
227 | { |
228 | struct file *file; | |
ce8d2cdf | 229 | |
ea73ea72 | 230 | file = alloc_empty_file(flags, current_cred()); |
1afc99be | 231 | if (IS_ERR(file)) |
39b65252 | 232 | return file; |
ce8d2cdf | 233 | |
2c48b9c4 | 234 | file->f_path = *path; |
dd37978c | 235 | file->f_inode = path->dentry->d_inode; |
2c48b9c4 | 236 | file->f_mapping = path->dentry->d_inode->i_mapping; |
5660e13d | 237 | file->f_wb_err = filemap_sample_wb_err(file->f_mapping); |
735e4ae5 | 238 | file->f_sb_err = file_sample_sb_err(file); |
868941b1 | 239 | if (fop->llseek) |
e7478158 | 240 | file->f_mode |= FMODE_LSEEK; |
c9c554f2 | 241 | if ((file->f_mode & FMODE_READ) && |
84363182 | 242 | likely(fop->read || fop->read_iter)) |
c9c554f2 AV |
243 | file->f_mode |= FMODE_CAN_READ; |
244 | if ((file->f_mode & FMODE_WRITE) && | |
84363182 | 245 | likely(fop->write || fop->write_iter)) |
c9c554f2 | 246 | file->f_mode |= FMODE_CAN_WRITE; |
164f4064 | 247 | file->f_iocb_flags = iocb_flags(file); |
f5d11409 | 248 | file->f_mode |= FMODE_OPENED; |
ce8d2cdf | 249 | file->f_op = fop; |
c9c554f2 | 250 | if ((file->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_READ) |
890275b5 | 251 | i_readcount_inc(path->dentry->d_inode); |
3d1e4631 | 252 | return file; |
ce8d2cdf | 253 | } |
ce8d2cdf | 254 | |
d93aa9d8 AV |
255 | struct file *alloc_file_pseudo(struct inode *inode, struct vfsmount *mnt, |
256 | const char *name, int flags, | |
257 | const struct file_operations *fops) | |
258 | { | |
259 | static const struct dentry_operations anon_ops = { | |
260 | .d_dname = simple_dname | |
261 | }; | |
262 | struct qstr this = QSTR_INIT(name, strlen(name)); | |
263 | struct path path; | |
264 | struct file *file; | |
265 | ||
266 | path.dentry = d_alloc_pseudo(mnt->mnt_sb, &this); | |
267 | if (!path.dentry) | |
268 | return ERR_PTR(-ENOMEM); | |
269 | if (!mnt->mnt_sb->s_d_op) | |
270 | d_set_d_op(path.dentry, &anon_ops); | |
271 | path.mnt = mntget(mnt); | |
272 | d_instantiate(path.dentry, inode); | |
b6509f6a | 273 | file = alloc_file(&path, flags, fops); |
d93aa9d8 AV |
274 | if (IS_ERR(file)) { |
275 | ihold(inode); | |
276 | path_put(&path); | |
277 | } | |
278 | return file; | |
279 | } | |
280 | EXPORT_SYMBOL(alloc_file_pseudo); | |
281 | ||
183266f2 AV |
282 | struct file *alloc_file_clone(struct file *base, int flags, |
283 | const struct file_operations *fops) | |
284 | { | |
285 | struct file *f = alloc_file(&base->f_path, flags, fops); | |
286 | if (!IS_ERR(f)) { | |
287 | path_get(&f->f_path); | |
288 | f->f_mapping = base->f_mapping; | |
289 | } | |
290 | return f; | |
291 | } | |
292 | ||
d7065da0 | 293 | /* the real guts of fput() - releasing the last reference to file |
1da177e4 | 294 | */ |
d7065da0 | 295 | static void __fput(struct file *file) |
1da177e4 | 296 | { |
0f7fc9e4 JJS |
297 | struct dentry *dentry = file->f_path.dentry; |
298 | struct vfsmount *mnt = file->f_path.mnt; | |
c77cecee | 299 | struct inode *inode = file->f_inode; |
a07b2000 | 300 | fmode_t mode = file->f_mode; |
1da177e4 | 301 | |
4d27f326 AV |
302 | if (unlikely(!(file->f_mode & FMODE_OPENED))) |
303 | goto out; | |
304 | ||
1da177e4 | 305 | might_sleep(); |
0eeca283 RL |
306 | |
307 | fsnotify_close(file); | |
1da177e4 LT |
308 | /* |
309 | * The function eventpoll_release() should be the first called | |
310 | * in the file cleanup chain. | |
311 | */ | |
312 | eventpoll_release(file); | |
78ed8a13 | 313 | locks_remove_file(file); |
1da177e4 | 314 | |
bb02b186 | 315 | ima_file_free(file); |
233e70f4 | 316 | if (unlikely(file->f_flags & FASYNC)) { |
72c2d531 | 317 | if (file->f_op->fasync) |
233e70f4 AV |
318 | file->f_op->fasync(-1, file, 0); |
319 | } | |
72c2d531 | 320 | if (file->f_op->release) |
1da177e4 | 321 | file->f_op->release(inode, file); |
60ed8cf7 | 322 | if (unlikely(S_ISCHR(inode->i_mode) && inode->i_cdev != NULL && |
a07b2000 | 323 | !(mode & FMODE_PATH))) { |
1da177e4 | 324 | cdev_put(inode->i_cdev); |
60ed8cf7 | 325 | } |
1da177e4 | 326 | fops_put(file->f_op); |
609d7fa9 | 327 | put_pid(file->f_owner.pid); |
d6da19c9 | 328 | put_file_access(file); |
1da177e4 | 329 | dput(dentry); |
a07b2000 AV |
330 | if (unlikely(mode & FMODE_NEED_UNMOUNT)) |
331 | dissolve_on_fput(mnt); | |
1da177e4 | 332 | mntput(mnt); |
4d27f326 AV |
333 | out: |
334 | file_free(file); | |
1da177e4 LT |
335 | } |
336 | ||
4f5e65a1 | 337 | static LLIST_HEAD(delayed_fput_list); |
4a9d4b02 AV |
338 | static void delayed_fput(struct work_struct *unused) |
339 | { | |
4f5e65a1 | 340 | struct llist_node *node = llist_del_all(&delayed_fput_list); |
b9ea557e | 341 | struct file *f, *t; |
4f5e65a1 | 342 | |
e87f2c26 | 343 | llist_for_each_entry_safe(f, t, node, f_llist) |
b9ea557e | 344 | __fput(f); |
4a9d4b02 AV |
345 | } |
346 | ||
347 | static void ____fput(struct callback_head *work) | |
348 | { | |
e87f2c26 | 349 | __fput(container_of(work, struct file, f_rcuhead)); |
4a9d4b02 AV |
350 | } |
351 | ||
352 | /* | |
353 | * If kernel thread really needs to have the final fput() it has done | |
354 | * to complete, call this. The only user right now is the boot - we | |
355 | * *do* need to make sure our writes to binaries on initramfs has | |
356 | * not left us with opened struct file waiting for __fput() - execve() | |
357 | * won't work without that. Please, don't add more callers without | |
358 | * very good reasons; in particular, never call that with locks | |
359 | * held and never call that from a thread that might need to do | |
360 | * some work on any kind of umount. | |
361 | */ | |
362 | void flush_delayed_fput(void) | |
363 | { | |
364 | delayed_fput(NULL); | |
365 | } | |
7239a40c | 366 | EXPORT_SYMBOL_GPL(flush_delayed_fput); |
4a9d4b02 | 367 | |
c7314d74 | 368 | static DECLARE_DELAYED_WORK(delayed_fput_work, delayed_fput); |
4a9d4b02 | 369 | |
81132a39 | 370 | void fput(struct file *file) |
d7065da0 | 371 | { |
81132a39 | 372 | if (atomic_long_dec_and_test(&file->f_count)) { |
4a9d4b02 | 373 | struct task_struct *task = current; |
e7b2c406 | 374 | |
e7b2c406 | 375 | if (likely(!in_interrupt() && !(task->flags & PF_KTHREAD))) { |
e87f2c26 AV |
376 | init_task_work(&file->f_rcuhead, ____fput); |
377 | if (!task_work_add(task, &file->f_rcuhead, TWA_RESUME)) | |
e7b2c406 | 378 | return; |
64372501 AM |
379 | /* |
380 | * After this task has run exit_task_work(), | |
be49b30a | 381 | * task_work_add() will fail. Fall through to delayed |
64372501 AM |
382 | * fput to avoid leaking *file. |
383 | */ | |
4a9d4b02 | 384 | } |
4f5e65a1 | 385 | |
e87f2c26 | 386 | if (llist_add(&file->f_llist, &delayed_fput_list)) |
c7314d74 | 387 | schedule_delayed_work(&delayed_fput_work, 1); |
4a9d4b02 AV |
388 | } |
389 | } | |
390 | ||
391 | /* | |
392 | * synchronous analog of fput(); for kernel threads that might be needed | |
393 | * in some umount() (and thus can't use flush_delayed_fput() without | |
394 | * risking deadlocks), need to wait for completion of __fput() and know | |
395 | * for this specific struct file it won't involve anything that would | |
396 | * need them. Use only if you really need it - at the very least, | |
397 | * don't blindly convert fput() by kernel thread to that. | |
398 | */ | |
399 | void __fput_sync(struct file *file) | |
400 | { | |
401 | if (atomic_long_dec_and_test(&file->f_count)) { | |
402 | struct task_struct *task = current; | |
4a9d4b02 | 403 | BUG_ON(!(task->flags & PF_KTHREAD)); |
d7065da0 | 404 | __fput(file); |
4a9d4b02 | 405 | } |
d7065da0 AV |
406 | } |
407 | ||
408 | EXPORT_SYMBOL(fput); | |
f0043206 | 409 | EXPORT_SYMBOL(__fput_sync); |
d7065da0 | 410 | |
4248b0da | 411 | void __init files_init(void) |
b9ea557e | 412 | { |
b6b3fdea | 413 | filp_cachep = kmem_cache_create("filp", sizeof(struct file), 0, |
f3f7c093 | 414 | SLAB_HWCACHE_ALIGN | SLAB_PANIC | SLAB_ACCOUNT, NULL); |
4248b0da MG |
415 | percpu_counter_init(&nr_files, 0, GFP_KERNEL); |
416 | } | |
b6b3fdea | 417 | |
4248b0da MG |
418 | /* |
419 | * One file with associated inode and dcache is very roughly 1K. Per default | |
420 | * do not use more than 10% of our memory for files. | |
421 | */ | |
422 | void __init files_maxfiles_init(void) | |
423 | { | |
424 | unsigned long n; | |
ca79b0c2 | 425 | unsigned long nr_pages = totalram_pages(); |
3d6357de | 426 | unsigned long memreserve = (nr_pages - nr_free_pages()) * 3/2; |
4248b0da | 427 | |
3d6357de AK |
428 | memreserve = min(memreserve, nr_pages - 1); |
429 | n = ((nr_pages - memreserve) * (PAGE_SIZE / 1024)) / 10; | |
1da177e4 | 430 | |
518de9b3 | 431 | files_stat.max_files = max_t(unsigned long, n, NR_FILE); |
b9ea557e | 432 | } |