Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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_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);
43} __randomize_layout;
44
45/* definitions for hide_pid field */
46enum proc_hidepid {
47 HIDEPID_OFF = 0,
48 HIDEPID_NO_ACCESS = 1,
49 HIDEPID_INVISIBLE = 2,
50 HIDEPID_NOT_PTRACEABLE = 4, /* Limit pids to only ptraceable pids */
51};
52
53/* definitions for proc mount option pidonly */
54enum proc_pidonly {
55 PROC_PIDONLY_OFF = 0,
56 PROC_PIDONLY_ON = 1,
57};
58
59struct 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 enum proc_hidepid hide_pid;
65 enum proc_pidonly pidonly;
66};
67
68static inline struct proc_fs_info *proc_sb_info(struct super_block *sb)
69{
70 return sb->s_fs_info;
71}
72
73#ifdef CONFIG_PROC_FS
74
75typedef int (*proc_write_t)(struct file *, char *, size_t);
76
77extern void proc_root_init(void);
78extern void proc_flush_pid(struct pid *);
79
80extern struct proc_dir_entry *proc_symlink(const char *,
81 struct proc_dir_entry *, const char *);
82extern struct proc_dir_entry *proc_mkdir(const char *, struct proc_dir_entry *);
83extern struct proc_dir_entry *proc_mkdir_data(const char *, umode_t,
84 struct proc_dir_entry *, void *);
85extern struct proc_dir_entry *proc_mkdir_mode(const char *, umode_t,
86 struct proc_dir_entry *);
87struct proc_dir_entry *proc_create_mount_point(const char *name);
88
89struct proc_dir_entry *proc_create_seq_private(const char *name, umode_t mode,
90 struct proc_dir_entry *parent, const struct seq_operations *ops,
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)
94#define proc_create_seq(name, mode, parent, ops) \
95 proc_create_seq_private(name, mode, parent, ops, 0, NULL)
96struct 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)
101
102extern struct proc_dir_entry *proc_create_data(const char *, umode_t,
103 struct proc_dir_entry *,
104 const struct proc_ops *,
105 void *);
106
107struct proc_dir_entry *proc_create(const char *name, umode_t mode, struct proc_dir_entry *parent, const struct proc_ops *proc_ops);
108extern void proc_set_size(struct proc_dir_entry *, loff_t);
109extern void proc_set_user(struct proc_dir_entry *, kuid_t, kgid_t);
110extern void *PDE_DATA(const struct inode *);
111extern void *proc_get_parent_data(const struct inode *);
112extern void proc_remove(struct proc_dir_entry *);
113extern void remove_proc_entry(const char *, struct proc_dir_entry *);
114extern int remove_proc_subtree(const char *, struct proc_dir_entry *);
115
116struct 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);
119#define proc_create_net(name, mode, parent, ops, state_size) \
120 proc_create_net_data(name, mode, parent, ops, state_size, NULL)
121struct 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);
124struct 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);
129struct 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);
134extern struct pid *tgid_pidfd_to_pid(const struct file *file);
135
136extern int bpf_iter_init_seq_net(void *priv_data);
137extern void bpf_iter_fini_seq_net(void *priv_data);
138
139#ifdef CONFIG_PROC_PID_ARCH_STATUS
140/*
141 * The architecture which selects CONFIG_PROC_PID_ARCH_STATUS must
142 * provide proc_pid_arch_status() definition.
143 */
144int proc_pid_arch_status(struct seq_file *m, struct pid_namespace *ns,
145 struct pid *pid, struct task_struct *task);
146#endif /* CONFIG_PROC_PID_ARCH_STATUS */
147
148#else /* CONFIG_PROC_FS */
149
150static inline void proc_root_init(void)
151{
152}
153
154static inline void proc_flush_pid(struct pid *pid)
155{
156}
157
158static inline struct proc_dir_entry *proc_symlink(const char *name,
159 struct proc_dir_entry *parent,const char *dest) { return NULL;}
160static inline struct proc_dir_entry *proc_mkdir(const char *name,
161 struct proc_dir_entry *parent) {return NULL;}
162static inline struct proc_dir_entry *proc_create_mount_point(const char *name) { return NULL; }
163static inline struct proc_dir_entry *proc_mkdir_data(const char *name,
164 umode_t mode, struct proc_dir_entry *parent, void *data) { return NULL; }
165static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
166 umode_t mode, struct proc_dir_entry *parent) { return NULL; }
167#define proc_create_seq_private(name, mode, parent, ops, size, data) ({NULL;})
168#define proc_create_seq_data(name, mode, parent, ops, data) ({NULL;})
169#define proc_create_seq(name, mode, parent, ops) ({NULL;})
170#define proc_create_single(name, mode, parent, show) ({NULL;})
171#define proc_create_single_data(name, mode, parent, show, data) ({NULL;})
172#define proc_create(name, mode, parent, proc_ops) ({NULL;})
173#define proc_create_data(name, mode, parent, proc_ops, data) ({NULL;})
174
175static inline void proc_set_size(struct proc_dir_entry *de, loff_t size) {}
176static inline void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) {}
177static inline void *PDE_DATA(const struct inode *inode) {BUG(); return NULL;}
178static inline void *proc_get_parent_data(const struct inode *inode) { BUG(); return NULL; }
179
180static inline void proc_remove(struct proc_dir_entry *de) {}
181#define remove_proc_entry(name, parent) do {} while (0)
182static inline int remove_proc_subtree(const char *name, struct proc_dir_entry *parent) { return 0; }
183
184#define proc_create_net_data(name, mode, parent, ops, state_size, data) ({NULL;})
185#define proc_create_net(name, mode, parent, state_size, ops) ({NULL;})
186#define proc_create_net_single(name, mode, parent, show, data) ({NULL;})
187
188static inline struct pid *tgid_pidfd_to_pid(const struct file *file)
189{
190 return ERR_PTR(-EBADF);
191}
192
193#endif /* CONFIG_PROC_FS */
194
195struct net;
196
197static inline struct proc_dir_entry *proc_net_mkdir(
198 struct net *net, const char *name, struct proc_dir_entry *parent)
199{
200 return proc_mkdir_data(name, 0, parent, net);
201}
202
203struct ns_common;
204int open_related_ns(struct ns_common *ns,
205 struct ns_common *(*get_ns)(struct ns_common *ns));
206
207/* get the associated pid namespace for a file in procfs */
208static inline struct pid_namespace *proc_pid_ns(struct super_block *sb)
209{
210 return proc_sb_info(sb)->pid_ns;
211}
212
213bool proc_ns_file(const struct file *file);
214
215#endif /* _LINUX_PROC_FS_H */