Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | #ifndef _LINUX_PROC_FS_H |
2 | #define _LINUX_PROC_FS_H | |
3 | ||
1da177e4 LT |
4 | #include <linux/slab.h> |
5 | #include <linux/fs.h> | |
64a07bd8 | 6 | #include <linux/spinlock.h> |
e18fa700 | 7 | #include <linux/magic.h> |
1da177e4 LT |
8 | #include <asm/atomic.h> |
9 | ||
457c4cbc | 10 | struct net; |
786d7e16 | 11 | struct completion; |
57d3c64f BN |
12 | struct mm_struct; |
13 | ||
1da177e4 LT |
14 | /* |
15 | * The proc filesystem constants/structures | |
16 | */ | |
17 | ||
18 | /* | |
19 | * Offset of the first process in the /proc root directory.. | |
20 | */ | |
21 | #define FIRST_PROCESS_ENTRY 256 | |
22 | ||
f248dcb3 MM |
23 | /* Worst case buffer size needed for holding an integer. */ |
24 | #define PROC_NUMBUF 13 | |
1da177e4 LT |
25 | |
26 | /* | |
27 | * We always define these enumerators | |
28 | */ | |
29 | ||
30 | enum { | |
31 | PROC_ROOT_INO = 1, | |
32 | }; | |
33 | ||
1da177e4 LT |
34 | /* |
35 | * This is not completely implemented yet. The idea is to | |
36 | * create an in-memory tree (like the actual /proc filesystem | |
37 | * tree) of these proc_dir_entries, so that we can dynamically | |
38 | * add new files to /proc. | |
39 | * | |
40 | * The "next" pointer creates a linked list of one /proc directory, | |
41 | * while parent/subdir create the directory structure (every | |
42 | * /proc file has a parent, but "subdir" is NULL for all | |
43 | * non-directory entries). | |
1da177e4 LT |
44 | */ |
45 | ||
46 | typedef int (read_proc_t)(char *page, char **start, off_t off, | |
47 | int count, int *eof, void *data); | |
48 | typedef int (write_proc_t)(struct file *file, const char __user *buffer, | |
49 | unsigned long count, void *data); | |
1da177e4 LT |
50 | |
51 | struct proc_dir_entry { | |
52 | unsigned int low_ino; | |
53 | unsigned short namelen; | |
54 | const char *name; | |
55 | mode_t mode; | |
56 | nlink_t nlink; | |
57 | uid_t uid; | |
58 | gid_t gid; | |
22e6c1b3 | 59 | loff_t size; |
c5ef1c42 | 60 | const struct inode_operations *proc_iops; |
786d7e16 AD |
61 | /* |
62 | * NULL ->proc_fops means "PDE is going away RSN" or | |
63 | * "PDE is just created". In either case, e.g. ->read_proc won't be | |
64 | * called because it's too late or too early, respectively. | |
65 | * | |
66 | * If you're allocating ->proc_fops dynamically, save a pointer | |
67 | * somewhere. | |
68 | */ | |
c5ef1c42 | 69 | const struct file_operations *proc_fops; |
1da177e4 LT |
70 | struct proc_dir_entry *next, *parent, *subdir; |
71 | void *data; | |
72 | read_proc_t *read_proc; | |
73 | write_proc_t *write_proc; | |
74 | atomic_t count; /* use count */ | |
786d7e16 AD |
75 | int pde_users; /* number of callers into module in progress */ |
76 | spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */ | |
77 | struct completion *pde_unload_completion; | |
881adb85 | 78 | struct list_head pde_openers; /* who did ->open, but not ->release */ |
1da177e4 LT |
79 | }; |
80 | ||
81 | struct kcore_list { | |
82 | struct kcore_list *next; | |
83 | unsigned long addr; | |
84 | size_t size; | |
85 | }; | |
86 | ||
666bfddb VG |
87 | struct vmcore { |
88 | struct list_head list; | |
89 | unsigned long long paddr; | |
80e8ff63 | 90 | unsigned long long size; |
666bfddb VG |
91 | loff_t offset; |
92 | }; | |
93 | ||
1da177e4 LT |
94 | #ifdef CONFIG_PROC_FS |
95 | ||
64a07bd8 SR |
96 | extern spinlock_t proc_subdir_lock; |
97 | ||
1da177e4 | 98 | extern void proc_root_init(void); |
1da177e4 | 99 | |
48e6484d | 100 | void proc_flush_task(struct task_struct *task); |
1da177e4 | 101 | struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *); |
1da177e4 LT |
102 | int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir); |
103 | unsigned long task_vsize(struct mm_struct *); | |
104 | int task_statm(struct mm_struct *, int *, int *, int *, int *); | |
df5f8314 EB |
105 | void task_mem(struct seq_file *, struct mm_struct *); |
106 | void clear_refs_smap(struct mm_struct *mm); | |
1da177e4 | 107 | |
7695650a AD |
108 | struct proc_dir_entry *de_get(struct proc_dir_entry *de); |
109 | void de_put(struct proc_dir_entry *de); | |
110 | ||
1da177e4 LT |
111 | extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode, |
112 | struct proc_dir_entry *parent); | |
59b74351 | 113 | struct proc_dir_entry *proc_create_data(const char *name, mode_t mode, |
2d3a4e36 | 114 | struct proc_dir_entry *parent, |
59b74351 DL |
115 | const struct file_operations *proc_fops, |
116 | void *data); | |
1da177e4 LT |
117 | extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent); |
118 | ||
119 | extern struct vfsmount *proc_mnt; | |
07543f5c PE |
120 | struct pid_namespace; |
121 | extern int proc_fill_super(struct super_block *); | |
1da177e4 LT |
122 | extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *); |
123 | ||
1da177e4 LT |
124 | /* |
125 | * These are generic /proc routines that use the internal | |
126 | * "struct proc_dir_entry" tree to traverse the filesystem. | |
127 | * | |
128 | * The /proc root directory has extended versions to take care | |
129 | * of the /proc/<pid> subdirectories. | |
130 | */ | |
131 | extern int proc_readdir(struct file *, void *, filldir_t); | |
132 | extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *); | |
133 | ||
6f4e6433 PE |
134 | extern int pid_ns_prepare_proc(struct pid_namespace *ns); |
135 | extern void pid_ns_release_proc(struct pid_namespace *ns); | |
136 | ||
1da177e4 LT |
137 | /* |
138 | * proc_tty.c | |
139 | */ | |
140 | struct tty_driver; | |
141 | extern void proc_tty_init(void); | |
142 | extern void proc_tty_register_driver(struct tty_driver *driver); | |
143 | extern void proc_tty_unregister_driver(struct tty_driver *driver); | |
144 | ||
145 | /* | |
146 | * proc_devtree.c | |
147 | */ | |
183d0202 | 148 | #ifdef CONFIG_PROC_DEVICETREE |
1da177e4 | 149 | struct device_node; |
183d0202 | 150 | struct property; |
1da177e4 | 151 | extern void proc_device_tree_init(void); |
1da177e4 | 152 | extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *); |
183d0202 | 153 | extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop); |
898b5395 DB |
154 | extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde, |
155 | struct property *prop); | |
156 | extern void proc_device_tree_update_prop(struct proc_dir_entry *pde, | |
157 | struct property *newprop, | |
158 | struct property *oldprop); | |
1da177e4 LT |
159 | #endif /* CONFIG_PROC_DEVICETREE */ |
160 | ||
161 | extern struct proc_dir_entry *proc_symlink(const char *, | |
162 | struct proc_dir_entry *, const char *); | |
163 | extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *); | |
164 | extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode, | |
165 | struct proc_dir_entry *parent); | |
166 | ||
59b74351 DL |
167 | static inline struct proc_dir_entry *proc_create(const char *name, mode_t mode, |
168 | struct proc_dir_entry *parent, const struct file_operations *proc_fops) | |
169 | { | |
170 | return proc_create_data(name, mode, parent, proc_fops, NULL); | |
171 | } | |
172 | ||
1da177e4 LT |
173 | static inline struct proc_dir_entry *create_proc_read_entry(const char *name, |
174 | mode_t mode, struct proc_dir_entry *base, | |
175 | read_proc_t *read_proc, void * data) | |
176 | { | |
177 | struct proc_dir_entry *res=create_proc_entry(name,mode,base); | |
178 | if (res) { | |
179 | res->read_proc=read_proc; | |
180 | res->data=data; | |
181 | } | |
182 | return res; | |
183 | } | |
184 | ||
457c4cbc EB |
185 | extern struct proc_dir_entry *proc_net_fops_create(struct net *net, |
186 | const char *name, mode_t mode, const struct file_operations *fops); | |
187 | extern void proc_net_remove(struct net *net, const char *name); | |
e5d69b9f DL |
188 | extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name, |
189 | struct proc_dir_entry *parent); | |
1da177e4 | 190 | |
925d1c40 MH |
191 | /* While the {get|set|dup}_mm_exe_file functions are for mm_structs, they are |
192 | * only needed to implement /proc/<pid>|self/exe so we define them here. */ | |
193 | extern void set_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file); | |
194 | extern struct file *get_mm_exe_file(struct mm_struct *mm); | |
195 | extern void dup_mm_exe_file(struct mm_struct *oldmm, struct mm_struct *newmm); | |
196 | ||
1da177e4 LT |
197 | #else |
198 | ||
457c4cbc | 199 | #define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; }) |
457c4cbc | 200 | static inline void proc_net_remove(struct net *net, const char *name) {} |
1da177e4 | 201 | |
60347f67 PE |
202 | static inline void proc_flush_task(struct task_struct *task) |
203 | { | |
204 | } | |
1da177e4 LT |
205 | |
206 | static inline struct proc_dir_entry *create_proc_entry(const char *name, | |
207 | mode_t mode, struct proc_dir_entry *parent) { return NULL; } | |
2d3a4e36 AD |
208 | static inline struct proc_dir_entry *proc_create(const char *name, |
209 | mode_t mode, struct proc_dir_entry *parent, | |
210 | const struct file_operations *proc_fops) | |
211 | { | |
212 | return NULL; | |
213 | } | |
59b74351 DL |
214 | static inline struct proc_dir_entry *proc_create_data(const char *name, |
215 | mode_t mode, struct proc_dir_entry *parent, | |
216 | const struct file_operations *proc_fops, void *data) | |
217 | { | |
218 | return NULL; | |
219 | } | |
1da177e4 LT |
220 | #define remove_proc_entry(name, parent) do {} while (0) |
221 | ||
222 | static inline struct proc_dir_entry *proc_symlink(const char *name, | |
223 | struct proc_dir_entry *parent,const char *dest) {return NULL;} | |
224 | static inline struct proc_dir_entry *proc_mkdir(const char *name, | |
225 | struct proc_dir_entry *parent) {return NULL;} | |
226 | ||
227 | static inline struct proc_dir_entry *create_proc_read_entry(const char *name, | |
228 | mode_t mode, struct proc_dir_entry *base, | |
229 | read_proc_t *read_proc, void * data) { return NULL; } | |
1da177e4 LT |
230 | |
231 | struct tty_driver; | |
232 | static inline void proc_tty_register_driver(struct tty_driver *driver) {}; | |
233 | static inline void proc_tty_unregister_driver(struct tty_driver *driver) {}; | |
234 | ||
6f4e6433 PE |
235 | static inline int pid_ns_prepare_proc(struct pid_namespace *ns) |
236 | { | |
237 | return 0; | |
238 | } | |
239 | ||
240 | static inline void pid_ns_release_proc(struct pid_namespace *ns) | |
241 | { | |
242 | } | |
243 | ||
925d1c40 MH |
244 | static inline void set_mm_exe_file(struct mm_struct *mm, |
245 | struct file *new_exe_file) | |
246 | {} | |
247 | ||
248 | static inline struct file *get_mm_exe_file(struct mm_struct *mm) | |
249 | { | |
250 | return NULL; | |
251 | } | |
252 | ||
253 | static inline void dup_mm_exe_file(struct mm_struct *oldmm, | |
254 | struct mm_struct *newmm) | |
255 | {} | |
256 | ||
1da177e4 LT |
257 | #endif /* CONFIG_PROC_FS */ |
258 | ||
259 | #if !defined(CONFIG_PROC_KCORE) | |
260 | static inline void kclist_add(struct kcore_list *new, void *addr, size_t size) | |
261 | { | |
262 | } | |
263 | #else | |
264 | extern void kclist_add(struct kcore_list *, void *, size_t); | |
265 | #endif | |
266 | ||
20cdc894 | 267 | union proc_op { |
3dcd25f3 | 268 | int (*proc_get_link)(struct inode *, struct path *); |
20cdc894 | 269 | int (*proc_read)(struct task_struct *task, char *page); |
be614086 EB |
270 | int (*proc_show)(struct seq_file *m, |
271 | struct pid_namespace *ns, struct pid *pid, | |
272 | struct task_struct *task); | |
20cdc894 EB |
273 | }; |
274 | ||
9043476f AV |
275 | struct ctl_table_header; |
276 | struct ctl_table; | |
277 | ||
1da177e4 | 278 | struct proc_inode { |
13b41b09 | 279 | struct pid *pid; |
aed7a6c4 | 280 | int fd; |
20cdc894 | 281 | union proc_op op; |
1da177e4 | 282 | struct proc_dir_entry *pde; |
9043476f AV |
283 | struct ctl_table_header *sysctl; |
284 | struct ctl_table *sysctl_entry; | |
1da177e4 LT |
285 | struct inode vfs_inode; |
286 | }; | |
287 | ||
288 | static inline struct proc_inode *PROC_I(const struct inode *inode) | |
289 | { | |
290 | return container_of(inode, struct proc_inode, vfs_inode); | |
291 | } | |
292 | ||
293 | static inline struct proc_dir_entry *PDE(const struct inode *inode) | |
294 | { | |
295 | return PROC_I(inode)->pde; | |
296 | } | |
297 | ||
457c4cbc EB |
298 | static inline struct net *PDE_NET(struct proc_dir_entry *pde) |
299 | { | |
300 | return pde->parent->data; | |
301 | } | |
302 | ||
99f89551 | 303 | struct proc_maps_private { |
13b41b09 | 304 | struct pid *pid; |
99f89551 | 305 | struct task_struct *task; |
dbf8685c | 306 | #ifdef CONFIG_MMU |
99f89551 | 307 | struct vm_area_struct *tail_vma; |
dbf8685c | 308 | #endif |
99f89551 EB |
309 | }; |
310 | ||
1da177e4 | 311 | #endif /* _LINUX_PROC_FS_H */ |