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
12struct proc_dir_entry;
13struct seq_file;
14struct seq_operations;
15
16enum {
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
29struct 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 */
48enum 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 */
56enum proc_pidonly {
57 PROC_PIDONLY_OFF = 0,
58 PROC_PIDONLY_ON = 1,
59};
60
61struct 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
70static 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
77typedef int (*proc_write_t)(struct file *, char *, size_t);
78
79extern void proc_root_init(void);
80extern void proc_flush_pid(struct pid *);
81
82extern struct proc_dir_entry *proc_symlink(const char *,
83 struct proc_dir_entry *, const char *);
84struct proc_dir_entry *_proc_mkdir(const char *, umode_t, struct proc_dir_entry *, void *, bool);
85extern struct proc_dir_entry *proc_mkdir(const char *, struct proc_dir_entry *);
86extern struct proc_dir_entry *proc_mkdir_data(const char *, umode_t,
87 struct proc_dir_entry *, void *);
88extern struct proc_dir_entry *proc_mkdir_mode(const char *, umode_t,
89 struct proc_dir_entry *);
90struct proc_dir_entry *proc_create_mount_point(const char *name);
91
92struct 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)
99struct 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
105extern struct proc_dir_entry *proc_create_data(const char *, umode_t,
106 struct proc_dir_entry *,
107 const struct proc_ops *,
108 void *);
109
110struct proc_dir_entry *proc_create(const char *name, umode_t mode, struct proc_dir_entry *parent, const struct proc_ops *proc_ops);
111extern void proc_set_size(struct proc_dir_entry *, loff_t);
112extern 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 */
118static inline void *pde_data(const struct inode *inode)
119{
120 return inode->i_private;
121}
122
123extern void *proc_get_parent_data(const struct inode *);
124extern void proc_remove(struct proc_dir_entry *);
125extern void remove_proc_entry(const char *, struct proc_dir_entry *);
126extern int remove_proc_subtree(const char *, struct proc_dir_entry *);
127
128struct 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)
133struct 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);
136struct 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);
141struct 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);
146extern struct pid *tgid_pidfd_to_pid(const struct file *file);
147
148struct bpf_iter_aux_info;
149extern int bpf_iter_init_seq_net(void *priv_data, struct bpf_iter_aux_info *aux);
150extern 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 */
157int 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#else /* CONFIG_PROC_FS */
162
163static inline void proc_root_init(void)
164{
165}
166
167static inline void proc_flush_pid(struct pid *pid)
168{
169}
170
171static inline struct proc_dir_entry *proc_symlink(const char *name,
172 struct proc_dir_entry *parent,const char *dest) { return NULL;}
173static inline struct proc_dir_entry *proc_mkdir(const char *name,
174 struct proc_dir_entry *parent) {return NULL;}
175static inline struct proc_dir_entry *proc_create_mount_point(const char *name) { return NULL; }
176static inline struct proc_dir_entry *_proc_mkdir(const char *name, umode_t mode,
177 struct proc_dir_entry *parent, void *data, bool force_lookup)
178{
179 return NULL;
180}
181static inline struct proc_dir_entry *proc_mkdir_data(const char *name,
182 umode_t mode, struct proc_dir_entry *parent, void *data) { return NULL; }
183static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
184 umode_t mode, struct proc_dir_entry *parent) { return NULL; }
185#define proc_create_seq_private(name, mode, parent, ops, size, data) ({NULL;})
186#define proc_create_seq_data(name, mode, parent, ops, data) ({NULL;})
187#define proc_create_seq(name, mode, parent, ops) ({NULL;})
188#define proc_create_single(name, mode, parent, show) ({NULL;})
189#define proc_create_single_data(name, mode, parent, show, data) ({NULL;})
190
191static inline struct proc_dir_entry *
192proc_create(const char *name, umode_t mode, struct proc_dir_entry *parent,
193 const struct proc_ops *proc_ops)
194{ return NULL; }
195
196static inline struct proc_dir_entry *
197proc_create_data(const char *name, umode_t mode, struct proc_dir_entry *parent,
198 const struct proc_ops *proc_ops, void *data)
199{ return NULL; }
200
201static inline void proc_set_size(struct proc_dir_entry *de, loff_t size) {}
202static inline void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) {}
203static inline void *pde_data(const struct inode *inode) {BUG(); return NULL;}
204static inline void *proc_get_parent_data(const struct inode *inode) { BUG(); return NULL; }
205
206static inline void proc_remove(struct proc_dir_entry *de) {}
207#define remove_proc_entry(name, parent) do {} while (0)
208static inline int remove_proc_subtree(const char *name, struct proc_dir_entry *parent) { return 0; }
209
210#define proc_create_net_data(name, mode, parent, ops, state_size, data) ({NULL;})
211#define proc_create_net(name, mode, parent, state_size, ops) ({NULL;})
212#define proc_create_net_single(name, mode, parent, show, data) ({NULL;})
213
214static inline struct pid *tgid_pidfd_to_pid(const struct file *file)
215{
216 return ERR_PTR(-EBADF);
217}
218
219#endif /* CONFIG_PROC_FS */
220
221struct net;
222
223static inline struct proc_dir_entry *proc_net_mkdir(
224 struct net *net, const char *name, struct proc_dir_entry *parent)
225{
226 return _proc_mkdir(name, 0, parent, net, true);
227}
228
229struct ns_common;
230int open_related_ns(struct ns_common *ns,
231 struct ns_common *(*get_ns)(struct ns_common *ns));
232
233/* get the associated pid namespace for a file in procfs */
234static inline struct pid_namespace *proc_pid_ns(struct super_block *sb)
235{
236 return proc_sb_info(sb)->pid_ns;
237}
238
239bool proc_ns_file(const struct file *file);
240
241#endif /* _LINUX_PROC_FS_H */
242

source code of linux/include/linux/proc_fs.h