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