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 | ||
c30bb2a2 KH |
81 | enum kcore_type { |
82 | KCORE_TEXT, | |
83 | KCORE_VMALLOC, | |
84 | KCORE_RAM, | |
26562c59 | 85 | KCORE_VMEMMAP, |
c30bb2a2 KH |
86 | KCORE_OTHER, |
87 | }; | |
88 | ||
1da177e4 | 89 | struct kcore_list { |
2ef43ec7 | 90 | struct list_head list; |
1da177e4 LT |
91 | unsigned long addr; |
92 | size_t size; | |
c30bb2a2 | 93 | int type; |
1da177e4 LT |
94 | }; |
95 | ||
666bfddb VG |
96 | struct vmcore { |
97 | struct list_head list; | |
98 | unsigned long long paddr; | |
80e8ff63 | 99 | unsigned long long size; |
666bfddb VG |
100 | loff_t offset; |
101 | }; | |
102 | ||
1da177e4 LT |
103 | #ifdef CONFIG_PROC_FS |
104 | ||
1da177e4 | 105 | extern void proc_root_init(void); |
1da177e4 | 106 | |
48e6484d | 107 | void proc_flush_task(struct task_struct *task); |
7695650a | 108 | |
1da177e4 LT |
109 | extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode, |
110 | struct proc_dir_entry *parent); | |
59b74351 | 111 | struct proc_dir_entry *proc_create_data(const char *name, mode_t mode, |
2d3a4e36 | 112 | struct proc_dir_entry *parent, |
59b74351 DL |
113 | const struct file_operations *proc_fops, |
114 | void *data); | |
1da177e4 LT |
115 | extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent); |
116 | ||
07543f5c | 117 | struct pid_namespace; |
1da177e4 | 118 | |
6f4e6433 PE |
119 | extern int pid_ns_prepare_proc(struct pid_namespace *ns); |
120 | extern void pid_ns_release_proc(struct pid_namespace *ns); | |
121 | ||
1da177e4 LT |
122 | /* |
123 | * proc_tty.c | |
124 | */ | |
125 | struct tty_driver; | |
126 | extern void proc_tty_init(void); | |
127 | extern void proc_tty_register_driver(struct tty_driver *driver); | |
128 | extern void proc_tty_unregister_driver(struct tty_driver *driver); | |
129 | ||
130 | /* | |
131 | * proc_devtree.c | |
132 | */ | |
183d0202 | 133 | #ifdef CONFIG_PROC_DEVICETREE |
1da177e4 | 134 | struct device_node; |
183d0202 | 135 | struct property; |
1da177e4 | 136 | extern void proc_device_tree_init(void); |
1da177e4 | 137 | extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *); |
183d0202 | 138 | extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop); |
898b5395 DB |
139 | extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde, |
140 | struct property *prop); | |
141 | extern void proc_device_tree_update_prop(struct proc_dir_entry *pde, | |
142 | struct property *newprop, | |
143 | struct property *oldprop); | |
1da177e4 LT |
144 | #endif /* CONFIG_PROC_DEVICETREE */ |
145 | ||
146 | extern struct proc_dir_entry *proc_symlink(const char *, | |
147 | struct proc_dir_entry *, const char *); | |
148 | extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *); | |
149 | extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode, | |
150 | struct proc_dir_entry *parent); | |
151 | ||
59b74351 DL |
152 | static inline struct proc_dir_entry *proc_create(const char *name, mode_t mode, |
153 | struct proc_dir_entry *parent, const struct file_operations *proc_fops) | |
154 | { | |
155 | return proc_create_data(name, mode, parent, proc_fops, NULL); | |
156 | } | |
157 | ||
1da177e4 LT |
158 | static inline struct proc_dir_entry *create_proc_read_entry(const char *name, |
159 | mode_t mode, struct proc_dir_entry *base, | |
160 | read_proc_t *read_proc, void * data) | |
161 | { | |
162 | struct proc_dir_entry *res=create_proc_entry(name,mode,base); | |
163 | if (res) { | |
164 | res->read_proc=read_proc; | |
165 | res->data=data; | |
166 | } | |
167 | return res; | |
168 | } | |
169 | ||
457c4cbc EB |
170 | extern struct proc_dir_entry *proc_net_fops_create(struct net *net, |
171 | const char *name, mode_t mode, const struct file_operations *fops); | |
172 | extern void proc_net_remove(struct net *net, const char *name); | |
e5d69b9f DL |
173 | extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name, |
174 | struct proc_dir_entry *parent); | |
1da177e4 | 175 | |
925d1c40 MH |
176 | /* While the {get|set|dup}_mm_exe_file functions are for mm_structs, they are |
177 | * only needed to implement /proc/<pid>|self/exe so we define them here. */ | |
178 | extern void set_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file); | |
179 | extern struct file *get_mm_exe_file(struct mm_struct *mm); | |
180 | extern void dup_mm_exe_file(struct mm_struct *oldmm, struct mm_struct *newmm); | |
181 | ||
1da177e4 LT |
182 | #else |
183 | ||
457c4cbc | 184 | #define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; }) |
457c4cbc | 185 | static inline void proc_net_remove(struct net *net, const char *name) {} |
1da177e4 | 186 | |
60347f67 PE |
187 | static inline void proc_flush_task(struct task_struct *task) |
188 | { | |
189 | } | |
1da177e4 LT |
190 | |
191 | static inline struct proc_dir_entry *create_proc_entry(const char *name, | |
192 | mode_t mode, struct proc_dir_entry *parent) { return NULL; } | |
2d3a4e36 AD |
193 | static inline struct proc_dir_entry *proc_create(const char *name, |
194 | mode_t mode, struct proc_dir_entry *parent, | |
195 | const struct file_operations *proc_fops) | |
196 | { | |
197 | return NULL; | |
198 | } | |
59b74351 DL |
199 | static inline struct proc_dir_entry *proc_create_data(const char *name, |
200 | mode_t mode, struct proc_dir_entry *parent, | |
201 | const struct file_operations *proc_fops, void *data) | |
202 | { | |
203 | return NULL; | |
204 | } | |
1da177e4 LT |
205 | #define remove_proc_entry(name, parent) do {} while (0) |
206 | ||
207 | static inline struct proc_dir_entry *proc_symlink(const char *name, | |
208 | struct proc_dir_entry *parent,const char *dest) {return NULL;} | |
209 | static inline struct proc_dir_entry *proc_mkdir(const char *name, | |
210 | struct proc_dir_entry *parent) {return NULL;} | |
211 | ||
212 | static inline struct proc_dir_entry *create_proc_read_entry(const char *name, | |
213 | mode_t mode, struct proc_dir_entry *base, | |
214 | read_proc_t *read_proc, void * data) { return NULL; } | |
1da177e4 LT |
215 | |
216 | struct tty_driver; | |
217 | static inline void proc_tty_register_driver(struct tty_driver *driver) {}; | |
218 | static inline void proc_tty_unregister_driver(struct tty_driver *driver) {}; | |
219 | ||
6f4e6433 PE |
220 | static inline int pid_ns_prepare_proc(struct pid_namespace *ns) |
221 | { | |
222 | return 0; | |
223 | } | |
224 | ||
225 | static inline void pid_ns_release_proc(struct pid_namespace *ns) | |
226 | { | |
227 | } | |
228 | ||
925d1c40 MH |
229 | static inline void set_mm_exe_file(struct mm_struct *mm, |
230 | struct file *new_exe_file) | |
231 | {} | |
232 | ||
233 | static inline struct file *get_mm_exe_file(struct mm_struct *mm) | |
234 | { | |
235 | return NULL; | |
236 | } | |
237 | ||
238 | static inline void dup_mm_exe_file(struct mm_struct *oldmm, | |
239 | struct mm_struct *newmm) | |
240 | {} | |
241 | ||
1da177e4 LT |
242 | #endif /* CONFIG_PROC_FS */ |
243 | ||
244 | #if !defined(CONFIG_PROC_KCORE) | |
c30bb2a2 KH |
245 | static inline void |
246 | kclist_add(struct kcore_list *new, void *addr, size_t size, int type) | |
1da177e4 LT |
247 | { |
248 | } | |
249 | #else | |
c30bb2a2 | 250 | extern void kclist_add(struct kcore_list *, void *, size_t, int type); |
1da177e4 LT |
251 | #endif |
252 | ||
20cdc894 | 253 | union proc_op { |
3dcd25f3 | 254 | int (*proc_get_link)(struct inode *, struct path *); |
20cdc894 | 255 | int (*proc_read)(struct task_struct *task, char *page); |
be614086 EB |
256 | int (*proc_show)(struct seq_file *m, |
257 | struct pid_namespace *ns, struct pid *pid, | |
258 | struct task_struct *task); | |
20cdc894 EB |
259 | }; |
260 | ||
9043476f AV |
261 | struct ctl_table_header; |
262 | struct ctl_table; | |
263 | ||
1da177e4 | 264 | struct proc_inode { |
13b41b09 | 265 | struct pid *pid; |
aed7a6c4 | 266 | int fd; |
20cdc894 | 267 | union proc_op op; |
1da177e4 | 268 | struct proc_dir_entry *pde; |
9043476f AV |
269 | struct ctl_table_header *sysctl; |
270 | struct ctl_table *sysctl_entry; | |
1da177e4 LT |
271 | struct inode vfs_inode; |
272 | }; | |
273 | ||
274 | static inline struct proc_inode *PROC_I(const struct inode *inode) | |
275 | { | |
276 | return container_of(inode, struct proc_inode, vfs_inode); | |
277 | } | |
278 | ||
279 | static inline struct proc_dir_entry *PDE(const struct inode *inode) | |
280 | { | |
281 | return PROC_I(inode)->pde; | |
282 | } | |
283 | ||
457c4cbc EB |
284 | static inline struct net *PDE_NET(struct proc_dir_entry *pde) |
285 | { | |
286 | return pde->parent->data; | |
287 | } | |
288 | ||
99f89551 | 289 | struct proc_maps_private { |
13b41b09 | 290 | struct pid *pid; |
99f89551 | 291 | struct task_struct *task; |
dbf8685c | 292 | #ifdef CONFIG_MMU |
99f89551 | 293 | struct vm_area_struct *tail_vma; |
dbf8685c | 294 | #endif |
99f89551 EB |
295 | }; |
296 | ||
1da177e4 | 297 | #endif /* _LINUX_PROC_FS_H */ |