1 #ifndef _LINUX_PROC_FS_H
2 #define _LINUX_PROC_FS_H
4 #include <linux/slab.h>
6 #include <linux/spinlock.h>
7 #include <linux/magic.h>
8 #include <linux/atomic.h>
15 * The proc filesystem constants/structures
19 * Offset of the first process in the /proc root directory..
21 #define FIRST_PROCESS_ENTRY 256
23 /* Worst case buffer size needed for holding an integer. */
24 #define PROC_NUMBUF 13
27 * We always define these enumerators
32 PROC_IPC_INIT_INO = 0xEFFFFFFFU,
33 PROC_UTS_INIT_INO = 0xEFFFFFFEU,
34 PROC_USER_INIT_INO = 0xEFFFFFFDU,
35 PROC_PID_INIT_INO = 0xEFFFFFFCU,
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.
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).
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);
55 struct proc_dir_entry {
62 const struct inode_operations *proc_iops;
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.
68 * If you're allocating ->proc_fops dynamically, save a pointer
71 const struct file_operations *proc_fops;
72 struct proc_dir_entry *next, *parent, *subdir;
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 */
94 struct list_head list;
101 struct list_head list;
102 unsigned long long paddr;
103 unsigned long long size;
107 #ifdef CONFIG_PROC_FS
109 extern void proc_root_init(void);
111 void proc_flush_task(struct task_struct *task);
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,
119 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
121 struct pid_namespace;
123 extern int pid_ns_prepare_proc(struct pid_namespace *ns);
124 extern void pid_ns_release_proc(struct pid_namespace *ns);
131 extern void proc_tty_init(void);
133 static inline void proc_tty_init(void)
136 extern void proc_tty_register_driver(struct tty_driver *driver);
137 extern void proc_tty_unregister_driver(struct tty_driver *driver);
142 #ifdef CONFIG_PROC_DEVICETREE
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 */
155 extern struct proc_dir_entry *proc_symlink(const char *,
156 struct proc_dir_entry *, const char *);
157 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,
159 struct proc_dir_entry *parent);
161 static inline struct proc_dir_entry *proc_create(const char *name, umode_t mode,
162 struct proc_dir_entry *parent, const struct file_operations *proc_fops)
164 return proc_create_data(name, mode, parent, proc_fops, NULL);
167 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
168 umode_t mode, struct proc_dir_entry *base,
169 read_proc_t *read_proc, void * data)
171 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
173 res->read_proc=read_proc;
179 extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
180 struct proc_dir_entry *parent);
182 extern struct file *proc_ns_fget(int fd);
183 extern bool proc_ns_inode(struct inode *inode);
185 extern int proc_alloc_inum(unsigned int *pino);
186 extern void proc_free_inum(unsigned int inum);
189 static inline void proc_flush_task(struct task_struct *task)
193 static inline struct proc_dir_entry *create_proc_entry(const char *name,
194 umode_t mode, struct proc_dir_entry *parent) { return NULL; }
196 #define proc_create(name, mode, parent, fops) ({ (void)(mode), NULL; })
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)
204 #define remove_proc_entry(name, parent) do {} while (0)
206 static inline struct proc_dir_entry *proc_symlink(const char *name,
207 struct proc_dir_entry *parent,const char *dest) {return NULL;}
208 static inline struct proc_dir_entry *proc_mkdir(const char *name,
209 struct proc_dir_entry *parent) {return NULL;}
210 static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
211 umode_t mode, struct proc_dir_entry *parent) { return NULL; }
213 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
214 umode_t mode, struct proc_dir_entry *base,
215 read_proc_t *read_proc, void * data) { return NULL; }
218 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
219 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
221 static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
226 static inline void pid_ns_release_proc(struct pid_namespace *ns)
230 static inline struct file *proc_ns_fget(int fd)
232 return ERR_PTR(-EINVAL);
235 static inline bool proc_ns_inode(struct inode *inode)
240 static inline int proc_alloc_inum(unsigned int *inum)
245 static inline void proc_free_inum(unsigned int inum)
248 #endif /* CONFIG_PROC_FS */
250 #if !defined(CONFIG_PROC_KCORE)
252 kclist_add(struct kcore_list *new, void *addr, size_t size, int type)
256 extern void kclist_add(struct kcore_list *, void *, size_t, int type);
260 struct proc_ns_operations {
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);
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;
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);
283 struct ctl_table_header;
290 struct proc_dir_entry *pde;
291 struct ctl_table_header *sysctl;
292 struct ctl_table *sysctl_entry;
294 const struct proc_ns_operations *ns_ops;
295 struct inode vfs_inode;
298 static inline struct proc_inode *PROC_I(const struct inode *inode)
300 return container_of(inode, struct proc_inode, vfs_inode);
303 static inline struct proc_dir_entry *PDE(const struct inode *inode)
305 return PROC_I(inode)->pde;
308 static inline struct net *PDE_NET(struct proc_dir_entry *pde)
310 return pde->parent->data;
313 #include <linux/signal.h>
315 void render_sigset_t(struct seq_file *m, const char *header, sigset_t *set);
316 #endif /* _LINUX_PROC_FS_H */