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> |
Arun Sharma | 60063497 | 2011-07-26 16:09:06 -0700 | [diff] [blame] | 8 | #include <linux/atomic.h> |
David Howells | 0bb80f2 | 2013-04-12 01:50:06 +0100 | [diff] [blame] | 9 | #include <linux/proc_ns.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 10 | |
Eric W. Biederman | 457c4cb | 2007-09-12 12:01:34 +0200 | [diff] [blame] | 11 | struct net; |
Alexey Dobriyan | 786d7e1 | 2007-07-15 23:39:00 -0700 | [diff] [blame] | 12 | struct completion; |
Ben Nizette | 57d3c64 | 2008-06-12 15:21:31 -0700 | [diff] [blame] | 13 | struct mm_struct; |
| 14 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 15 | /* |
| 16 | * The proc filesystem constants/structures |
| 17 | */ |
| 18 | |
| 19 | /* |
| 20 | * Offset of the first process in the /proc root directory.. |
| 21 | */ |
| 22 | #define FIRST_PROCESS_ENTRY 256 |
| 23 | |
Matt Mackall | f248dcb | 2008-02-04 22:29:03 -0800 | [diff] [blame] | 24 | /* Worst case buffer size needed for holding an integer. */ |
| 25 | #define PROC_NUMBUF 13 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 26 | |
| 27 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 28 | * This is not completely implemented yet. The idea is to |
| 29 | * create an in-memory tree (like the actual /proc filesystem |
| 30 | * tree) of these proc_dir_entries, so that we can dynamically |
| 31 | * add new files to /proc. |
| 32 | * |
| 33 | * The "next" pointer creates a linked list of one /proc directory, |
| 34 | * while parent/subdir create the directory structure (every |
| 35 | * /proc file has a parent, but "subdir" is NULL for all |
| 36 | * non-directory entries). |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 37 | */ |
| 38 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 39 | struct proc_dir_entry { |
| 40 | unsigned int low_ino; |
Al Viro | d161a13 | 2011-07-24 03:36:29 -0400 | [diff] [blame] | 41 | umode_t mode; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 42 | nlink_t nlink; |
Eric W. Biederman | dcb0f22 | 2012-02-09 08:48:21 -0800 | [diff] [blame] | 43 | kuid_t uid; |
| 44 | kgid_t gid; |
Maneesh Soni | 22e6c1b | 2006-03-26 01:37:29 -0800 | [diff] [blame] | 45 | loff_t size; |
Arjan van de Ven | c5ef1c4 | 2007-02-12 00:55:40 -0800 | [diff] [blame] | 46 | const struct inode_operations *proc_iops; |
| 47 | const struct file_operations *proc_fops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 48 | struct proc_dir_entry *next, *parent, *subdir; |
| 49 | void *data; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | atomic_t count; /* use count */ |
Al Viro | 05c0ae2 | 2013-04-04 16:28:47 -0400 | [diff] [blame] | 51 | atomic_t in_use; /* number of callers into module in progress; */ |
Al Viro | 866ad9a | 2013-04-03 19:07:30 -0400 | [diff] [blame] | 52 | /* negative -> it's going away RSN */ |
Alexey Dobriyan | 786d7e1 | 2007-07-15 23:39:00 -0700 | [diff] [blame] | 53 | struct completion *pde_unload_completion; |
Alexey Dobriyan | 881adb8 | 2008-07-25 01:48:29 -0700 | [diff] [blame] | 54 | struct list_head pde_openers; /* who did ->open, but not ->release */ |
David Howells | 09570f9 | 2011-07-27 21:47:03 +0300 | [diff] [blame] | 55 | spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */ |
| 56 | u8 namelen; |
| 57 | char name[]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 58 | }; |
| 59 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 60 | #ifdef CONFIG_PROC_FS |
| 61 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 62 | extern void proc_root_init(void); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 63 | |
Eric W. Biederman | 48e6484 | 2006-06-26 00:25:48 -0700 | [diff] [blame] | 64 | void proc_flush_task(struct task_struct *task); |
Alexey Dobriyan | 7695650 | 2007-05-08 00:25:45 -0700 | [diff] [blame] | 65 | |
Al Viro | d161a13 | 2011-07-24 03:36:29 -0400 | [diff] [blame] | 66 | struct proc_dir_entry *proc_create_data(const char *name, umode_t mode, |
Alexey Dobriyan | 2d3a4e3 | 2008-02-08 04:18:37 -0800 | [diff] [blame] | 67 | struct proc_dir_entry *parent, |
Denis V. Lunev | 59b7435 | 2008-04-29 01:02:00 -0700 | [diff] [blame] | 68 | const struct file_operations *proc_fops, |
| 69 | void *data); |
David Howells | a8ca16e | 2013-04-12 17:27:28 +0100 | [diff] [blame] | 70 | extern void proc_remove(struct proc_dir_entry *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 71 | extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent); |
Al Viro | 8ce584c | 2013-03-30 20:13:46 -0400 | [diff] [blame] | 72 | extern int remove_proc_subtree(const char *name, struct proc_dir_entry *parent); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 73 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 74 | extern struct proc_dir_entry *proc_symlink(const char *, |
| 75 | struct proc_dir_entry *, const char *); |
| 76 | extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *); |
David Howells | 270b5ac | 2013-04-12 02:48:30 +0100 | [diff] [blame] | 77 | extern struct proc_dir_entry *proc_mkdir_data(const char *, umode_t, |
| 78 | struct proc_dir_entry *, void *); |
Al Viro | d161a13 | 2011-07-24 03:36:29 -0400 | [diff] [blame] | 79 | extern struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 80 | struct proc_dir_entry *parent); |
| 81 | |
Al Viro | d161a13 | 2011-07-24 03:36:29 -0400 | [diff] [blame] | 82 | static inline struct proc_dir_entry *proc_create(const char *name, umode_t mode, |
Denis V. Lunev | 59b7435 | 2008-04-29 01:02:00 -0700 | [diff] [blame] | 83 | struct proc_dir_entry *parent, const struct file_operations *proc_fops) |
| 84 | { |
| 85 | return proc_create_data(name, mode, parent, proc_fops, NULL); |
| 86 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 87 | |
David Howells | 271a15e | 2013-04-12 00:38:51 +0100 | [diff] [blame] | 88 | extern void proc_set_size(struct proc_dir_entry *, loff_t); |
| 89 | extern void proc_set_user(struct proc_dir_entry *, kuid_t, kgid_t); |
David Howells | c30480b | 2013-04-12 18:03:36 +0100 | [diff] [blame^] | 90 | extern void *PDE_DATA(const struct inode *); |
David Howells | 4a520d2 | 2013-04-12 14:06:01 +0100 | [diff] [blame] | 91 | extern void *proc_get_parent_data(const struct inode *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 92 | #else |
| 93 | |
Pavel Emelyanov | 60347f6 | 2007-10-18 23:40:03 -0700 | [diff] [blame] | 94 | static inline void proc_flush_task(struct task_struct *task) |
| 95 | { |
| 96 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 97 | |
Gao feng | 4fc1a60 | 2013-02-19 00:43:10 +0000 | [diff] [blame] | 98 | #define proc_create(name, mode, parent, fops) ({ (void)(mode), NULL; }) |
| 99 | |
Denis V. Lunev | 59b7435 | 2008-04-29 01:02:00 -0700 | [diff] [blame] | 100 | static inline struct proc_dir_entry *proc_create_data(const char *name, |
Al Viro | d161a13 | 2011-07-24 03:36:29 -0400 | [diff] [blame] | 101 | umode_t mode, struct proc_dir_entry *parent, |
Denis V. Lunev | 59b7435 | 2008-04-29 01:02:00 -0700 | [diff] [blame] | 102 | const struct file_operations *proc_fops, void *data) |
| 103 | { |
| 104 | return NULL; |
| 105 | } |
David Howells | a8ca16e | 2013-04-12 17:27:28 +0100 | [diff] [blame] | 106 | static inline void proc_remove(struct proc_dir_entry *de) {} |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 107 | #define remove_proc_entry(name, parent) do {} while (0) |
Al Viro | 8ce584c | 2013-03-30 20:13:46 -0400 | [diff] [blame] | 108 | #define remove_proc_subtree(name, parent) do {} while (0) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 109 | |
| 110 | static inline struct proc_dir_entry *proc_symlink(const char *name, |
| 111 | struct proc_dir_entry *parent,const char *dest) {return NULL;} |
| 112 | static inline struct proc_dir_entry *proc_mkdir(const char *name, |
| 113 | struct proc_dir_entry *parent) {return NULL;} |
David Howells | 270b5ac | 2013-04-12 02:48:30 +0100 | [diff] [blame] | 114 | static inline struct proc_dir_entry *proc_mkdir_data(const char *name, |
| 115 | umode_t mode, struct proc_dir_entry *parent, void *data) { return NULL; } |
Randy Dunlap | f12a20f | 2011-05-17 15:44:12 -0700 | [diff] [blame] | 116 | static inline struct proc_dir_entry *proc_mkdir_mode(const char *name, |
Al Viro | d161a13 | 2011-07-24 03:36:29 -0400 | [diff] [blame] | 117 | umode_t mode, struct proc_dir_entry *parent) { return NULL; } |
David Howells | 271a15e | 2013-04-12 00:38:51 +0100 | [diff] [blame] | 118 | static inline void proc_set_size(struct proc_dir_entry *de, loff_t size) {} |
| 119 | static inline void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) {} |
David Howells | c30480b | 2013-04-12 18:03:36 +0100 | [diff] [blame^] | 120 | static inline void *PDE_DATA(const struct inode *inode) {BUG(); return NULL;} |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 122 | #endif /* CONFIG_PROC_FS */ |
| 123 | |
Eric W. Biederman | 6b4e306 | 2010-03-07 16:41:34 -0800 | [diff] [blame] | 124 | |
Eric W. Biederman | 20cdc89 | 2006-10-02 02:17:07 -0700 | [diff] [blame] | 125 | union proc_op { |
Cyrill Gorcunov | 7773fbc | 2012-01-10 15:11:20 -0800 | [diff] [blame] | 126 | int (*proc_get_link)(struct dentry *, struct path *); |
Eric W. Biederman | 20cdc89 | 2006-10-02 02:17:07 -0700 | [diff] [blame] | 127 | int (*proc_read)(struct task_struct *task, char *page); |
Eric W. Biederman | be61408 | 2008-02-08 04:18:30 -0800 | [diff] [blame] | 128 | int (*proc_show)(struct seq_file *m, |
| 129 | struct pid_namespace *ns, struct pid *pid, |
| 130 | struct task_struct *task); |
Eric W. Biederman | 20cdc89 | 2006-10-02 02:17:07 -0700 | [diff] [blame] | 131 | }; |
| 132 | |
Al Viro | 9043476f | 2008-07-15 08:54:06 -0400 | [diff] [blame] | 133 | struct ctl_table_header; |
| 134 | struct ctl_table; |
| 135 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 136 | struct proc_inode { |
Eric W. Biederman | 13b41b0 | 2006-06-26 00:25:56 -0700 | [diff] [blame] | 137 | struct pid *pid; |
Eric W. Biederman | aed7a6c | 2006-06-26 00:25:44 -0700 | [diff] [blame] | 138 | int fd; |
Eric W. Biederman | 20cdc89 | 2006-10-02 02:17:07 -0700 | [diff] [blame] | 139 | union proc_op op; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 140 | struct proc_dir_entry *pde; |
Al Viro | 9043476f | 2008-07-15 08:54:06 -0400 | [diff] [blame] | 141 | struct ctl_table_header *sysctl; |
| 142 | struct ctl_table *sysctl_entry; |
David Howells | 0bb80f2 | 2013-04-12 01:50:06 +0100 | [diff] [blame] | 143 | struct proc_ns ns; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 144 | struct inode vfs_inode; |
| 145 | }; |
| 146 | |
David Howells | 270b5ac | 2013-04-12 02:48:30 +0100 | [diff] [blame] | 147 | static inline struct proc_dir_entry *proc_net_mkdir( |
| 148 | struct net *net, const char *name, struct proc_dir_entry *parent) |
| 149 | { |
| 150 | return proc_mkdir_data(name, 0, parent, net); |
| 151 | } |
| 152 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 153 | #endif /* _LINUX_PROC_FS_H */ |