xref: /linux-6.15/include/linux/proc_fs.h (revision 10ffebbe)
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 
11 struct proc_dir_entry;
12 struct seq_file;
13 struct seq_operations;
14 
15 #ifdef CONFIG_PROC_FS
16 
17 typedef int (*proc_write_t)(struct file *, char *, size_t);
18 
19 extern void proc_root_init(void);
20 extern void proc_flush_task(struct task_struct *);
21 
22 extern struct proc_dir_entry *proc_symlink(const char *,
23 		struct proc_dir_entry *, const char *);
24 extern struct proc_dir_entry *proc_mkdir(const char *, struct proc_dir_entry *);
25 extern struct proc_dir_entry *proc_mkdir_data(const char *, umode_t,
26 					      struct proc_dir_entry *, void *);
27 extern struct proc_dir_entry *proc_mkdir_mode(const char *, umode_t,
28 					      struct proc_dir_entry *);
29 struct proc_dir_entry *proc_create_mount_point(const char *name);
30 
31 struct 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)
38 struct 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 
44 extern struct proc_dir_entry *proc_create_data(const char *, umode_t,
45 					       struct proc_dir_entry *,
46 					       const struct file_operations *,
47 					       void *);
48 
49 struct proc_dir_entry *proc_create(const char *name, umode_t mode, struct proc_dir_entry *parent, const struct file_operations *proc_fops);
50 extern void proc_set_size(struct proc_dir_entry *, loff_t);
51 extern void proc_set_user(struct proc_dir_entry *, kuid_t, kgid_t);
52 extern void *PDE_DATA(const struct inode *);
53 extern void *proc_get_parent_data(const struct inode *);
54 extern void proc_remove(struct proc_dir_entry *);
55 extern void remove_proc_entry(const char *, struct proc_dir_entry *);
56 extern int remove_proc_subtree(const char *, struct proc_dir_entry *);
57 
58 struct 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)
63 struct 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);
66 struct 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);
71 struct 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);
76 extern struct pid *tgid_pidfd_to_pid(const struct file *file);
77 
78 #else /* CONFIG_PROC_FS */
79 
80 static inline void proc_root_init(void)
81 {
82 }
83 
84 static inline void proc_flush_task(struct task_struct *task)
85 {
86 }
87 
88 static inline struct proc_dir_entry *proc_symlink(const char *name,
89 		struct proc_dir_entry *parent,const char *dest) { return NULL;}
90 static inline struct proc_dir_entry *proc_mkdir(const char *name,
91 	struct proc_dir_entry *parent) {return NULL;}
92 static inline struct proc_dir_entry *proc_create_mount_point(const char *name) { return NULL; }
93 static inline struct proc_dir_entry *proc_mkdir_data(const char *name,
94 	umode_t mode, struct proc_dir_entry *parent, void *data) { return NULL; }
95 static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
96 	umode_t mode, struct proc_dir_entry *parent) { return NULL; }
97 #define proc_create_seq_private(name, mode, parent, ops, size, data) ({NULL;})
98 #define proc_create_seq_data(name, mode, parent, ops, data) ({NULL;})
99 #define proc_create_seq(name, mode, parent, ops) ({NULL;})
100 #define proc_create_single(name, mode, parent, show) ({NULL;})
101 #define proc_create_single_data(name, mode, parent, show, data) ({NULL;})
102 #define proc_create(name, mode, parent, proc_fops) ({NULL;})
103 #define proc_create_data(name, mode, parent, proc_fops, data) ({NULL;})
104 
105 static inline void proc_set_size(struct proc_dir_entry *de, loff_t size) {}
106 static inline void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) {}
107 static inline void *PDE_DATA(const struct inode *inode) {BUG(); return NULL;}
108 static inline void *proc_get_parent_data(const struct inode *inode) { BUG(); return NULL; }
109 
110 static inline void proc_remove(struct proc_dir_entry *de) {}
111 #define remove_proc_entry(name, parent) do {} while (0)
112 static inline int remove_proc_subtree(const char *name, struct proc_dir_entry *parent) { return 0; }
113 
114 #define proc_create_net_data(name, mode, parent, ops, state_size, data) ({NULL;})
115 #define proc_create_net(name, mode, parent, state_size, ops) ({NULL;})
116 #define proc_create_net_single(name, mode, parent, show, data) ({NULL;})
117 
118 static inline struct pid *tgid_pidfd_to_pid(const struct file *file)
119 {
120 	return ERR_PTR(-EBADF);
121 }
122 
123 #endif /* CONFIG_PROC_FS */
124 
125 struct net;
126 
127 static inline struct proc_dir_entry *proc_net_mkdir(
128 	struct net *net, const char *name, struct proc_dir_entry *parent)
129 {
130 	return proc_mkdir_data(name, 0, parent, net);
131 }
132 
133 struct ns_common;
134 int open_related_ns(struct ns_common *ns,
135 		   struct ns_common *(*get_ns)(struct ns_common *ns));
136 
137 /* get the associated pid namespace for a file in procfs */
138 static inline struct pid_namespace *proc_pid_ns(const struct inode *inode)
139 {
140 	return inode->i_sb->s_fs_info;
141 }
142 
143 #endif /* _LINUX_PROC_FS_H */
144