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 * "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);
52 struct proc_dir_entry {
54 unsigned short namelen;
61 const struct inode_operations *proc_iops;
63 * NULL ->proc_fops means "PDE is going away RSN" or
64 * "PDE is just created". In either case, e.g. ->read_proc won't be
65 * called because it's too late or too early, respectively.
67 * If you're allocating ->proc_fops dynamically, save a pointer
70 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 spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
79 struct completion *pde_unload_completion;
83 struct kcore_list *next;
89 struct list_head list;
90 unsigned long long paddr;
91 unsigned long long size;
97 extern struct proc_dir_entry *proc_root_kcore;
99 extern spinlock_t proc_subdir_lock;
101 extern void proc_root_init(void);
102 extern void proc_misc_init(void);
106 void proc_flush_task(struct task_struct *task);
107 struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
108 int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
109 unsigned long task_vsize(struct mm_struct *);
110 int task_statm(struct mm_struct *, int *, int *, int *, int *);
111 void task_mem(struct seq_file *, struct mm_struct *);
112 void clear_refs_smap(struct mm_struct *mm);
114 struct proc_dir_entry *de_get(struct proc_dir_entry *de);
115 void de_put(struct proc_dir_entry *de);
117 extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
118 struct proc_dir_entry *parent);
119 struct proc_dir_entry *proc_create(const char *name, mode_t mode,
120 struct proc_dir_entry *parent,
121 const struct file_operations *proc_fops);
122 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
124 extern struct vfsmount *proc_mnt;
125 struct pid_namespace;
126 extern int proc_fill_super(struct super_block *);
127 extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *);
130 * These are generic /proc routines that use the internal
131 * "struct proc_dir_entry" tree to traverse the filesystem.
133 * The /proc root directory has extended versions to take care
134 * of the /proc/<pid> subdirectories.
136 extern int proc_readdir(struct file *, void *, filldir_t);
137 extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *);
139 extern const struct file_operations proc_kcore_operations;
140 extern const struct file_operations proc_kmsg_operations;
141 extern const struct file_operations ppc_htab_operations;
143 extern int pid_ns_prepare_proc(struct pid_namespace *ns);
144 extern void pid_ns_release_proc(struct pid_namespace *ns);
150 extern void proc_tty_init(void);
151 extern void proc_tty_register_driver(struct tty_driver *driver);
152 extern void proc_tty_unregister_driver(struct tty_driver *driver);
157 #ifdef CONFIG_PROC_DEVICETREE
160 extern void proc_device_tree_init(void);
161 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
162 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
163 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
164 struct property *prop);
165 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
166 struct property *newprop,
167 struct property *oldprop);
168 #endif /* CONFIG_PROC_DEVICETREE */
170 extern struct proc_dir_entry *proc_symlink(const char *,
171 struct proc_dir_entry *, const char *);
172 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
173 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
174 struct proc_dir_entry *parent);
176 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
177 mode_t mode, struct proc_dir_entry *base,
178 read_proc_t *read_proc, void * data)
180 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
182 res->read_proc=read_proc;
188 extern struct proc_dir_entry *proc_net_fops_create(struct net *net,
189 const char *name, mode_t mode, const struct file_operations *fops);
190 extern void proc_net_remove(struct net *net, const char *name);
191 extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
192 struct proc_dir_entry *parent);
194 /* While the {get|set|dup}_mm_exe_file functions are for mm_structs, they are
195 * only needed to implement /proc/<pid>|self/exe so we define them here. */
196 extern void set_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file);
197 extern struct file *get_mm_exe_file(struct mm_struct *mm);
198 extern void dup_mm_exe_file(struct mm_struct *oldmm, struct mm_struct *newmm);
202 #define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; })
203 static inline void proc_net_remove(struct net *net, const char *name) {}
205 static inline void proc_flush_task(struct task_struct *task)
209 static inline struct proc_dir_entry *create_proc_entry(const char *name,
210 mode_t mode, struct proc_dir_entry *parent) { return NULL; }
211 static inline struct proc_dir_entry *proc_create(const char *name,
212 mode_t mode, struct proc_dir_entry *parent,
213 const struct file_operations *proc_fops)
217 #define remove_proc_entry(name, parent) do {} while (0)
219 static inline struct proc_dir_entry *proc_symlink(const char *name,
220 struct proc_dir_entry *parent,const char *dest) {return NULL;}
221 static inline struct proc_dir_entry *proc_mkdir(const char *name,
222 struct proc_dir_entry *parent) {return NULL;}
224 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
225 mode_t mode, struct proc_dir_entry *base,
226 read_proc_t *read_proc, void * data) { return NULL; }
229 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
230 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
232 static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
237 static inline void pid_ns_release_proc(struct pid_namespace *ns)
241 static inline void set_mm_exe_file(struct mm_struct *mm,
242 struct file *new_exe_file)
245 static inline struct file *get_mm_exe_file(struct mm_struct *mm)
250 static inline void dup_mm_exe_file(struct mm_struct *oldmm,
251 struct mm_struct *newmm)
254 #endif /* CONFIG_PROC_FS */
256 #if !defined(CONFIG_PROC_KCORE)
257 static inline void kclist_add(struct kcore_list *new, void *addr, size_t size)
261 extern void kclist_add(struct kcore_list *, void *, size_t);
265 int (*proc_get_link)(struct inode *, struct path *);
266 int (*proc_read)(struct task_struct *task, char *page);
267 int (*proc_show)(struct seq_file *m,
268 struct pid_namespace *ns, struct pid *pid,
269 struct task_struct *task);
276 struct proc_dir_entry *pde;
277 struct inode vfs_inode;
280 static inline struct proc_inode *PROC_I(const struct inode *inode)
282 return container_of(inode, struct proc_inode, vfs_inode);
285 static inline struct proc_dir_entry *PDE(const struct inode *inode)
287 return PROC_I(inode)->pde;
290 static inline struct net *PDE_NET(struct proc_dir_entry *pde)
292 return pde->parent->data;
295 struct net *get_proc_net(const struct inode *inode);
297 struct proc_maps_private {
299 struct task_struct *task;
301 struct vm_area_struct *tail_vma;
305 #endif /* _LINUX_PROC_FS_H */