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>
13 * The proc filesystem constants/structures
17 * Offset of the first process in the /proc root directory..
19 #define FIRST_PROCESS_ENTRY 256
21 /* Worst case buffer size needed for holding an integer. */
22 #define PROC_NUMBUF 13
25 * We always define these enumerators
33 * This is not completely implemented yet. The idea is to
34 * create an in-memory tree (like the actual /proc filesystem
35 * tree) of these proc_dir_entries, so that we can dynamically
36 * add new files to /proc.
38 * The "next" pointer creates a linked list of one /proc directory,
39 * while parent/subdir create the directory structure (every
40 * /proc file has a parent, but "subdir" is NULL for all
41 * non-directory entries).
43 * "get_info" is called at "read", while "owner" is used to protect module
44 * from unloading while proc_dir_entry is in use
47 typedef int (read_proc_t)(char *page, char **start, off_t off,
48 int count, int *eof, void *data);
49 typedef int (write_proc_t)(struct file *file, const char __user *buffer,
50 unsigned long count, void *data);
51 typedef int (get_info_t)(char *, char **, off_t, int);
53 struct proc_dir_entry {
55 unsigned short namelen;
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;
74 struct proc_dir_entry *next, *parent, *subdir;
76 read_proc_t *read_proc;
77 write_proc_t *write_proc;
78 atomic_t count; /* use count */
79 int pde_users; /* number of callers into module in progress */
80 spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
81 struct completion *pde_unload_completion;
85 struct kcore_list *next;
91 struct list_head list;
92 unsigned long long paddr;
93 unsigned long long size;
99 extern struct proc_dir_entry proc_root;
100 extern struct proc_dir_entry *proc_root_fs;
101 extern struct proc_dir_entry *proc_bus;
102 extern struct proc_dir_entry *proc_root_driver;
103 extern struct proc_dir_entry *proc_root_kcore;
105 extern spinlock_t proc_subdir_lock;
107 extern void proc_root_init(void);
108 extern void proc_misc_init(void);
112 void proc_flush_task(struct task_struct *task);
113 struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
114 int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
115 unsigned long task_vsize(struct mm_struct *);
116 int task_statm(struct mm_struct *, int *, int *, int *, int *);
117 void task_mem(struct seq_file *, struct mm_struct *);
118 void clear_refs_smap(struct mm_struct *mm);
120 struct proc_dir_entry *de_get(struct proc_dir_entry *de);
121 void de_put(struct proc_dir_entry *de);
123 extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
124 struct proc_dir_entry *parent);
125 struct proc_dir_entry *proc_create(const char *name, mode_t mode,
126 struct proc_dir_entry *parent,
127 const struct file_operations *proc_fops);
128 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
130 extern struct vfsmount *proc_mnt;
131 struct pid_namespace;
132 extern int proc_fill_super(struct super_block *);
133 extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *);
136 * These are generic /proc routines that use the internal
137 * "struct proc_dir_entry" tree to traverse the filesystem.
139 * The /proc root directory has extended versions to take care
140 * of the /proc/<pid> subdirectories.
142 extern int proc_readdir(struct file *, void *, filldir_t);
143 extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *);
145 extern const struct file_operations proc_kcore_operations;
146 extern const struct file_operations proc_kmsg_operations;
147 extern const struct file_operations ppc_htab_operations;
149 extern int pid_ns_prepare_proc(struct pid_namespace *ns);
150 extern void pid_ns_release_proc(struct pid_namespace *ns);
156 extern void proc_tty_init(void);
157 extern void proc_tty_register_driver(struct tty_driver *driver);
158 extern void proc_tty_unregister_driver(struct tty_driver *driver);
163 #ifdef CONFIG_PROC_DEVICETREE
166 extern void proc_device_tree_init(void);
167 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
168 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
169 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
170 struct property *prop);
171 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
172 struct property *newprop,
173 struct property *oldprop);
174 #endif /* CONFIG_PROC_DEVICETREE */
176 extern struct proc_dir_entry *proc_symlink(const char *,
177 struct proc_dir_entry *, const char *);
178 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
179 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
180 struct proc_dir_entry *parent);
182 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
183 mode_t mode, struct proc_dir_entry *base,
184 read_proc_t *read_proc, void * data)
186 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
188 res->read_proc=read_proc;
194 static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
195 mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
197 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
198 if (res) res->get_info=get_info;
202 extern struct proc_dir_entry *proc_net_fops_create(struct net *net,
203 const char *name, mode_t mode, const struct file_operations *fops);
204 extern void proc_net_remove(struct net *net, const char *name);
205 extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
206 struct proc_dir_entry *parent);
208 /* While the {get|set|dup}_mm_exe_file functions are for mm_structs, they are
209 * only needed to implement /proc/<pid>|self/exe so we define them here. */
210 extern void set_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file);
211 extern struct file *get_mm_exe_file(struct mm_struct *mm);
212 extern void dup_mm_exe_file(struct mm_struct *oldmm, struct mm_struct *newmm);
216 #define proc_root_driver NULL
217 #define proc_bus NULL
219 #define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; })
220 static inline void proc_net_remove(struct net *net, const char *name) {}
222 static inline void proc_flush_task(struct task_struct *task)
226 static inline struct proc_dir_entry *create_proc_entry(const char *name,
227 mode_t mode, struct proc_dir_entry *parent) { return NULL; }
228 static inline struct proc_dir_entry *proc_create(const char *name,
229 mode_t mode, struct proc_dir_entry *parent,
230 const struct file_operations *proc_fops)
234 #define remove_proc_entry(name, parent) do {} while (0)
236 static inline struct proc_dir_entry *proc_symlink(const char *name,
237 struct proc_dir_entry *parent,const char *dest) {return NULL;}
238 static inline struct proc_dir_entry *proc_mkdir(const char *name,
239 struct proc_dir_entry *parent) {return NULL;}
241 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
242 mode_t mode, struct proc_dir_entry *base,
243 read_proc_t *read_proc, void * data) { return NULL; }
244 static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
245 mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
249 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
250 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
252 extern struct proc_dir_entry proc_root;
254 static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
259 static inline void pid_ns_release_proc(struct pid_namespace *ns)
263 static inline void set_mm_exe_file(struct mm_struct *mm,
264 struct file *new_exe_file)
267 static inline struct file *get_mm_exe_file(struct mm_struct *mm)
272 static inline void dup_mm_exe_file(struct mm_struct *oldmm,
273 struct mm_struct *newmm)
276 #endif /* CONFIG_PROC_FS */
278 #if !defined(CONFIG_PROC_KCORE)
279 static inline void kclist_add(struct kcore_list *new, void *addr, size_t size)
283 extern void kclist_add(struct kcore_list *, void *, size_t);
287 int (*proc_get_link)(struct inode *, struct path *);
288 int (*proc_read)(struct task_struct *task, char *page);
289 int (*proc_show)(struct seq_file *m,
290 struct pid_namespace *ns, struct pid *pid,
291 struct task_struct *task);
298 struct proc_dir_entry *pde;
299 struct inode vfs_inode;
302 static inline struct proc_inode *PROC_I(const struct inode *inode)
304 return container_of(inode, struct proc_inode, vfs_inode);
307 static inline struct proc_dir_entry *PDE(const struct inode *inode)
309 return PROC_I(inode)->pde;
312 static inline struct net *PDE_NET(struct proc_dir_entry *pde)
314 return pde->parent->data;
317 struct net *get_proc_net(const struct inode *inode);
319 struct proc_maps_private {
321 struct task_struct *task;
323 struct vm_area_struct *tail_vma;
327 #endif /* _LINUX_PROC_FS_H */