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