1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * The proc filesystem constants/structures
4 */
5 #ifndef _LINUX_PROC_FS_H
6 #define _LINUX_PROC_FS_H
7
8 #include <linux/compiler.h>
9 #include <linux/types.h>
10 #include <linux/fs.h>
11
12 struct proc_dir_entry;
13 struct seq_file;
14 struct seq_operations;
15
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 PROC_ENTRY_proc_read_iter = 1U << 1,
29 PROC_ENTRY_proc_compat_ioctl = 1U << 2,
30 };
31
32 struct proc_ops {
33 unsigned int proc_flags;
34 int (*proc_open)(struct inode *, struct file *);
35 ssize_t (*proc_read)(struct file *, char __user *, size_t, loff_t *);
36 ssize_t (*proc_read_iter)(struct kiocb *, struct iov_iter *);
37 ssize_t (*proc_write)(struct file *, const char __user *, size_t, loff_t *);
38 /* mandatory unless nonseekable_open() or equivalent is used */
39 loff_t (*proc_lseek)(struct file *, loff_t, int);
40 int (*proc_release)(struct inode *, struct file *);
41 __poll_t (*proc_poll)(struct file *, struct poll_table_struct *);
42 long (*proc_ioctl)(struct file *, unsigned int, unsigned long);
43 #ifdef CONFIG_COMPAT
44 long (*proc_compat_ioctl)(struct file *, unsigned int, unsigned long);
45 #endif
46 int (*proc_mmap)(struct file *, struct vm_area_struct *);
47 unsigned long (*proc_get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
48 } __randomize_layout;
49
50 /* definitions for hide_pid field */
51 enum proc_hidepid {
52 HIDEPID_OFF = 0,
53 HIDEPID_NO_ACCESS = 1,
54 HIDEPID_INVISIBLE = 2,
55 HIDEPID_NOT_PTRACEABLE = 4, /* Limit pids to only ptraceable pids */
56 };
57
58 /* definitions for proc mount option pidonly */
59 enum proc_pidonly {
60 PROC_PIDONLY_OFF = 0,
61 PROC_PIDONLY_ON = 1,
62 };
63
64 struct proc_fs_info {
65 struct pid_namespace *pid_ns;
66 struct dentry *proc_self; /* For /proc/self */
67 struct dentry *proc_thread_self; /* For /proc/thread-self */
68 kgid_t pid_gid;
69 enum proc_hidepid hide_pid;
70 enum proc_pidonly pidonly;
71 };
72
proc_sb_info(struct super_block * sb)73 static inline struct proc_fs_info *proc_sb_info(struct super_block *sb)
74 {
75 return sb->s_fs_info;
76 }
77
78 #ifdef CONFIG_PROC_FS
79
80 typedef int (*proc_write_t)(struct file *, char *, size_t);
81
82 extern void proc_root_init(void);
83 extern void proc_flush_pid(struct pid *);
84
85 extern struct proc_dir_entry *proc_symlink(const char *,
86 struct proc_dir_entry *, const char *);
87 struct proc_dir_entry *_proc_mkdir(const char *, umode_t, struct proc_dir_entry *, void *, bool);
88 extern struct proc_dir_entry *proc_mkdir(const char *, struct proc_dir_entry *);
89 extern struct proc_dir_entry *proc_mkdir_data(const char *, umode_t,
90 struct proc_dir_entry *, void *);
91 extern struct proc_dir_entry *proc_mkdir_mode(const char *, umode_t,
92 struct proc_dir_entry *);
93 struct proc_dir_entry *proc_create_mount_point(const char *name);
94
95 struct proc_dir_entry *proc_create_seq_private(const char *name, umode_t mode,
96 struct proc_dir_entry *parent, const struct seq_operations *ops,
97 unsigned int state_size, void *data);
98 #define proc_create_seq_data(name, mode, parent, ops, data) \
99 proc_create_seq_private(name, mode, parent, ops, 0, data)
100 #define proc_create_seq(name, mode, parent, ops) \
101 proc_create_seq_private(name, mode, parent, ops, 0, NULL)
102 struct proc_dir_entry *proc_create_single_data(const char *name, umode_t mode,
103 struct proc_dir_entry *parent,
104 int (*show)(struct seq_file *, void *), void *data);
105 #define proc_create_single(name, mode, parent, show) \
106 proc_create_single_data(name, mode, parent, show, NULL)
107
108 extern struct proc_dir_entry *proc_create_data(const char *, umode_t,
109 struct proc_dir_entry *,
110 const struct proc_ops *,
111 void *);
112
113 struct proc_dir_entry *proc_create(const char *name, umode_t mode, struct proc_dir_entry *parent, const struct proc_ops *proc_ops);
114 extern void proc_set_size(struct proc_dir_entry *, loff_t);
115 extern void proc_set_user(struct proc_dir_entry *, kuid_t, kgid_t);
116
117 /*
118 * Obtain the private data passed by user through proc_create_data() or
119 * related.
120 */
pde_data(const struct inode * inode)121 static inline void *pde_data(const struct inode *inode)
122 {
123 return inode->i_private;
124 }
125
126 extern void *proc_get_parent_data(const struct inode *);
127 extern void proc_remove(struct proc_dir_entry *);
128 extern void remove_proc_entry(const char *, struct proc_dir_entry *);
129 extern int remove_proc_subtree(const char *, struct proc_dir_entry *);
130
131 struct proc_dir_entry *proc_create_net_data(const char *name, umode_t mode,
132 struct proc_dir_entry *parent, const struct seq_operations *ops,
133 unsigned int state_size, void *data);
134 #define proc_create_net(name, mode, parent, ops, state_size) \
135 proc_create_net_data(name, mode, parent, ops, state_size, NULL)
136 struct proc_dir_entry *proc_create_net_single(const char *name, umode_t mode,
137 struct proc_dir_entry *parent,
138 int (*show)(struct seq_file *, void *), void *data);
139 struct proc_dir_entry *proc_create_net_data_write(const char *name, umode_t mode,
140 struct proc_dir_entry *parent,
141 const struct seq_operations *ops,
142 proc_write_t write,
143 unsigned int state_size, void *data);
144 struct proc_dir_entry *proc_create_net_single_write(const char *name, umode_t mode,
145 struct proc_dir_entry *parent,
146 int (*show)(struct seq_file *, void *),
147 proc_write_t write,
148 void *data);
149 extern struct pid *tgid_pidfd_to_pid(const struct file *file);
150
151 struct bpf_iter_aux_info;
152 extern int bpf_iter_init_seq_net(void *priv_data, struct bpf_iter_aux_info *aux);
153 extern void bpf_iter_fini_seq_net(void *priv_data);
154
155 #ifdef CONFIG_PROC_PID_ARCH_STATUS
156 /*
157 * The architecture which selects CONFIG_PROC_PID_ARCH_STATUS must
158 * provide proc_pid_arch_status() definition.
159 */
160 int proc_pid_arch_status(struct seq_file *m, struct pid_namespace *ns,
161 struct pid *pid, struct task_struct *task);
162 #endif /* CONFIG_PROC_PID_ARCH_STATUS */
163
164 void arch_report_meminfo(struct seq_file *m);
165 void arch_proc_pid_thread_features(struct seq_file *m, struct task_struct *task);
166
167 #else /* CONFIG_PROC_FS */
168
proc_root_init(void)169 static inline void proc_root_init(void)
170 {
171 }
172
proc_flush_pid(struct pid * pid)173 static inline void proc_flush_pid(struct pid *pid)
174 {
175 }
176
proc_symlink(const char * name,struct proc_dir_entry * parent,const char * dest)177 static inline struct proc_dir_entry *proc_symlink(const char *name,
178 struct proc_dir_entry *parent,const char *dest) { return NULL;}
proc_mkdir(const char * name,struct proc_dir_entry * parent)179 static inline struct proc_dir_entry *proc_mkdir(const char *name,
180 struct proc_dir_entry *parent) {return NULL;}
proc_create_mount_point(const char * name)181 static inline struct proc_dir_entry *proc_create_mount_point(const char *name) { return NULL; }
_proc_mkdir(const char * name,umode_t mode,struct proc_dir_entry * parent,void * data,bool force_lookup)182 static inline struct proc_dir_entry *_proc_mkdir(const char *name, umode_t mode,
183 struct proc_dir_entry *parent, void *data, bool force_lookup)
184 {
185 return NULL;
186 }
proc_mkdir_data(const char * name,umode_t mode,struct proc_dir_entry * parent,void * data)187 static inline struct proc_dir_entry *proc_mkdir_data(const char *name,
188 umode_t mode, struct proc_dir_entry *parent, void *data) { return NULL; }
proc_mkdir_mode(const char * name,umode_t mode,struct proc_dir_entry * parent)189 static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
190 umode_t mode, struct proc_dir_entry *parent) { return NULL; }
191 #define proc_create_seq_private(name, mode, parent, ops, size, data) ({NULL;})
192 #define proc_create_seq_data(name, mode, parent, ops, data) ({NULL;})
193 #define proc_create_seq(name, mode, parent, ops) ({NULL;})
194 #define proc_create_single(name, mode, parent, show) ({NULL;})
195 #define proc_create_single_data(name, mode, parent, show, data) ({NULL;})
196
197 static inline struct proc_dir_entry *
proc_create(const char * name,umode_t mode,struct proc_dir_entry * parent,const struct proc_ops * proc_ops)198 proc_create(const char *name, umode_t mode, struct proc_dir_entry *parent,
199 const struct proc_ops *proc_ops)
200 { return NULL; }
201
202 static inline struct proc_dir_entry *
proc_create_data(const char * name,umode_t mode,struct proc_dir_entry * parent,const struct proc_ops * proc_ops,void * data)203 proc_create_data(const char *name, umode_t mode, struct proc_dir_entry *parent,
204 const struct proc_ops *proc_ops, void *data)
205 { return NULL; }
206
proc_set_size(struct proc_dir_entry * de,loff_t size)207 static inline void proc_set_size(struct proc_dir_entry *de, loff_t size) {}
proc_set_user(struct proc_dir_entry * de,kuid_t uid,kgid_t gid)208 static inline void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) {}
pde_data(const struct inode * inode)209 static inline void *pde_data(const struct inode *inode) {BUG(); return NULL;}
proc_get_parent_data(const struct inode * inode)210 static inline void *proc_get_parent_data(const struct inode *inode) { BUG(); return NULL; }
211
proc_remove(struct proc_dir_entry * de)212 static inline void proc_remove(struct proc_dir_entry *de) {}
213 #define remove_proc_entry(name, parent) do {} while (0)
remove_proc_subtree(const char * name,struct proc_dir_entry * parent)214 static inline int remove_proc_subtree(const char *name, struct proc_dir_entry *parent) { return 0; }
215
216 #define proc_create_net_data(name, mode, parent, ops, state_size, data) ({NULL;})
217 #define proc_create_net_data_write(name, mode, parent, ops, write, state_size, data) ({NULL;})
218 #define proc_create_net(name, mode, parent, state_size, ops) ({NULL;})
219 #define proc_create_net_single(name, mode, parent, show, data) ({NULL;})
220 #define proc_create_net_single_write(name, mode, parent, show, write, data) ({NULL;})
221
tgid_pidfd_to_pid(const struct file * file)222 static inline struct pid *tgid_pidfd_to_pid(const struct file *file)
223 {
224 return ERR_PTR(-EBADF);
225 }
226
227 #endif /* CONFIG_PROC_FS */
228
229 struct net;
230
proc_net_mkdir(struct net * net,const char * name,struct proc_dir_entry * parent)231 static inline struct proc_dir_entry *proc_net_mkdir(
232 struct net *net, const char *name, struct proc_dir_entry *parent)
233 {
234 return _proc_mkdir(name, 0, parent, net, true);
235 }
236
237 struct ns_common;
238 int open_related_ns(struct ns_common *ns,
239 struct ns_common *(*get_ns)(struct ns_common *ns));
240
241 /* get the associated pid namespace for a file in procfs */
proc_pid_ns(struct super_block * sb)242 static inline struct pid_namespace *proc_pid_ns(struct super_block *sb)
243 {
244 return proc_sb_info(sb)->pid_ns;
245 }
246
247 bool proc_ns_file(const struct file *file);
248
249 #endif /* _LINUX_PROC_FS_H */
250