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 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 extern void *PDE_DATA(const struct inode *); 114 extern void *proc_get_parent_data(const struct inode *); 115 extern void proc_remove(struct proc_dir_entry *); 116 extern void remove_proc_entry(const char *, struct proc_dir_entry *); 117 extern int remove_proc_subtree(const char *, struct proc_dir_entry *); 118 119 struct proc_dir_entry *proc_create_net_data(const char *name, umode_t mode, 120 struct proc_dir_entry *parent, const struct seq_operations *ops, 121 unsigned int state_size, void *data); 122 #define proc_create_net(name, mode, parent, ops, state_size) \ 123 proc_create_net_data(name, mode, parent, ops, state_size, NULL) 124 struct proc_dir_entry *proc_create_net_single(const char *name, umode_t mode, 125 struct proc_dir_entry *parent, 126 int (*show)(struct seq_file *, void *), void *data); 127 struct proc_dir_entry *proc_create_net_data_write(const char *name, umode_t mode, 128 struct proc_dir_entry *parent, 129 const struct seq_operations *ops, 130 proc_write_t write, 131 unsigned int state_size, void *data); 132 struct proc_dir_entry *proc_create_net_single_write(const char *name, umode_t mode, 133 struct proc_dir_entry *parent, 134 int (*show)(struct seq_file *, void *), 135 proc_write_t write, 136 void *data); 137 extern struct pid *tgid_pidfd_to_pid(const struct file *file); 138 139 struct bpf_iter_aux_info; 140 extern int bpf_iter_init_seq_net(void *priv_data, struct bpf_iter_aux_info *aux); 141 extern void bpf_iter_fini_seq_net(void *priv_data); 142 143 #ifdef CONFIG_PROC_PID_ARCH_STATUS 144 /* 145 * The architecture which selects CONFIG_PROC_PID_ARCH_STATUS must 146 * provide proc_pid_arch_status() definition. 147 */ 148 int proc_pid_arch_status(struct seq_file *m, struct pid_namespace *ns, 149 struct pid *pid, struct task_struct *task); 150 #endif /* CONFIG_PROC_PID_ARCH_STATUS */ 151 152 #else /* CONFIG_PROC_FS */ 153 154 static inline void proc_root_init(void) 155 { 156 } 157 158 static inline void proc_flush_pid(struct pid *pid) 159 { 160 } 161 162 static inline struct proc_dir_entry *proc_symlink(const char *name, 163 struct proc_dir_entry *parent,const char *dest) { return NULL;} 164 static inline struct proc_dir_entry *proc_mkdir(const char *name, 165 struct proc_dir_entry *parent) {return NULL;} 166 static inline struct proc_dir_entry *proc_create_mount_point(const char *name) { return NULL; } 167 static inline struct proc_dir_entry *_proc_mkdir(const char *name, umode_t mode, 168 struct proc_dir_entry *parent, void *data, bool force_lookup) 169 { 170 return NULL; 171 } 172 static inline struct proc_dir_entry *proc_mkdir_data(const char *name, 173 umode_t mode, struct proc_dir_entry *parent, void *data) { return NULL; } 174 static inline struct proc_dir_entry *proc_mkdir_mode(const char *name, 175 umode_t mode, struct proc_dir_entry *parent) { return NULL; } 176 #define proc_create_seq_private(name, mode, parent, ops, size, data) ({NULL;}) 177 #define proc_create_seq_data(name, mode, parent, ops, data) ({NULL;}) 178 #define proc_create_seq(name, mode, parent, ops) ({NULL;}) 179 #define proc_create_single(name, mode, parent, show) ({NULL;}) 180 #define proc_create_single_data(name, mode, parent, show, data) ({NULL;}) 181 #define proc_create(name, mode, parent, proc_ops) ({NULL;}) 182 #define proc_create_data(name, mode, parent, proc_ops, data) ({NULL;}) 183 184 static inline void proc_set_size(struct proc_dir_entry *de, loff_t size) {} 185 static inline void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) {} 186 static inline void *PDE_DATA(const struct inode *inode) {BUG(); return NULL;} 187 static inline void *proc_get_parent_data(const struct inode *inode) { BUG(); return NULL; } 188 189 static inline void proc_remove(struct proc_dir_entry *de) {} 190 #define remove_proc_entry(name, parent) do {} while (0) 191 static inline int remove_proc_subtree(const char *name, struct proc_dir_entry *parent) { return 0; } 192 193 #define proc_create_net_data(name, mode, parent, ops, state_size, data) ({NULL;}) 194 #define proc_create_net(name, mode, parent, state_size, ops) ({NULL;}) 195 #define proc_create_net_single(name, mode, parent, show, data) ({NULL;}) 196 197 static inline struct pid *tgid_pidfd_to_pid(const struct file *file) 198 { 199 return ERR_PTR(-EBADF); 200 } 201 202 #endif /* CONFIG_PROC_FS */ 203 204 struct net; 205 206 static inline struct proc_dir_entry *proc_net_mkdir( 207 struct net *net, const char *name, struct proc_dir_entry *parent) 208 { 209 return _proc_mkdir(name, 0, parent, net, true); 210 } 211 212 struct ns_common; 213 int open_related_ns(struct ns_common *ns, 214 struct ns_common *(*get_ns)(struct ns_common *ns)); 215 216 /* get the associated pid namespace for a file in procfs */ 217 static inline struct pid_namespace *proc_pid_ns(struct super_block *sb) 218 { 219 return proc_sb_info(sb)->pid_ns; 220 } 221 222 bool proc_ns_file(const struct file *file); 223 224 #endif /* _LINUX_PROC_FS_H */ 225