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_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 */ 46 enum { 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 struct proc_fs_info { 54 struct pid_namespace *pid_ns; 55 struct dentry *proc_self; /* For /proc/self */ 56 struct dentry *proc_thread_self; /* For /proc/thread-self */ 57 kgid_t pid_gid; 58 int hide_pid; 59 }; 60 61 static inline struct proc_fs_info *proc_sb_info(struct super_block *sb) 62 { 63 return sb->s_fs_info; 64 } 65 66 #ifdef CONFIG_PROC_FS 67 68 typedef int (*proc_write_t)(struct file *, char *, size_t); 69 70 extern void proc_root_init(void); 71 extern void proc_flush_pid(struct pid *); 72 73 extern struct proc_dir_entry *proc_symlink(const char *, 74 struct proc_dir_entry *, const char *); 75 extern struct proc_dir_entry *proc_mkdir(const char *, struct proc_dir_entry *); 76 extern struct proc_dir_entry *proc_mkdir_data(const char *, umode_t, 77 struct proc_dir_entry *, void *); 78 extern struct proc_dir_entry *proc_mkdir_mode(const char *, umode_t, 79 struct proc_dir_entry *); 80 struct proc_dir_entry *proc_create_mount_point(const char *name); 81 82 struct proc_dir_entry *proc_create_seq_private(const char *name, umode_t mode, 83 struct proc_dir_entry *parent, const struct seq_operations *ops, 84 unsigned int state_size, void *data); 85 #define proc_create_seq_data(name, mode, parent, ops, data) \ 86 proc_create_seq_private(name, mode, parent, ops, 0, data) 87 #define proc_create_seq(name, mode, parent, ops) \ 88 proc_create_seq_private(name, mode, parent, ops, 0, NULL) 89 struct proc_dir_entry *proc_create_single_data(const char *name, umode_t mode, 90 struct proc_dir_entry *parent, 91 int (*show)(struct seq_file *, void *), void *data); 92 #define proc_create_single(name, mode, parent, show) \ 93 proc_create_single_data(name, mode, parent, show, NULL) 94 95 extern struct proc_dir_entry *proc_create_data(const char *, umode_t, 96 struct proc_dir_entry *, 97 const struct proc_ops *, 98 void *); 99 100 struct proc_dir_entry *proc_create(const char *name, umode_t mode, struct proc_dir_entry *parent, const struct proc_ops *proc_ops); 101 extern void proc_set_size(struct proc_dir_entry *, loff_t); 102 extern void proc_set_user(struct proc_dir_entry *, kuid_t, kgid_t); 103 extern void *PDE_DATA(const struct inode *); 104 extern void *proc_get_parent_data(const struct inode *); 105 extern void proc_remove(struct proc_dir_entry *); 106 extern void remove_proc_entry(const char *, struct proc_dir_entry *); 107 extern int remove_proc_subtree(const char *, struct proc_dir_entry *); 108 109 struct proc_dir_entry *proc_create_net_data(const char *name, umode_t mode, 110 struct proc_dir_entry *parent, const struct seq_operations *ops, 111 unsigned int state_size, void *data); 112 #define proc_create_net(name, mode, parent, ops, state_size) \ 113 proc_create_net_data(name, mode, parent, ops, state_size, NULL) 114 struct proc_dir_entry *proc_create_net_single(const char *name, umode_t mode, 115 struct proc_dir_entry *parent, 116 int (*show)(struct seq_file *, void *), void *data); 117 struct proc_dir_entry *proc_create_net_data_write(const char *name, umode_t mode, 118 struct proc_dir_entry *parent, 119 const struct seq_operations *ops, 120 proc_write_t write, 121 unsigned int state_size, void *data); 122 struct proc_dir_entry *proc_create_net_single_write(const char *name, umode_t mode, 123 struct proc_dir_entry *parent, 124 int (*show)(struct seq_file *, void *), 125 proc_write_t write, 126 void *data); 127 extern struct pid *tgid_pidfd_to_pid(const struct file *file); 128 129 #ifdef CONFIG_PROC_PID_ARCH_STATUS 130 /* 131 * The architecture which selects CONFIG_PROC_PID_ARCH_STATUS must 132 * provide proc_pid_arch_status() definition. 133 */ 134 int proc_pid_arch_status(struct seq_file *m, struct pid_namespace *ns, 135 struct pid *pid, struct task_struct *task); 136 #endif /* CONFIG_PROC_PID_ARCH_STATUS */ 137 138 #else /* CONFIG_PROC_FS */ 139 140 static inline void proc_root_init(void) 141 { 142 } 143 144 static inline void proc_flush_pid(struct pid *pid) 145 { 146 } 147 148 static inline struct proc_dir_entry *proc_symlink(const char *name, 149 struct proc_dir_entry *parent,const char *dest) { return NULL;} 150 static inline struct proc_dir_entry *proc_mkdir(const char *name, 151 struct proc_dir_entry *parent) {return NULL;} 152 static inline struct proc_dir_entry *proc_create_mount_point(const char *name) { return NULL; } 153 static inline struct proc_dir_entry *proc_mkdir_data(const char *name, 154 umode_t mode, struct proc_dir_entry *parent, void *data) { return NULL; } 155 static inline struct proc_dir_entry *proc_mkdir_mode(const char *name, 156 umode_t mode, struct proc_dir_entry *parent) { return NULL; } 157 #define proc_create_seq_private(name, mode, parent, ops, size, data) ({NULL;}) 158 #define proc_create_seq_data(name, mode, parent, ops, data) ({NULL;}) 159 #define proc_create_seq(name, mode, parent, ops) ({NULL;}) 160 #define proc_create_single(name, mode, parent, show) ({NULL;}) 161 #define proc_create_single_data(name, mode, parent, show, data) ({NULL;}) 162 #define proc_create(name, mode, parent, proc_ops) ({NULL;}) 163 #define proc_create_data(name, mode, parent, proc_ops, data) ({NULL;}) 164 165 static inline void proc_set_size(struct proc_dir_entry *de, loff_t size) {} 166 static inline void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) {} 167 static inline void *PDE_DATA(const struct inode *inode) {BUG(); return NULL;} 168 static inline void *proc_get_parent_data(const struct inode *inode) { BUG(); return NULL; } 169 170 static inline void proc_remove(struct proc_dir_entry *de) {} 171 #define remove_proc_entry(name, parent) do {} while (0) 172 static inline int remove_proc_subtree(const char *name, struct proc_dir_entry *parent) { return 0; } 173 174 #define proc_create_net_data(name, mode, parent, ops, state_size, data) ({NULL;}) 175 #define proc_create_net(name, mode, parent, state_size, ops) ({NULL;}) 176 #define proc_create_net_single(name, mode, parent, show, data) ({NULL;}) 177 178 static inline struct pid *tgid_pidfd_to_pid(const struct file *file) 179 { 180 return ERR_PTR(-EBADF); 181 } 182 183 #endif /* CONFIG_PROC_FS */ 184 185 struct net; 186 187 static inline struct proc_dir_entry *proc_net_mkdir( 188 struct net *net, const char *name, struct proc_dir_entry *parent) 189 { 190 return proc_mkdir_data(name, 0, parent, net); 191 } 192 193 struct ns_common; 194 int open_related_ns(struct ns_common *ns, 195 struct ns_common *(*get_ns)(struct ns_common *ns)); 196 197 /* get the associated pid namespace for a file in procfs */ 198 static inline struct pid_namespace *proc_pid_ns(const struct inode *inode) 199 { 200 return proc_sb_info(inode->i_sb)->pid_ns; 201 } 202 203 #endif /* _LINUX_PROC_FS_H */ 204