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>
14 * The proc filesystem constants/structures
18 * Offset of the first process in the /proc root directory..
20 #define FIRST_PROCESS_ENTRY 256
22 /* Worst case buffer size needed for holding an integer. */
23 #define PROC_NUMBUF 13
26 * We always define these enumerators
34 * This is not completely implemented yet. The idea is to
35 * create an in-memory tree (like the actual /proc filesystem
36 * tree) of these proc_dir_entries, so that we can dynamically
37 * add new files to /proc.
39 * The "next" pointer creates a linked list of one /proc directory,
40 * while parent/subdir create the directory structure (every
41 * /proc file has a parent, but "subdir" is NULL for all
42 * non-directory entries).
44 * "get_info" is called at "read", while "owner" is used to protect module
45 * from unloading while proc_dir_entry is in use
48 typedef int (read_proc_t)(char *page, char **start, off_t off,
49 int count, int *eof, void *data);
50 typedef int (write_proc_t)(struct file *file, const char __user *buffer,
51 unsigned long count, void *data);
52 typedef int (get_info_t)(char *, char **, off_t, int);
53 typedef struct proc_dir_entry *(shadow_proc_t)(struct task_struct *task,
54 struct proc_dir_entry *pde);
56 struct proc_dir_entry {
58 unsigned short namelen;
65 const struct inode_operations *proc_iops;
67 * NULL ->proc_fops means "PDE is going away RSN" or
68 * "PDE is just created". In either case, e.g. ->read_proc won't be
69 * called because it's too late or too early, respectively.
71 * If you're allocating ->proc_fops dynamically, save a pointer
74 const struct file_operations *proc_fops;
77 struct proc_dir_entry *next, *parent, *subdir;
79 read_proc_t *read_proc;
80 write_proc_t *write_proc;
81 atomic_t count; /* use count */
82 int pde_users; /* number of callers into module in progress */
83 spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
84 struct completion *pde_unload_completion;
85 shadow_proc_t *shadow_proc;
89 struct kcore_list *next;
95 struct list_head list;
96 unsigned long long paddr;
97 unsigned long long size;
101 #ifdef CONFIG_PROC_FS
103 extern struct proc_dir_entry proc_root;
104 extern struct proc_dir_entry *proc_root_fs;
105 extern struct proc_dir_entry *proc_bus;
106 extern struct proc_dir_entry *proc_root_driver;
107 extern struct proc_dir_entry *proc_root_kcore;
109 extern spinlock_t proc_subdir_lock;
111 extern void proc_root_init(void);
112 extern void proc_misc_init(void);
116 void proc_flush_task(struct task_struct *task);
117 struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
118 int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
119 unsigned long task_vsize(struct mm_struct *);
120 int task_statm(struct mm_struct *, int *, int *, int *, int *);
121 char *task_mem(struct mm_struct *, char *);
123 struct proc_dir_entry *de_get(struct proc_dir_entry *de);
124 void de_put(struct proc_dir_entry *de);
126 extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
127 struct proc_dir_entry *parent);
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);
210 #define proc_root_driver NULL
211 #define proc_bus NULL
213 #define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; })
214 static inline void proc_net_remove(struct net *net, const char *name) {}
216 static inline void proc_flush_task(struct task_struct *task)
220 static inline struct proc_dir_entry *create_proc_entry(const char *name,
221 mode_t mode, struct proc_dir_entry *parent) { return NULL; }
223 #define remove_proc_entry(name, parent) do {} while (0)
225 static inline struct proc_dir_entry *proc_symlink(const char *name,
226 struct proc_dir_entry *parent,const char *dest) {return NULL;}
227 static inline struct proc_dir_entry *proc_mkdir(const char *name,
228 struct proc_dir_entry *parent) {return NULL;}
230 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
231 mode_t mode, struct proc_dir_entry *base,
232 read_proc_t *read_proc, void * data) { return NULL; }
233 static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
234 mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
238 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
239 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
241 extern struct proc_dir_entry proc_root;
243 static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
248 static inline void pid_ns_release_proc(struct pid_namespace *ns)
252 #endif /* CONFIG_PROC_FS */
254 #if !defined(CONFIG_PROC_KCORE)
255 static inline void kclist_add(struct kcore_list *new, void *addr, size_t size)
259 extern void kclist_add(struct kcore_list *, void *, size_t);
263 int (*proc_get_link)(struct inode *, struct dentry **, struct vfsmount **);
264 int (*proc_read)(struct task_struct *task, char *page);
271 struct proc_dir_entry *pde;
272 struct inode vfs_inode;
275 static inline struct proc_inode *PROC_I(const struct inode *inode)
277 return container_of(inode, struct proc_inode, vfs_inode);
280 static inline struct proc_dir_entry *PDE(const struct inode *inode)
282 return PROC_I(inode)->pde;
285 static inline struct net *PDE_NET(struct proc_dir_entry *pde)
287 return pde->parent->data;
290 struct net *get_proc_net(const struct inode *inode);
292 struct proc_maps_private {
294 struct task_struct *task;
296 struct vm_area_struct *tail_vma;
300 #endif /* _LINUX_PROC_FS_H */