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/types.h>
9#include <linux/fs.h>
10
11struct proc_dir_entry;
12struct seq_file;
13struct seq_operations;
14
15#ifdef CONFIG_PROC_FS
16
17typedef int (*proc_write_t)(struct file *, char *, size_t);
18
19extern void proc_root_init(void);
20extern void proc_flush_task(struct task_struct *);
21
22extern struct proc_dir_entry *proc_symlink(const char *,
23 struct proc_dir_entry *, const char *);
24extern struct proc_dir_entry *proc_mkdir(const char *, struct proc_dir_entry *);
25extern struct proc_dir_entry *proc_mkdir_data(const char *, umode_t,
26 struct proc_dir_entry *, void *);
27extern struct proc_dir_entry *proc_mkdir_mode(const char *, umode_t,
28 struct proc_dir_entry *);
29struct proc_dir_entry *proc_create_mount_point(const char *name);
30
31struct proc_dir_entry *proc_create_seq_private(const char *name, umode_t mode,
32 struct proc_dir_entry *parent, const struct seq_operations *ops,
33 unsigned int state_size, void *data);
34#define proc_create_seq_data(name, mode, parent, ops, data) \
35 proc_create_seq_private(name, mode, parent, ops, 0, data)
36#define proc_create_seq(name, mode, parent, ops) \
37 proc_create_seq_private(name, mode, parent, ops, 0, NULL)
38struct proc_dir_entry *proc_create_single_data(const char *name, umode_t mode,
39 struct proc_dir_entry *parent,
40 int (*show)(struct seq_file *, void *), void *data);
41#define proc_create_single(name, mode, parent, show) \
42 proc_create_single_data(name, mode, parent, show, NULL)
43
44extern struct proc_dir_entry *proc_create_data(const char *, umode_t,
45 struct proc_dir_entry *,
46 const struct file_operations *,
47 void *);
48
49struct proc_dir_entry *proc_create(const char *name, umode_t mode, struct proc_dir_entry *parent, const struct file_operations *proc_fops);
50extern void proc_set_size(struct proc_dir_entry *, loff_t);
51extern void proc_set_user(struct proc_dir_entry *, kuid_t, kgid_t);
52extern void *PDE_DATA(const struct inode *);
53extern void *proc_get_parent_data(const struct inode *);
54extern void proc_remove(struct proc_dir_entry *);
55extern void remove_proc_entry(const char *, struct proc_dir_entry *);
56extern int remove_proc_subtree(const char *, struct proc_dir_entry *);
57
58struct proc_dir_entry *proc_create_net_data(const char *name, umode_t mode,
59 struct proc_dir_entry *parent, const struct seq_operations *ops,
60 unsigned int state_size, void *data);
61#define proc_create_net(name, mode, parent, state_size, ops) \
62 proc_create_net_data(name, mode, parent, state_size, ops, NULL)
63struct proc_dir_entry *proc_create_net_single(const char *name, umode_t mode,
64 struct proc_dir_entry *parent,
65 int (*show)(struct seq_file *, void *), void *data);
66struct proc_dir_entry *proc_create_net_data_write(const char *name, umode_t mode,
67 struct proc_dir_entry *parent,
68 const struct seq_operations *ops,
69 proc_write_t write,
70 unsigned int state_size, void *data);
71struct proc_dir_entry *proc_create_net_single_write(const char *name, umode_t mode,
72 struct proc_dir_entry *parent,
73 int (*show)(struct seq_file *, void *),
74 proc_write_t write,
75 void *data);
76extern struct pid *tgid_pidfd_to_pid(const struct file *file);
77
78#ifdef CONFIG_PROC_PID_ARCH_STATUS
79/*
80 * The architecture which selects CONFIG_PROC_PID_ARCH_STATUS must
81 * provide proc_pid_arch_status() definition.
82 */
83int proc_pid_arch_status(struct seq_file *m, struct pid_namespace *ns,
84 struct pid *pid, struct task_struct *task);
85#endif /* CONFIG_PROC_PID_ARCH_STATUS */
86
87#else /* CONFIG_PROC_FS */
88
89static inline void proc_root_init(void)
90{
91}
92
93static inline void proc_flush_task(struct task_struct *task)
94{
95}
96
97static inline struct proc_dir_entry *proc_symlink(const char *name,
98 struct proc_dir_entry *parent,const char *dest) { return NULL;}
99static inline struct proc_dir_entry *proc_mkdir(const char *name,
100 struct proc_dir_entry *parent) {return NULL;}
101static inline struct proc_dir_entry *proc_create_mount_point(const char *name) { return NULL; }
102static inline struct proc_dir_entry *proc_mkdir_data(const char *name,
103 umode_t mode, struct proc_dir_entry *parent, void *data) { return NULL; }
104static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
105 umode_t mode, struct proc_dir_entry *parent) { return NULL; }
106#define proc_create_seq_private(name, mode, parent, ops, size, data) ({NULL;})
107#define proc_create_seq_data(name, mode, parent, ops, data) ({NULL;})
108#define proc_create_seq(name, mode, parent, ops) ({NULL;})
109#define proc_create_single(name, mode, parent, show) ({NULL;})
110#define proc_create_single_data(name, mode, parent, show, data) ({NULL;})
111#define proc_create(name, mode, parent, proc_fops) ({NULL;})
112#define proc_create_data(name, mode, parent, proc_fops, data) ({NULL;})
113
114static inline void proc_set_size(struct proc_dir_entry *de, loff_t size) {}
115static inline void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) {}
116static inline void *PDE_DATA(const struct inode *inode) {BUG(); return NULL;}
117static inline void *proc_get_parent_data(const struct inode *inode) { BUG(); return NULL; }
118
119static inline void proc_remove(struct proc_dir_entry *de) {}
120#define remove_proc_entry(name, parent) do {} while (0)
121static inline int remove_proc_subtree(const char *name, struct proc_dir_entry *parent) { return 0; }
122
123#define proc_create_net_data(name, mode, parent, ops, state_size, data) ({NULL;})
124#define proc_create_net(name, mode, parent, state_size, ops) ({NULL;})
125#define proc_create_net_single(name, mode, parent, show, data) ({NULL;})
126
127static inline struct pid *tgid_pidfd_to_pid(const struct file *file)
128{
129 return ERR_PTR(-EBADF);
130}
131
132#endif /* CONFIG_PROC_FS */
133
134struct net;
135
136static inline struct proc_dir_entry *proc_net_mkdir(
137 struct net *net, const char *name, struct proc_dir_entry *parent)
138{
139 return proc_mkdir_data(name, 0, parent, net);
140}
141
142struct ns_common;
143int open_related_ns(struct ns_common *ns,
144 struct ns_common *(*get_ns)(struct ns_common *ns));
145
146/* get the associated pid namespace for a file in procfs */
147static inline struct pid_namespace *proc_pid_ns(const struct inode *inode)
148{
149 return inode->i_sb->s_fs_info;
150}
151
152#endif /* _LINUX_PROC_FS_H */