Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 LT |
2 | /* |
3 | * The proc filesystem constants/structures | |
4 | */ | |
59d8053f DH |
5 | #ifndef _LINUX_PROC_FS_H |
6 | #define _LINUX_PROC_FS_H | |
1da177e4 | 7 | |
d919b33d | 8 | #include <linux/compiler.h> |
59d8053f DH |
9 | #include <linux/types.h> |
10 | #include <linux/fs.h> | |
1da177e4 | 11 | |
59d8053f | 12 | struct proc_dir_entry; |
3f3942ac | 13 | struct seq_file; |
fddda2b7 | 14 | struct seq_operations; |
1da177e4 | 15 | |
d919b33d AD |
16 | enum { |
17 | /* | |
18 | * All /proc entries using this ->proc_ops instance are never removed. | |
19 | * | |
20 | * If in doubt, ignore this flag. | |
21 | */ | |
22 | #ifdef MODULE | |
23 | PROC_ENTRY_PERMANENT = 0U, | |
24 | #else | |
25 | PROC_ENTRY_PERMANENT = 1U << 0, | |
26 | #endif | |
27 | }; | |
28 | ||
d56c0d45 | 29 | struct proc_ops { |
d919b33d | 30 | unsigned int proc_flags; |
d56c0d45 AD |
31 | int (*proc_open)(struct inode *, struct file *); |
32 | ssize_t (*proc_read)(struct file *, char __user *, size_t, loff_t *); | |
33 | ssize_t (*proc_write)(struct file *, const char __user *, size_t, loff_t *); | |
34 | loff_t (*proc_lseek)(struct file *, loff_t, int); | |
35 | int (*proc_release)(struct inode *, struct file *); | |
36 | __poll_t (*proc_poll)(struct file *, struct poll_table_struct *); | |
37 | long (*proc_ioctl)(struct file *, unsigned int, unsigned long); | |
38 | #ifdef CONFIG_COMPAT | |
39 | long (*proc_compat_ioctl)(struct file *, unsigned int, unsigned long); | |
40 | #endif | |
41 | int (*proc_mmap)(struct file *, struct vm_area_struct *); | |
42 | unsigned long (*proc_get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long); | |
d919b33d | 43 | } __randomize_layout; |
d56c0d45 | 44 | |
fa10fed3 AG |
45 | /* definitions for hide_pid field */ |
46 | enum { | |
47 | HIDEPID_OFF = 0, | |
48 | HIDEPID_NO_ACCESS = 1, | |
49 | HIDEPID_INVISIBLE = 2, | |
24a71ce5 | 50 | HIDEPID_NOT_PTRACEABLE = 4, /* Limit pids to only ptraceable pids */ |
fa10fed3 AG |
51 | }; |
52 | ||
6814ef2d AG |
53 | /* definitions for proc mount option pidonly */ |
54 | enum { | |
55 | PROC_PIDONLY_OFF = 0, | |
56 | PROC_PIDONLY_ON = 1, | |
57 | }; | |
58 | ||
fa10fed3 AG |
59 | struct proc_fs_info { |
60 | struct pid_namespace *pid_ns; | |
61 | struct dentry *proc_self; /* For /proc/self */ | |
62 | struct dentry *proc_thread_self; /* For /proc/thread-self */ | |
63 | kgid_t pid_gid; | |
64 | int hide_pid; | |
6814ef2d | 65 | int pidonly; |
fa10fed3 AG |
66 | }; |
67 | ||
68 | static inline struct proc_fs_info *proc_sb_info(struct super_block *sb) | |
69 | { | |
70 | return sb->s_fs_info; | |
71 | } | |
72 | ||
1da177e4 LT |
73 | #ifdef CONFIG_PROC_FS |
74 | ||
564def71 DH |
75 | typedef int (*proc_write_t)(struct file *, char *, size_t); |
76 | ||
1da177e4 | 77 | extern void proc_root_init(void); |
7bc3e6e5 | 78 | extern void proc_flush_pid(struct pid *); |
1da177e4 | 79 | |
1da177e4 LT |
80 | extern struct proc_dir_entry *proc_symlink(const char *, |
81 | struct proc_dir_entry *, const char *); | |
59d8053f | 82 | extern struct proc_dir_entry *proc_mkdir(const char *, struct proc_dir_entry *); |
270b5ac2 DH |
83 | extern struct proc_dir_entry *proc_mkdir_data(const char *, umode_t, |
84 | struct proc_dir_entry *, void *); | |
59d8053f DH |
85 | extern struct proc_dir_entry *proc_mkdir_mode(const char *, umode_t, |
86 | struct proc_dir_entry *); | |
f97df70b | 87 | struct proc_dir_entry *proc_create_mount_point(const char *name); |
fddda2b7 | 88 | |
44414d82 | 89 | struct proc_dir_entry *proc_create_seq_private(const char *name, umode_t mode, |
fddda2b7 | 90 | struct proc_dir_entry *parent, const struct seq_operations *ops, |
44414d82 CH |
91 | unsigned int state_size, void *data); |
92 | #define proc_create_seq_data(name, mode, parent, ops, data) \ | |
93 | proc_create_seq_private(name, mode, parent, ops, 0, data) | |
fddda2b7 | 94 | #define proc_create_seq(name, mode, parent, ops) \ |
44414d82 | 95 | proc_create_seq_private(name, mode, parent, ops, 0, NULL) |
3f3942ac CH |
96 | struct proc_dir_entry *proc_create_single_data(const char *name, umode_t mode, |
97 | struct proc_dir_entry *parent, | |
98 | int (*show)(struct seq_file *, void *), void *data); | |
99 | #define proc_create_single(name, mode, parent, show) \ | |
100 | proc_create_single_data(name, mode, parent, show, NULL) | |
59d8053f DH |
101 | |
102 | extern struct proc_dir_entry *proc_create_data(const char *, umode_t, | |
103 | struct proc_dir_entry *, | |
d56c0d45 | 104 | const struct proc_ops *, |
59d8053f DH |
105 | void *); |
106 | ||
d56c0d45 | 107 | struct proc_dir_entry *proc_create(const char *name, umode_t mode, struct proc_dir_entry *parent, const struct proc_ops *proc_ops); |
271a15ea DH |
108 | extern void proc_set_size(struct proc_dir_entry *, loff_t); |
109 | extern void proc_set_user(struct proc_dir_entry *, kuid_t, kgid_t); | |
c30480b9 | 110 | extern void *PDE_DATA(const struct inode *); |
4a520d27 | 111 | extern void *proc_get_parent_data(const struct inode *); |
59d8053f DH |
112 | extern void proc_remove(struct proc_dir_entry *); |
113 | extern void remove_proc_entry(const char *, struct proc_dir_entry *); | |
114 | extern int remove_proc_subtree(const char *, struct proc_dir_entry *); | |
115 | ||
c3506372 CH |
116 | struct proc_dir_entry *proc_create_net_data(const char *name, umode_t mode, |
117 | struct proc_dir_entry *parent, const struct seq_operations *ops, | |
118 | unsigned int state_size, void *data); | |
9573e8f7 ML |
119 | #define proc_create_net(name, mode, parent, ops, state_size) \ |
120 | proc_create_net_data(name, mode, parent, ops, state_size, NULL) | |
3617d949 CH |
121 | struct proc_dir_entry *proc_create_net_single(const char *name, umode_t mode, |
122 | struct proc_dir_entry *parent, | |
123 | int (*show)(struct seq_file *, void *), void *data); | |
564def71 DH |
124 | struct proc_dir_entry *proc_create_net_data_write(const char *name, umode_t mode, |
125 | struct proc_dir_entry *parent, | |
126 | const struct seq_operations *ops, | |
127 | proc_write_t write, | |
128 | unsigned int state_size, void *data); | |
129 | struct proc_dir_entry *proc_create_net_single_write(const char *name, umode_t mode, | |
130 | struct proc_dir_entry *parent, | |
131 | int (*show)(struct seq_file *, void *), | |
132 | proc_write_t write, | |
133 | void *data); | |
3eb39f47 | 134 | extern struct pid *tgid_pidfd_to_pid(const struct file *file); |
c3506372 | 135 | |
68bc30bb AL |
136 | #ifdef CONFIG_PROC_PID_ARCH_STATUS |
137 | /* | |
138 | * The architecture which selects CONFIG_PROC_PID_ARCH_STATUS must | |
139 | * provide proc_pid_arch_status() definition. | |
140 | */ | |
141 | int proc_pid_arch_status(struct seq_file *m, struct pid_namespace *ns, | |
142 | struct pid *pid, struct task_struct *task); | |
143 | #endif /* CONFIG_PROC_PID_ARCH_STATUS */ | |
144 | ||
59d8053f | 145 | #else /* CONFIG_PROC_FS */ |
1da177e4 | 146 | |
647f010b AM |
147 | static inline void proc_root_init(void) |
148 | { | |
149 | } | |
150 | ||
7bc3e6e5 | 151 | static inline void proc_flush_pid(struct pid *pid) |
60347f67 PE |
152 | { |
153 | } | |
1da177e4 | 154 | |
1da177e4 | 155 | static inline struct proc_dir_entry *proc_symlink(const char *name, |
59d8053f | 156 | struct proc_dir_entry *parent,const char *dest) { return NULL;} |
1da177e4 LT |
157 | static inline struct proc_dir_entry *proc_mkdir(const char *name, |
158 | struct proc_dir_entry *parent) {return NULL;} | |
f97df70b | 159 | static inline struct proc_dir_entry *proc_create_mount_point(const char *name) { return NULL; } |
270b5ac2 DH |
160 | static inline struct proc_dir_entry *proc_mkdir_data(const char *name, |
161 | umode_t mode, struct proc_dir_entry *parent, void *data) { return NULL; } | |
f12a20fc | 162 | static inline struct proc_dir_entry *proc_mkdir_mode(const char *name, |
d161a13f | 163 | umode_t mode, struct proc_dir_entry *parent) { return NULL; } |
3f3942ac | 164 | #define proc_create_seq_private(name, mode, parent, ops, size, data) ({NULL;}) |
fddda2b7 CH |
165 | #define proc_create_seq_data(name, mode, parent, ops, data) ({NULL;}) |
166 | #define proc_create_seq(name, mode, parent, ops) ({NULL;}) | |
3f3942ac CH |
167 | #define proc_create_single(name, mode, parent, show) ({NULL;}) |
168 | #define proc_create_single_data(name, mode, parent, show, data) ({NULL;}) | |
d56c0d45 AD |
169 | #define proc_create(name, mode, parent, proc_ops) ({NULL;}) |
170 | #define proc_create_data(name, mode, parent, proc_ops, data) ({NULL;}) | |
59d8053f | 171 | |
271a15ea DH |
172 | static inline void proc_set_size(struct proc_dir_entry *de, loff_t size) {} |
173 | static inline void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) {} | |
c30480b9 | 174 | static inline void *PDE_DATA(const struct inode *inode) {BUG(); return NULL;} |
59d8053f | 175 | static inline void *proc_get_parent_data(const struct inode *inode) { BUG(); return NULL; } |
1da177e4 | 176 | |
59d8053f DH |
177 | static inline void proc_remove(struct proc_dir_entry *de) {} |
178 | #define remove_proc_entry(name, parent) do {} while (0) | |
179 | static inline int remove_proc_subtree(const char *name, struct proc_dir_entry *parent) { return 0; } | |
9043476f | 180 | |
c3506372 CH |
181 | #define proc_create_net_data(name, mode, parent, ops, state_size, data) ({NULL;}) |
182 | #define proc_create_net(name, mode, parent, state_size, ops) ({NULL;}) | |
3617d949 | 183 | #define proc_create_net_single(name, mode, parent, show, data) ({NULL;}) |
c3506372 | 184 | |
3eb39f47 CB |
185 | static inline struct pid *tgid_pidfd_to_pid(const struct file *file) |
186 | { | |
187 | return ERR_PTR(-EBADF); | |
188 | } | |
189 | ||
59d8053f | 190 | #endif /* CONFIG_PROC_FS */ |
1da177e4 | 191 | |
f7790029 JL |
192 | struct net; |
193 | ||
270b5ac2 DH |
194 | static inline struct proc_dir_entry *proc_net_mkdir( |
195 | struct net *net, const char *name, struct proc_dir_entry *parent) | |
196 | { | |
197 | return proc_mkdir_data(name, 0, parent, net); | |
198 | } | |
199 | ||
c62cce2c AV |
200 | struct ns_common; |
201 | int open_related_ns(struct ns_common *ns, | |
202 | struct ns_common *(*get_ns)(struct ns_common *ns)); | |
203 | ||
76f668be | 204 | /* get the associated pid namespace for a file in procfs */ |
891ae71d | 205 | static inline struct pid_namespace *proc_pid_ns(const struct inode *inode) |
76f668be | 206 | { |
fa10fed3 | 207 | return proc_sb_info(inode->i_sb)->pid_ns; |
76f668be CH |
208 | } |
209 | ||
1da177e4 | 210 | #endif /* _LINUX_PROC_FS_H */ |