Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 LT |
2 | /* |
3 | * Wrapper functions for accessing the file_struct fd array. | |
4 | */ | |
5 | ||
6 | #ifndef __LINUX_FILE_H | |
7 | #define __LINUX_FILE_H | |
8 | ||
1da177e4 | 9 | #include <linux/compiler.h> |
0c9e63fd | 10 | #include <linux/types.h> |
9f3acc31 | 11 | #include <linux/posix_types.h> |
deefa7f3 | 12 | #include <linux/errno.h> |
54da6a09 | 13 | #include <linux/cleanup.h> |
1da177e4 | 14 | |
9f3acc31 | 15 | struct file; |
8b7d91eb | 16 | |
b3c97528 | 17 | extern void fput(struct file *); |
1da177e4 | 18 | |
ce8d2cdf | 19 | struct file_operations; |
5e876fb4 | 20 | struct task_struct; |
ce8d2cdf DH |
21 | struct vfsmount; |
22 | struct dentry; | |
d93aa9d8 | 23 | struct inode; |
2c48b9c4 | 24 | struct path; |
d93aa9d8 AV |
25 | extern struct file *alloc_file_pseudo(struct inode *, struct vfsmount *, |
26 | const char *, int flags, const struct file_operations *); | |
183266f2 AV |
27 | extern struct file *alloc_file_clone(struct file *, int flags, |
28 | const struct file_operations *); | |
ce8d2cdf | 29 | |
1da177e4 LT |
30 | static inline void fput_light(struct file *file, int fput_needed) |
31 | { | |
c2b3e74b | 32 | if (fput_needed) |
1da177e4 LT |
33 | fput(file); |
34 | } | |
35 | ||
a5b470ba AV |
36 | struct fd { |
37 | struct file *file; | |
9c225f26 | 38 | unsigned int flags; |
a5b470ba | 39 | }; |
9c225f26 LT |
40 | #define FDPUT_FPUT 1 |
41 | #define FDPUT_POS_UNLOCK 2 | |
a5b470ba AV |
42 | |
43 | static inline void fdput(struct fd fd) | |
44 | { | |
9c225f26 | 45 | if (fd.flags & FDPUT_FPUT) |
a5b470ba AV |
46 | fput(fd.file); |
47 | } | |
48 | ||
b3c97528 | 49 | extern struct file *fget(unsigned int fd); |
bd2a31d5 | 50 | extern struct file *fget_raw(unsigned int fd); |
5e876fb4 | 51 | extern struct file *fget_task(struct task_struct *task, unsigned int fd); |
bd2a31d5 AV |
52 | extern unsigned long __fdget(unsigned int fd); |
53 | extern unsigned long __fdget_raw(unsigned int fd); | |
54 | extern unsigned long __fdget_pos(unsigned int fd); | |
63b6df14 | 55 | extern void __f_unlock_pos(struct file *); |
a5b470ba | 56 | |
bd2a31d5 | 57 | static inline struct fd __to_fd(unsigned long v) |
a5b470ba | 58 | { |
bd2a31d5 | 59 | return (struct fd){(struct file *)(v & ~3),v & 3}; |
a5b470ba AV |
60 | } |
61 | ||
bd2a31d5 AV |
62 | static inline struct fd fdget(unsigned int fd) |
63 | { | |
64 | return __to_fd(__fdget(fd)); | |
65 | } | |
2903ff01 | 66 | |
a5b470ba AV |
67 | static inline struct fd fdget_raw(unsigned int fd) |
68 | { | |
bd2a31d5 | 69 | return __to_fd(__fdget_raw(fd)); |
a5b470ba AV |
70 | } |
71 | ||
63b6df14 AV |
72 | static inline struct fd fdget_pos(int fd) |
73 | { | |
74 | return __to_fd(__fdget_pos(fd)); | |
75 | } | |
76 | ||
77 | static inline void fdput_pos(struct fd f) | |
78 | { | |
79 | if (f.flags & FDPUT_POS_UNLOCK) | |
80 | __f_unlock_pos(f.file); | |
81 | fdput(f); | |
82 | } | |
83 | ||
54da6a09 PZ |
84 | DEFINE_CLASS(fd, struct fd, fdput(_T), fdget(fd), int fd) |
85 | ||
fe17f22d | 86 | extern int f_dupfd(unsigned int from, struct file *file, unsigned flags); |
8280d161 | 87 | extern int replace_fd(unsigned fd, struct file *file, unsigned flags); |
b3c97528 | 88 | extern void set_close_on_exec(unsigned int fd, int flag); |
fe17f22d | 89 | extern bool get_close_on_exec(unsigned int fd); |
4022e7af | 90 | extern int __get_unused_fd_flags(unsigned flags, unsigned long nofile); |
1a7bd226 | 91 | extern int get_unused_fd_flags(unsigned flags); |
b3c97528 | 92 | extern void put_unused_fd(unsigned int fd); |
1da177e4 | 93 | |
54da6a09 PZ |
94 | DEFINE_CLASS(get_unused_fd, int, if (_T >= 0) put_unused_fd(_T), |
95 | get_unused_fd_flags(flags), unsigned flags) | |
96 | ||
b3c97528 | 97 | extern void fd_install(unsigned int fd, struct file *file); |
1da177e4 | 98 | |
42eb0d54 | 99 | extern int __receive_fd(struct file *file, int __user *ufd, |
66590610 | 100 | unsigned int o_flags); |
9c930054 XY |
101 | |
102 | extern int receive_fd(struct file *file, unsigned int o_flags); | |
103 | ||
66590610 KC |
104 | static inline int receive_fd_user(struct file *file, int __user *ufd, |
105 | unsigned int o_flags) | |
106 | { | |
deefa7f3 KC |
107 | if (ufd == NULL) |
108 | return -EFAULT; | |
42eb0d54 | 109 | return __receive_fd(file, ufd, o_flags); |
66590610 | 110 | } |
42eb0d54 | 111 | int receive_fd_replace(int new_fd, struct file *file, unsigned int o_flags); |
66590610 | 112 | |
4a9d4b02 AV |
113 | extern void flush_delayed_fput(void); |
114 | extern void __fput_sync(struct file *); | |
115 | ||
2374c09b CH |
116 | extern unsigned int sysctl_nr_open_min, sysctl_nr_open_max; |
117 | ||
1da177e4 | 118 | #endif /* __LINUX_FILE_H */ |