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 <asm/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
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.
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).
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);
51 struct proc_dir_entry {
53 unsigned short namelen;
60 const struct inode_operations *proc_iops;
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.
66 * If you're allocating ->proc_fops dynamically, save a pointer
69 const struct file_operations *proc_fops;
70 struct proc_dir_entry *next, *parent, *subdir;
72 read_proc_t *read_proc;
73 write_proc_t *write_proc;
74 atomic_t count; /* use count */
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;
78 struct list_head pde_openers; /* who did ->open, but not ->release */
89 struct list_head list;
96 struct list_head list;
97 unsigned long long paddr;
98 unsigned long long size;
102 #ifdef CONFIG_PROC_FS
104 extern void proc_root_init(void);
106 void proc_flush_task(struct task_struct *task);
108 extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
109 struct proc_dir_entry *parent);
110 struct proc_dir_entry *proc_create_data(const char *name, mode_t mode,
111 struct proc_dir_entry *parent,
112 const struct file_operations *proc_fops,
114 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
116 struct pid_namespace;
118 extern int pid_ns_prepare_proc(struct pid_namespace *ns);
119 extern void pid_ns_release_proc(struct pid_namespace *ns);
125 extern void proc_tty_init(void);
126 extern void proc_tty_register_driver(struct tty_driver *driver);
127 extern void proc_tty_unregister_driver(struct tty_driver *driver);
132 #ifdef CONFIG_PROC_DEVICETREE
135 extern void proc_device_tree_init(void);
136 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
137 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
138 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
139 struct property *prop);
140 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
141 struct property *newprop,
142 struct property *oldprop);
143 #endif /* CONFIG_PROC_DEVICETREE */
145 extern struct proc_dir_entry *proc_symlink(const char *,
146 struct proc_dir_entry *, const char *);
147 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
148 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
149 struct proc_dir_entry *parent);
151 static inline struct proc_dir_entry *proc_create(const char *name, mode_t mode,
152 struct proc_dir_entry *parent, const struct file_operations *proc_fops)
154 return proc_create_data(name, mode, parent, proc_fops, NULL);
157 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
158 mode_t mode, struct proc_dir_entry *base,
159 read_proc_t *read_proc, void * data)
161 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
163 res->read_proc=read_proc;
169 extern struct proc_dir_entry *proc_net_fops_create(struct net *net,
170 const char *name, mode_t mode, const struct file_operations *fops);
171 extern void proc_net_remove(struct net *net, const char *name);
172 extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
173 struct proc_dir_entry *parent);
175 /* While the {get|set|dup}_mm_exe_file functions are for mm_structs, they are
176 * only needed to implement /proc/<pid>|self/exe so we define them here. */
177 extern void set_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file);
178 extern struct file *get_mm_exe_file(struct mm_struct *mm);
179 extern void dup_mm_exe_file(struct mm_struct *oldmm, struct mm_struct *newmm);
183 #define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; })
184 static inline void proc_net_remove(struct net *net, const char *name) {}
186 static inline void proc_flush_task(struct task_struct *task)
190 static inline struct proc_dir_entry *create_proc_entry(const char *name,
191 mode_t mode, struct proc_dir_entry *parent) { return NULL; }
192 static inline struct proc_dir_entry *proc_create(const char *name,
193 mode_t mode, struct proc_dir_entry *parent,
194 const struct file_operations *proc_fops)
198 static inline struct proc_dir_entry *proc_create_data(const char *name,
199 mode_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;}
211 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
212 mode_t mode, struct proc_dir_entry *base,
213 read_proc_t *read_proc, void * data) { return NULL; }
216 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
217 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
219 static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
224 static inline void pid_ns_release_proc(struct pid_namespace *ns)
228 static inline void set_mm_exe_file(struct mm_struct *mm,
229 struct file *new_exe_file)
232 static inline struct file *get_mm_exe_file(struct mm_struct *mm)
237 static inline void dup_mm_exe_file(struct mm_struct *oldmm,
238 struct mm_struct *newmm)
241 #endif /* CONFIG_PROC_FS */
243 #if !defined(CONFIG_PROC_KCORE)
245 kclist_add(struct kcore_list *new, void *addr, size_t size, int type)
249 extern void kclist_add(struct kcore_list *, void *, size_t, int type);
253 int (*proc_get_link)(struct inode *, struct path *);
254 int (*proc_read)(struct task_struct *task, char *page);
255 int (*proc_show)(struct seq_file *m,
256 struct pid_namespace *ns, struct pid *pid,
257 struct task_struct *task);
260 struct ctl_table_header;
267 struct proc_dir_entry *pde;
268 struct ctl_table_header *sysctl;
269 struct ctl_table *sysctl_entry;
270 struct inode vfs_inode;
273 static inline struct proc_inode *PROC_I(const struct inode *inode)
275 return container_of(inode, struct proc_inode, vfs_inode);
278 static inline struct proc_dir_entry *PDE(const struct inode *inode)
280 return PROC_I(inode)->pde;
283 static inline struct net *PDE_NET(struct proc_dir_entry *pde)
285 return pde->parent->data;
288 struct proc_maps_private {
290 struct task_struct *task;
292 struct vm_area_struct *tail_vma;
296 #endif /* _LINUX_PROC_FS_H */