Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | #ifndef _LINUX_PROC_FS_H |
| 2 | #define _LINUX_PROC_FS_H |
| 3 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 4 | #include <linux/slab.h> |
| 5 | #include <linux/fs.h> |
Steven Rostedt | 64a07bd | 2006-03-26 01:36:55 -0800 | [diff] [blame] | 6 | #include <linux/spinlock.h> |
Jeff Garzik | e18fa70 | 2006-09-24 11:13:19 -0400 | [diff] [blame] | 7 | #include <linux/magic.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 8 | #include <asm/atomic.h> |
| 9 | |
Eric W. Biederman | 457c4cb | 2007-09-12 12:01:34 +0200 | [diff] [blame] | 10 | struct net; |
Alexey Dobriyan | 786d7e1 | 2007-07-15 23:39:00 -0700 | [diff] [blame] | 11 | struct completion; |
| 12 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 13 | /* |
| 14 | * The proc filesystem constants/structures |
| 15 | */ |
| 16 | |
| 17 | /* |
| 18 | * Offset of the first process in the /proc root directory.. |
| 19 | */ |
| 20 | #define FIRST_PROCESS_ENTRY 256 |
| 21 | |
Matt Mackall | f248dcb | 2008-02-04 22:29:03 -0800 | [diff] [blame] | 22 | /* Worst case buffer size needed for holding an integer. */ |
| 23 | #define PROC_NUMBUF 13 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 24 | |
| 25 | /* |
| 26 | * We always define these enumerators |
| 27 | */ |
| 28 | |
| 29 | enum { |
| 30 | PROC_ROOT_INO = 1, |
| 31 | }; |
| 32 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 33 | /* |
| 34 | * This is not completely implemented yet. The idea is to |
| 35 | * create an in-memory tree (like the actual /proc filesystem |
| 36 | * tree) of these proc_dir_entries, so that we can dynamically |
| 37 | * add new files to /proc. |
| 38 | * |
| 39 | * The "next" pointer creates a linked list of one /proc directory, |
| 40 | * while parent/subdir create the directory structure (every |
| 41 | * /proc file has a parent, but "subdir" is NULL for all |
| 42 | * non-directory entries). |
| 43 | * |
| 44 | * "get_info" is called at "read", while "owner" is used to protect module |
| 45 | * from unloading while proc_dir_entry is in use |
| 46 | */ |
| 47 | |
| 48 | typedef int (read_proc_t)(char *page, char **start, off_t off, |
| 49 | int count, int *eof, void *data); |
| 50 | typedef int (write_proc_t)(struct file *file, const char __user *buffer, |
| 51 | unsigned long count, void *data); |
| 52 | typedef int (get_info_t)(char *, char **, off_t, int); |
| 53 | |
| 54 | struct proc_dir_entry { |
| 55 | unsigned int low_ino; |
| 56 | unsigned short namelen; |
| 57 | const char *name; |
| 58 | mode_t mode; |
| 59 | nlink_t nlink; |
| 60 | uid_t uid; |
| 61 | gid_t gid; |
Maneesh Soni | 22e6c1b | 2006-03-26 01:37:29 -0800 | [diff] [blame] | 62 | loff_t size; |
Arjan van de Ven | c5ef1c4 | 2007-02-12 00:55:40 -0800 | [diff] [blame] | 63 | const struct inode_operations *proc_iops; |
Alexey Dobriyan | 786d7e1 | 2007-07-15 23:39:00 -0700 | [diff] [blame] | 64 | /* |
| 65 | * NULL ->proc_fops means "PDE is going away RSN" or |
| 66 | * "PDE is just created". In either case, e.g. ->read_proc won't be |
| 67 | * called because it's too late or too early, respectively. |
| 68 | * |
| 69 | * If you're allocating ->proc_fops dynamically, save a pointer |
| 70 | * somewhere. |
| 71 | */ |
Arjan van de Ven | c5ef1c4 | 2007-02-12 00:55:40 -0800 | [diff] [blame] | 72 | const struct file_operations *proc_fops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 73 | get_info_t *get_info; |
| 74 | struct module *owner; |
| 75 | struct proc_dir_entry *next, *parent, *subdir; |
| 76 | void *data; |
| 77 | read_proc_t *read_proc; |
| 78 | write_proc_t *write_proc; |
| 79 | atomic_t count; /* use count */ |
Alexey Dobriyan | 786d7e1 | 2007-07-15 23:39:00 -0700 | [diff] [blame] | 80 | int pde_users; /* number of callers into module in progress */ |
| 81 | spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */ |
| 82 | struct completion *pde_unload_completion; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 83 | }; |
| 84 | |
| 85 | struct kcore_list { |
| 86 | struct kcore_list *next; |
| 87 | unsigned long addr; |
| 88 | size_t size; |
| 89 | }; |
| 90 | |
Vivek Goyal | 666bfdd | 2005-06-25 14:58:21 -0700 | [diff] [blame] | 91 | struct vmcore { |
| 92 | struct list_head list; |
| 93 | unsigned long long paddr; |
Vivek Goyal | 80e8ff6 | 2006-04-10 22:54:10 -0700 | [diff] [blame] | 94 | unsigned long long size; |
Vivek Goyal | 666bfdd | 2005-06-25 14:58:21 -0700 | [diff] [blame] | 95 | loff_t offset; |
| 96 | }; |
| 97 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 98 | #ifdef CONFIG_PROC_FS |
| 99 | |
| 100 | extern struct proc_dir_entry proc_root; |
| 101 | extern struct proc_dir_entry *proc_root_fs; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 102 | extern struct proc_dir_entry *proc_bus; |
| 103 | extern struct proc_dir_entry *proc_root_driver; |
| 104 | extern struct proc_dir_entry *proc_root_kcore; |
| 105 | |
Steven Rostedt | 64a07bd | 2006-03-26 01:36:55 -0800 | [diff] [blame] | 106 | extern spinlock_t proc_subdir_lock; |
| 107 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 108 | extern void proc_root_init(void); |
| 109 | extern void proc_misc_init(void); |
| 110 | |
| 111 | struct mm_struct; |
| 112 | |
Eric W. Biederman | 48e6484 | 2006-06-26 00:25:48 -0700 | [diff] [blame] | 113 | void proc_flush_task(struct task_struct *task); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 114 | struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 115 | int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir); |
| 116 | unsigned long task_vsize(struct mm_struct *); |
| 117 | int task_statm(struct mm_struct *, int *, int *, int *, int *); |
Eric W. Biederman | df5f831 | 2008-02-08 04:18:33 -0800 | [diff] [blame] | 118 | void task_mem(struct seq_file *, struct mm_struct *); |
| 119 | void clear_refs_smap(struct mm_struct *mm); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 120 | |
Alexey Dobriyan | 7695650 | 2007-05-08 00:25:45 -0700 | [diff] [blame] | 121 | struct proc_dir_entry *de_get(struct proc_dir_entry *de); |
| 122 | void de_put(struct proc_dir_entry *de); |
| 123 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 124 | extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode, |
| 125 | struct proc_dir_entry *parent); |
Alexey Dobriyan | 2d3a4e3 | 2008-02-08 04:18:37 -0800 | [diff] [blame] | 126 | struct proc_dir_entry *proc_create(const char *name, mode_t mode, |
| 127 | struct proc_dir_entry *parent, |
| 128 | const struct file_operations *proc_fops); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 129 | extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent); |
| 130 | |
| 131 | extern struct vfsmount *proc_mnt; |
Pavel Emelyanov | 07543f5 | 2007-10-18 23:40:08 -0700 | [diff] [blame] | 132 | struct pid_namespace; |
| 133 | extern int proc_fill_super(struct super_block *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 134 | extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *); |
| 135 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 136 | /* |
| 137 | * These are generic /proc routines that use the internal |
| 138 | * "struct proc_dir_entry" tree to traverse the filesystem. |
| 139 | * |
| 140 | * The /proc root directory has extended versions to take care |
| 141 | * of the /proc/<pid> subdirectories. |
| 142 | */ |
| 143 | extern int proc_readdir(struct file *, void *, filldir_t); |
| 144 | extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *); |
| 145 | |
Arjan van de Ven | 4b6f5d2 | 2006-03-28 01:56:42 -0800 | [diff] [blame] | 146 | extern const struct file_operations proc_kcore_operations; |
| 147 | extern const struct file_operations proc_kmsg_operations; |
| 148 | extern const struct file_operations ppc_htab_operations; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 149 | |
Pavel Emelyanov | 6f4e643 | 2007-10-18 23:40:11 -0700 | [diff] [blame] | 150 | extern int pid_ns_prepare_proc(struct pid_namespace *ns); |
| 151 | extern void pid_ns_release_proc(struct pid_namespace *ns); |
| 152 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 153 | /* |
| 154 | * proc_tty.c |
| 155 | */ |
| 156 | struct tty_driver; |
| 157 | extern void proc_tty_init(void); |
| 158 | extern void proc_tty_register_driver(struct tty_driver *driver); |
| 159 | extern void proc_tty_unregister_driver(struct tty_driver *driver); |
| 160 | |
| 161 | /* |
| 162 | * proc_devtree.c |
| 163 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 164 | #ifdef CONFIG_PROC_DEVICETREE |
Benjamin Herrenschmidt | 183d020 | 2005-11-07 14:29:02 +1100 | [diff] [blame] | 165 | struct device_node; |
| 166 | struct property; |
| 167 | extern void proc_device_tree_init(void); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 168 | extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *); |
Benjamin Herrenschmidt | 183d020 | 2005-11-07 14:29:02 +1100 | [diff] [blame] | 169 | extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop); |
Dave C Boutcher | 898b539 | 2006-01-12 16:07:17 -0600 | [diff] [blame] | 170 | extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde, |
| 171 | struct property *prop); |
| 172 | extern void proc_device_tree_update_prop(struct proc_dir_entry *pde, |
| 173 | struct property *newprop, |
| 174 | struct property *oldprop); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 175 | #endif /* CONFIG_PROC_DEVICETREE */ |
| 176 | |
| 177 | extern struct proc_dir_entry *proc_symlink(const char *, |
| 178 | struct proc_dir_entry *, const char *); |
| 179 | extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *); |
| 180 | extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode, |
| 181 | struct proc_dir_entry *parent); |
| 182 | |
| 183 | static inline struct proc_dir_entry *create_proc_read_entry(const char *name, |
| 184 | mode_t mode, struct proc_dir_entry *base, |
| 185 | read_proc_t *read_proc, void * data) |
| 186 | { |
| 187 | struct proc_dir_entry *res=create_proc_entry(name,mode,base); |
| 188 | if (res) { |
| 189 | res->read_proc=read_proc; |
| 190 | res->data=data; |
| 191 | } |
| 192 | return res; |
| 193 | } |
| 194 | |
| 195 | static inline struct proc_dir_entry *create_proc_info_entry(const char *name, |
| 196 | mode_t mode, struct proc_dir_entry *base, get_info_t *get_info) |
| 197 | { |
| 198 | struct proc_dir_entry *res=create_proc_entry(name,mode,base); |
| 199 | if (res) res->get_info=get_info; |
| 200 | return res; |
| 201 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 202 | |
Eric W. Biederman | 457c4cb | 2007-09-12 12:01:34 +0200 | [diff] [blame] | 203 | extern struct proc_dir_entry *proc_net_fops_create(struct net *net, |
| 204 | const char *name, mode_t mode, const struct file_operations *fops); |
| 205 | extern void proc_net_remove(struct net *net, const char *name); |
Denis V. Lunev | e5d69b9 | 2008-01-10 03:51:41 -0800 | [diff] [blame] | 206 | extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name, |
| 207 | struct proc_dir_entry *parent); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 208 | |
| 209 | #else |
| 210 | |
| 211 | #define proc_root_driver NULL |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 212 | #define proc_bus NULL |
| 213 | |
Eric W. Biederman | 457c4cb | 2007-09-12 12:01:34 +0200 | [diff] [blame] | 214 | #define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; }) |
Eric W. Biederman | 457c4cb | 2007-09-12 12:01:34 +0200 | [diff] [blame] | 215 | static inline void proc_net_remove(struct net *net, const char *name) {} |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 216 | |
Pavel Emelyanov | 60347f6 | 2007-10-18 23:40:03 -0700 | [diff] [blame] | 217 | static inline void proc_flush_task(struct task_struct *task) |
| 218 | { |
| 219 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 220 | |
| 221 | static inline struct proc_dir_entry *create_proc_entry(const char *name, |
| 222 | mode_t mode, struct proc_dir_entry *parent) { return NULL; } |
Alexey Dobriyan | 2d3a4e3 | 2008-02-08 04:18:37 -0800 | [diff] [blame] | 223 | static inline struct proc_dir_entry *proc_create(const char *name, |
| 224 | mode_t mode, struct proc_dir_entry *parent, |
| 225 | const struct file_operations *proc_fops) |
| 226 | { |
| 227 | return NULL; |
| 228 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 229 | #define remove_proc_entry(name, parent) do {} while (0) |
| 230 | |
| 231 | static inline struct proc_dir_entry *proc_symlink(const char *name, |
| 232 | struct proc_dir_entry *parent,const char *dest) {return NULL;} |
| 233 | static inline struct proc_dir_entry *proc_mkdir(const char *name, |
| 234 | struct proc_dir_entry *parent) {return NULL;} |
| 235 | |
| 236 | static inline struct proc_dir_entry *create_proc_read_entry(const char *name, |
| 237 | mode_t mode, struct proc_dir_entry *base, |
| 238 | read_proc_t *read_proc, void * data) { return NULL; } |
| 239 | static inline struct proc_dir_entry *create_proc_info_entry(const char *name, |
| 240 | mode_t mode, struct proc_dir_entry *base, get_info_t *get_info) |
| 241 | { return NULL; } |
| 242 | |
| 243 | struct tty_driver; |
| 244 | static inline void proc_tty_register_driver(struct tty_driver *driver) {}; |
| 245 | static inline void proc_tty_unregister_driver(struct tty_driver *driver) {}; |
| 246 | |
| 247 | extern struct proc_dir_entry proc_root; |
| 248 | |
Pavel Emelyanov | 6f4e643 | 2007-10-18 23:40:11 -0700 | [diff] [blame] | 249 | static inline int pid_ns_prepare_proc(struct pid_namespace *ns) |
| 250 | { |
| 251 | return 0; |
| 252 | } |
| 253 | |
| 254 | static inline void pid_ns_release_proc(struct pid_namespace *ns) |
| 255 | { |
| 256 | } |
| 257 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 258 | #endif /* CONFIG_PROC_FS */ |
| 259 | |
| 260 | #if !defined(CONFIG_PROC_KCORE) |
| 261 | static inline void kclist_add(struct kcore_list *new, void *addr, size_t size) |
| 262 | { |
| 263 | } |
| 264 | #else |
| 265 | extern void kclist_add(struct kcore_list *, void *, size_t); |
| 266 | #endif |
| 267 | |
Eric W. Biederman | 20cdc89 | 2006-10-02 02:17:07 -0700 | [diff] [blame] | 268 | union proc_op { |
Jan Blunck | 3dcd25f | 2008-02-14 19:38:35 -0800 | [diff] [blame] | 269 | int (*proc_get_link)(struct inode *, struct path *); |
Eric W. Biederman | 20cdc89 | 2006-10-02 02:17:07 -0700 | [diff] [blame] | 270 | int (*proc_read)(struct task_struct *task, char *page); |
Eric W. Biederman | be61408 | 2008-02-08 04:18:30 -0800 | [diff] [blame] | 271 | int (*proc_show)(struct seq_file *m, |
| 272 | struct pid_namespace *ns, struct pid *pid, |
| 273 | struct task_struct *task); |
Eric W. Biederman | 20cdc89 | 2006-10-02 02:17:07 -0700 | [diff] [blame] | 274 | }; |
| 275 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 276 | struct proc_inode { |
Eric W. Biederman | 13b41b0 | 2006-06-26 00:25:56 -0700 | [diff] [blame] | 277 | struct pid *pid; |
Eric W. Biederman | aed7a6c | 2006-06-26 00:25:44 -0700 | [diff] [blame] | 278 | int fd; |
Eric W. Biederman | 20cdc89 | 2006-10-02 02:17:07 -0700 | [diff] [blame] | 279 | union proc_op op; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 280 | struct proc_dir_entry *pde; |
| 281 | struct inode vfs_inode; |
| 282 | }; |
| 283 | |
| 284 | static inline struct proc_inode *PROC_I(const struct inode *inode) |
| 285 | { |
| 286 | return container_of(inode, struct proc_inode, vfs_inode); |
| 287 | } |
| 288 | |
| 289 | static inline struct proc_dir_entry *PDE(const struct inode *inode) |
| 290 | { |
| 291 | return PROC_I(inode)->pde; |
| 292 | } |
| 293 | |
Eric W. Biederman | 457c4cb | 2007-09-12 12:01:34 +0200 | [diff] [blame] | 294 | static inline struct net *PDE_NET(struct proc_dir_entry *pde) |
| 295 | { |
| 296 | return pde->parent->data; |
| 297 | } |
| 298 | |
Eric W. Biederman | 077130c | 2007-09-13 09:18:57 +0200 | [diff] [blame] | 299 | struct net *get_proc_net(const struct inode *inode); |
Eric W. Biederman | 457c4cb | 2007-09-12 12:01:34 +0200 | [diff] [blame] | 300 | |
Eric W. Biederman | 99f8955 | 2006-06-26 00:25:55 -0700 | [diff] [blame] | 301 | struct proc_maps_private { |
Eric W. Biederman | 13b41b0 | 2006-06-26 00:25:56 -0700 | [diff] [blame] | 302 | struct pid *pid; |
Eric W. Biederman | 99f8955 | 2006-06-26 00:25:55 -0700 | [diff] [blame] | 303 | struct task_struct *task; |
David Howells | dbf8685 | 2006-09-27 01:50:19 -0700 | [diff] [blame] | 304 | #ifdef CONFIG_MMU |
Eric W. Biederman | 99f8955 | 2006-06-26 00:25:55 -0700 | [diff] [blame] | 305 | struct vm_area_struct *tail_vma; |
David Howells | dbf8685 | 2006-09-27 01:50:19 -0700 | [diff] [blame] | 306 | #endif |
Eric W. Biederman | 99f8955 | 2006-06-26 00:25:55 -0700 | [diff] [blame] | 307 | }; |
| 308 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 309 | #endif /* _LINUX_PROC_FS_H */ |