diff options
Diffstat (limited to 'include/linux/proc_fs.h')
| -rw-r--r-- | include/linux/proc_fs.h | 323 |
1 files changed, 43 insertions, 280 deletions
diff --git a/include/linux/proc_fs.h b/include/linux/proc_fs.h index 8307f2f94d86..608e60a74c3c 100644 --- a/include/linux/proc_fs.h +++ b/include/linux/proc_fs.h | |||
| @@ -1,316 +1,79 @@ | |||
| 1 | #ifndef _LINUX_PROC_FS_H | ||
| 2 | #define _LINUX_PROC_FS_H | ||
| 3 | |||
| 4 | #include <linux/slab.h> | ||
| 5 | #include <linux/fs.h> | ||
| 6 | #include <linux/spinlock.h> | ||
| 7 | #include <linux/magic.h> | ||
| 8 | #include <linux/atomic.h> | ||
| 9 | |||
| 10 | struct net; | ||
| 11 | struct completion; | ||
| 12 | struct mm_struct; | ||
| 13 | |||
| 14 | /* | 1 | /* |
| 15 | * The proc filesystem constants/structures | 2 | * The proc filesystem constants/structures |
| 16 | */ | 3 | */ |
| 4 | #ifndef _LINUX_PROC_FS_H | ||
| 5 | #define _LINUX_PROC_FS_H | ||
| 17 | 6 | ||
| 18 | /* | 7 | #include <linux/types.h> |
| 19 | * Offset of the first process in the /proc root directory.. | 8 | #include <linux/fs.h> |
| 20 | */ | ||
| 21 | #define FIRST_PROCESS_ENTRY 256 | ||
| 22 | |||
| 23 | /* Worst case buffer size needed for holding an integer. */ | ||
| 24 | #define PROC_NUMBUF 13 | ||
| 25 | |||
| 26 | /* | ||
| 27 | * We always define these enumerators | ||
| 28 | */ | ||
| 29 | |||
| 30 | enum { | ||
| 31 | PROC_ROOT_INO = 1, | ||
| 32 | PROC_IPC_INIT_INO = 0xEFFFFFFFU, | ||
| 33 | PROC_UTS_INIT_INO = 0xEFFFFFFEU, | ||
| 34 | PROC_USER_INIT_INO = 0xEFFFFFFDU, | ||
| 35 | PROC_PID_INIT_INO = 0xEFFFFFFCU, | ||
| 36 | }; | ||
| 37 | |||
| 38 | /* | ||
| 39 | * This is not completely implemented yet. The idea is to | ||
| 40 | * create an in-memory tree (like the actual /proc filesystem | ||
| 41 | * tree) of these proc_dir_entries, so that we can dynamically | ||
| 42 | * add new files to /proc. | ||
| 43 | * | ||
| 44 | * The "next" pointer creates a linked list of one /proc directory, | ||
| 45 | * while parent/subdir create the directory structure (every | ||
| 46 | * /proc file has a parent, but "subdir" is NULL for all | ||
| 47 | * non-directory entries). | ||
| 48 | */ | ||
| 49 | |||
| 50 | typedef int (read_proc_t)(char *page, char **start, off_t off, | ||
| 51 | int count, int *eof, void *data); | ||
| 52 | typedef int (write_proc_t)(struct file *file, const char __user *buffer, | ||
| 53 | unsigned long count, void *data); | ||
| 54 | |||
| 55 | struct proc_dir_entry { | ||
| 56 | unsigned int low_ino; | ||
| 57 | umode_t mode; | ||
| 58 | nlink_t nlink; | ||
| 59 | kuid_t uid; | ||
| 60 | kgid_t gid; | ||
| 61 | loff_t size; | ||
| 62 | const struct inode_operations *proc_iops; | ||
| 63 | /* | ||
| 64 | * NULL ->proc_fops means "PDE is going away RSN" or | ||
| 65 | * "PDE is just created". In either case, e.g. ->read_proc won't be | ||
| 66 | * called because it's too late or too early, respectively. | ||
| 67 | * | ||
| 68 | * If you're allocating ->proc_fops dynamically, save a pointer | ||
| 69 | * somewhere. | ||
| 70 | */ | ||
| 71 | const struct file_operations *proc_fops; | ||
| 72 | struct proc_dir_entry *next, *parent, *subdir; | ||
| 73 | void *data; | ||
| 74 | read_proc_t *read_proc; | ||
| 75 | write_proc_t *write_proc; | ||
| 76 | atomic_t count; /* use count */ | ||
| 77 | int pde_users; /* number of callers into module in progress */ | ||
| 78 | struct completion *pde_unload_completion; | ||
| 79 | struct list_head pde_openers; /* who did ->open, but not ->release */ | ||
| 80 | spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */ | ||
| 81 | u8 namelen; | ||
| 82 | char name[]; | ||
| 83 | }; | ||
| 84 | |||
| 85 | enum kcore_type { | ||
| 86 | KCORE_TEXT, | ||
| 87 | KCORE_VMALLOC, | ||
| 88 | KCORE_RAM, | ||
| 89 | KCORE_VMEMMAP, | ||
| 90 | KCORE_OTHER, | ||
| 91 | }; | ||
| 92 | |||
| 93 | struct kcore_list { | ||
| 94 | struct list_head list; | ||
| 95 | unsigned long addr; | ||
| 96 | size_t size; | ||
| 97 | int type; | ||
| 98 | }; | ||
| 99 | 9 | ||
| 100 | struct vmcore { | 10 | struct proc_dir_entry; |
| 101 | struct list_head list; | ||
| 102 | unsigned long long paddr; | ||
| 103 | unsigned long long size; | ||
| 104 | loff_t offset; | ||
| 105 | }; | ||
| 106 | 11 | ||
| 107 | #ifdef CONFIG_PROC_FS | 12 | #ifdef CONFIG_PROC_FS |
| 108 | 13 | ||
| 109 | extern void proc_root_init(void); | 14 | extern void proc_root_init(void); |
| 110 | 15 | extern void proc_flush_task(struct task_struct *); | |
| 111 | void proc_flush_task(struct task_struct *task); | ||
| 112 | |||
| 113 | extern struct proc_dir_entry *create_proc_entry(const char *name, umode_t mode, | ||
| 114 | struct proc_dir_entry *parent); | ||
| 115 | struct proc_dir_entry *proc_create_data(const char *name, umode_t mode, | ||
| 116 | struct proc_dir_entry *parent, | ||
| 117 | const struct file_operations *proc_fops, | ||
| 118 | void *data); | ||
| 119 | extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent); | ||
| 120 | |||
| 121 | struct pid_namespace; | ||
| 122 | |||
| 123 | extern int pid_ns_prepare_proc(struct pid_namespace *ns); | ||
| 124 | extern void pid_ns_release_proc(struct pid_namespace *ns); | ||
| 125 | |||
| 126 | /* | ||
| 127 | * proc_tty.c | ||
| 128 | */ | ||
| 129 | struct tty_driver; | ||
| 130 | #ifdef CONFIG_TTY | ||
| 131 | extern void proc_tty_init(void); | ||
| 132 | #else | ||
| 133 | static inline void proc_tty_init(void) | ||
| 134 | { } | ||
| 135 | #endif | ||
| 136 | extern void proc_tty_register_driver(struct tty_driver *driver); | ||
| 137 | extern void proc_tty_unregister_driver(struct tty_driver *driver); | ||
| 138 | |||
| 139 | /* | ||
| 140 | * proc_devtree.c | ||
| 141 | */ | ||
| 142 | #ifdef CONFIG_PROC_DEVICETREE | ||
| 143 | struct device_node; | ||
| 144 | struct property; | ||
| 145 | extern void proc_device_tree_init(void); | ||
| 146 | extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *); | ||
| 147 | extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop); | ||
| 148 | extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde, | ||
| 149 | struct property *prop); | ||
| 150 | extern void proc_device_tree_update_prop(struct proc_dir_entry *pde, | ||
| 151 | struct property *newprop, | ||
| 152 | struct property *oldprop); | ||
| 153 | #endif /* CONFIG_PROC_DEVICETREE */ | ||
| 154 | 16 | ||
| 155 | extern struct proc_dir_entry *proc_symlink(const char *, | 17 | extern struct proc_dir_entry *proc_symlink(const char *, |
| 156 | struct proc_dir_entry *, const char *); | 18 | struct proc_dir_entry *, const char *); |
| 157 | extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *); | 19 | extern struct proc_dir_entry *proc_mkdir(const char *, struct proc_dir_entry *); |
| 158 | extern struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode, | 20 | extern struct proc_dir_entry *proc_mkdir_data(const char *, umode_t, |
| 159 | struct proc_dir_entry *parent); | 21 | struct proc_dir_entry *, void *); |
| 160 | 22 | extern struct proc_dir_entry *proc_mkdir_mode(const char *, umode_t, | |
| 161 | static inline struct proc_dir_entry *proc_create(const char *name, umode_t mode, | 23 | struct proc_dir_entry *); |
| 162 | struct proc_dir_entry *parent, const struct file_operations *proc_fops) | 24 | |
| 25 | extern struct proc_dir_entry *proc_create_data(const char *, umode_t, | ||
| 26 | struct proc_dir_entry *, | ||
| 27 | const struct file_operations *, | ||
| 28 | void *); | ||
| 29 | |||
| 30 | static inline struct proc_dir_entry *proc_create( | ||
| 31 | const char *name, umode_t mode, struct proc_dir_entry *parent, | ||
| 32 | const struct file_operations *proc_fops) | ||
| 163 | { | 33 | { |
| 164 | return proc_create_data(name, mode, parent, proc_fops, NULL); | 34 | return proc_create_data(name, mode, parent, proc_fops, NULL); |
| 165 | } | 35 | } |
| 166 | 36 | ||
| 167 | static inline struct proc_dir_entry *create_proc_read_entry(const char *name, | 37 | extern void proc_set_size(struct proc_dir_entry *, loff_t); |
| 168 | umode_t mode, struct proc_dir_entry *base, | 38 | extern void proc_set_user(struct proc_dir_entry *, kuid_t, kgid_t); |
| 169 | read_proc_t *read_proc, void * data) | 39 | extern void *PDE_DATA(const struct inode *); |
| 170 | { | 40 | extern void *proc_get_parent_data(const struct inode *); |
| 171 | struct proc_dir_entry *res=create_proc_entry(name,mode,base); | 41 | extern void proc_remove(struct proc_dir_entry *); |
| 172 | if (res) { | 42 | extern void remove_proc_entry(const char *, struct proc_dir_entry *); |
| 173 | res->read_proc=read_proc; | 43 | extern int remove_proc_subtree(const char *, struct proc_dir_entry *); |
| 174 | res->data=data; | ||
| 175 | } | ||
| 176 | return res; | ||
| 177 | } | ||
| 178 | |||
| 179 | extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name, | ||
| 180 | struct proc_dir_entry *parent); | ||
| 181 | |||
| 182 | extern struct file *proc_ns_fget(int fd); | ||
| 183 | extern bool proc_ns_inode(struct inode *inode); | ||
| 184 | 44 | ||
| 185 | extern int proc_alloc_inum(unsigned int *pino); | 45 | #else /* CONFIG_PROC_FS */ |
| 186 | extern void proc_free_inum(unsigned int inum); | ||
| 187 | #else | ||
| 188 | 46 | ||
| 189 | static inline void proc_flush_task(struct task_struct *task) | 47 | static inline void proc_flush_task(struct task_struct *task) |
| 190 | { | 48 | { |
| 191 | } | 49 | } |
| 192 | 50 | ||
| 193 | static inline struct proc_dir_entry *create_proc_entry(const char *name, | ||
| 194 | umode_t mode, struct proc_dir_entry *parent) { return NULL; } | ||
| 195 | |||
| 196 | #define proc_create(name, mode, parent, fops) ({ (void)(mode), NULL; }) | ||
| 197 | |||
| 198 | static inline struct proc_dir_entry *proc_create_data(const char *name, | ||
| 199 | umode_t mode, struct proc_dir_entry *parent, | ||
| 200 | const struct file_operations *proc_fops, void *data) | ||
| 201 | { | ||
| 202 | return NULL; | ||
| 203 | } | ||
| 204 | #define remove_proc_entry(name, parent) do {} while (0) | ||
| 205 | |||
| 206 | static inline struct proc_dir_entry *proc_symlink(const char *name, | 51 | static inline struct proc_dir_entry *proc_symlink(const char *name, |
| 207 | struct proc_dir_entry *parent,const char *dest) {return NULL;} | 52 | struct proc_dir_entry *parent,const char *dest) { return NULL;} |
| 208 | static inline struct proc_dir_entry *proc_mkdir(const char *name, | 53 | static inline struct proc_dir_entry *proc_mkdir(const char *name, |
| 209 | struct proc_dir_entry *parent) {return NULL;} | 54 | struct proc_dir_entry *parent) {return NULL;} |
| 55 | static inline struct proc_dir_entry *proc_mkdir_data(const char *name, | ||
| 56 | umode_t mode, struct proc_dir_entry *parent, void *data) { return NULL; } | ||
| 210 | static inline struct proc_dir_entry *proc_mkdir_mode(const char *name, | 57 | static inline struct proc_dir_entry *proc_mkdir_mode(const char *name, |
| 211 | umode_t mode, struct proc_dir_entry *parent) { return NULL; } | 58 | umode_t mode, struct proc_dir_entry *parent) { return NULL; } |
| 59 | #define proc_create(name, mode, parent, proc_fops) ({NULL;}) | ||
| 60 | #define proc_create_data(name, mode, parent, proc_fops, data) ({NULL;}) | ||
| 212 | 61 | ||
| 213 | static inline struct proc_dir_entry *create_proc_read_entry(const char *name, | 62 | static inline void proc_set_size(struct proc_dir_entry *de, loff_t size) {} |
| 214 | umode_t mode, struct proc_dir_entry *base, | 63 | static inline void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) {} |
| 215 | read_proc_t *read_proc, void * data) { return NULL; } | 64 | static inline void *PDE_DATA(const struct inode *inode) {BUG(); return NULL;} |
| 216 | 65 | static inline void *proc_get_parent_data(const struct inode *inode) { BUG(); return NULL; } | |
| 217 | struct tty_driver; | ||
| 218 | static inline void proc_tty_register_driver(struct tty_driver *driver) {}; | ||
| 219 | static inline void proc_tty_unregister_driver(struct tty_driver *driver) {}; | ||
| 220 | 66 | ||
| 221 | static inline int pid_ns_prepare_proc(struct pid_namespace *ns) | 67 | static inline void proc_remove(struct proc_dir_entry *de) {} |
| 222 | { | 68 | #define remove_proc_entry(name, parent) do {} while (0) |
| 223 | return 0; | 69 | static inline int remove_proc_subtree(const char *name, struct proc_dir_entry *parent) { return 0; } |
| 224 | } | ||
| 225 | |||
| 226 | static inline void pid_ns_release_proc(struct pid_namespace *ns) | ||
| 227 | { | ||
| 228 | } | ||
| 229 | |||
| 230 | static inline struct file *proc_ns_fget(int fd) | ||
| 231 | { | ||
| 232 | return ERR_PTR(-EINVAL); | ||
| 233 | } | ||
| 234 | |||
| 235 | static inline bool proc_ns_inode(struct inode *inode) | ||
| 236 | { | ||
| 237 | return false; | ||
| 238 | } | ||
| 239 | 70 | ||
| 240 | static inline int proc_alloc_inum(unsigned int *inum) | ||
| 241 | { | ||
| 242 | *inum = 1; | ||
| 243 | return 0; | ||
| 244 | } | ||
| 245 | static inline void proc_free_inum(unsigned int inum) | ||
| 246 | { | ||
| 247 | } | ||
| 248 | #endif /* CONFIG_PROC_FS */ | 71 | #endif /* CONFIG_PROC_FS */ |
| 249 | 72 | ||
| 250 | #if !defined(CONFIG_PROC_KCORE) | 73 | static inline struct proc_dir_entry *proc_net_mkdir( |
| 251 | static inline void | 74 | struct net *net, const char *name, struct proc_dir_entry *parent) |
| 252 | kclist_add(struct kcore_list *new, void *addr, size_t size, int type) | ||
| 253 | { | 75 | { |
| 76 | return proc_mkdir_data(name, 0, parent, net); | ||
| 254 | } | 77 | } |
| 255 | #else | ||
| 256 | extern void kclist_add(struct kcore_list *, void *, size_t, int type); | ||
| 257 | #endif | ||
| 258 | |||
| 259 | struct nsproxy; | ||
| 260 | struct proc_ns_operations { | ||
| 261 | const char *name; | ||
| 262 | int type; | ||
| 263 | void *(*get)(struct task_struct *task); | ||
| 264 | void (*put)(void *ns); | ||
| 265 | int (*install)(struct nsproxy *nsproxy, void *ns); | ||
| 266 | unsigned int (*inum)(void *ns); | ||
| 267 | }; | ||
| 268 | extern const struct proc_ns_operations netns_operations; | ||
| 269 | extern const struct proc_ns_operations utsns_operations; | ||
| 270 | extern const struct proc_ns_operations ipcns_operations; | ||
| 271 | extern const struct proc_ns_operations pidns_operations; | ||
| 272 | extern const struct proc_ns_operations userns_operations; | ||
| 273 | extern const struct proc_ns_operations mntns_operations; | ||
| 274 | |||
| 275 | union proc_op { | ||
| 276 | int (*proc_get_link)(struct dentry *, struct path *); | ||
| 277 | int (*proc_read)(struct task_struct *task, char *page); | ||
| 278 | int (*proc_show)(struct seq_file *m, | ||
| 279 | struct pid_namespace *ns, struct pid *pid, | ||
| 280 | struct task_struct *task); | ||
| 281 | }; | ||
| 282 | |||
| 283 | struct ctl_table_header; | ||
| 284 | struct ctl_table; | ||
| 285 | |||
| 286 | struct proc_inode { | ||
| 287 | struct pid *pid; | ||
| 288 | int fd; | ||
| 289 | union proc_op op; | ||
| 290 | struct proc_dir_entry *pde; | ||
| 291 | struct ctl_table_header *sysctl; | ||
| 292 | struct ctl_table *sysctl_entry; | ||
| 293 | void *ns; | ||
| 294 | const struct proc_ns_operations *ns_ops; | ||
| 295 | struct inode vfs_inode; | ||
| 296 | }; | ||
| 297 | |||
| 298 | static inline struct proc_inode *PROC_I(const struct inode *inode) | ||
| 299 | { | ||
| 300 | return container_of(inode, struct proc_inode, vfs_inode); | ||
| 301 | } | ||
| 302 | |||
| 303 | static inline struct proc_dir_entry *PDE(const struct inode *inode) | ||
| 304 | { | ||
| 305 | return PROC_I(inode)->pde; | ||
| 306 | } | ||
| 307 | |||
| 308 | static inline struct net *PDE_NET(struct proc_dir_entry *pde) | ||
| 309 | { | ||
| 310 | return pde->parent->data; | ||
| 311 | } | ||
| 312 | |||
| 313 | #include <linux/signal.h> | ||
| 314 | 78 | ||
| 315 | void render_sigset_t(struct seq_file *m, const char *header, sigset_t *set); | ||
| 316 | #endif /* _LINUX_PROC_FS_H */ | 79 | #endif /* _LINUX_PROC_FS_H */ |
