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
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 {
58 const struct inode_operations *proc_iops;
60 * NULL ->proc_fops means "PDE is going away RSN" or
61 * "PDE is just created". In either case, e.g. ->read_proc won't be
62 * called because it's too late or too early, respectively.
64 * If you're allocating ->proc_fops dynamically, save a pointer
67 const struct file_operations *proc_fops;
68 struct proc_dir_entry *next, *parent, *subdir;
70 read_proc_t *read_proc;
71 write_proc_t *write_proc;
72 atomic_t count; /* use count */
73 int pde_users; /* number of callers into module in progress */
74 struct completion *pde_unload_completion;
75 struct list_head pde_openers; /* who did ->open, but not ->release */
76 spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
90 struct list_head list;
97 struct list_head list;
98 unsigned long long paddr;
99 unsigned long long size;
103 #ifdef CONFIG_PROC_FS
105 extern void proc_root_init(void);
106 extern void proc_breakme_init(void);
108 void proc_flush_task(struct task_struct *task);
110 extern struct proc_dir_entry *create_proc_entry(const char *name, umode_t mode,
111 struct proc_dir_entry *parent);
112 struct proc_dir_entry *proc_create_data(const char *name, umode_t mode,
113 struct proc_dir_entry *parent,
114 const struct file_operations *proc_fops,
116 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
118 struct pid_namespace;
120 extern int pid_ns_prepare_proc(struct pid_namespace *ns);
121 extern void pid_ns_release_proc(struct pid_namespace *ns);
127 extern void proc_tty_init(void);
128 extern void proc_tty_register_driver(struct tty_driver *driver);
129 extern void proc_tty_unregister_driver(struct tty_driver *driver);
134 #ifdef CONFIG_PROC_DEVICETREE
137 extern void proc_device_tree_init(void);
138 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
139 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
140 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
141 struct property *prop);
142 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
143 struct property *newprop,
144 struct property *oldprop);
145 #endif /* CONFIG_PROC_DEVICETREE */
147 extern struct proc_dir_entry *proc_symlink(const char *,
148 struct proc_dir_entry *, const char *);
149 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
150 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode,
151 struct proc_dir_entry *parent);
153 static inline struct proc_dir_entry *proc_create(const char *name, umode_t mode,
154 struct proc_dir_entry *parent, const struct file_operations *proc_fops)
156 return proc_create_data(name, mode, parent, proc_fops, NULL);
159 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
160 umode_t mode, struct proc_dir_entry *base,
161 read_proc_t *read_proc, void * data)
163 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
165 res->read_proc=read_proc;
171 extern struct proc_dir_entry *proc_net_fops_create(struct net *net,
172 const char *name, umode_t mode, const struct file_operations *fops);
173 extern void proc_net_remove(struct net *net, const char *name);
174 extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
175 struct proc_dir_entry *parent);
177 extern struct file *proc_ns_fget(int fd);
181 #define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; })
182 static inline void proc_net_remove(struct net *net, const char *name) {}
184 static inline void proc_flush_task(struct task_struct *task)
188 static inline struct proc_dir_entry *create_proc_entry(const char *name,
189 umode_t mode, struct proc_dir_entry *parent) { return NULL; }
190 static inline struct proc_dir_entry *proc_create(const char *name,
191 umode_t mode, struct proc_dir_entry *parent,
192 const struct file_operations *proc_fops)
196 static inline struct proc_dir_entry *proc_create_data(const char *name,
197 umode_t mode, struct proc_dir_entry *parent,
198 const struct file_operations *proc_fops, void *data)
202 #define remove_proc_entry(name, parent) do {} while (0)
204 static inline struct proc_dir_entry *proc_symlink(const char *name,
205 struct proc_dir_entry *parent,const char *dest) {return NULL;}
206 static inline struct proc_dir_entry *proc_mkdir(const char *name,
207 struct proc_dir_entry *parent) {return NULL;}
208 static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
209 umode_t mode, struct proc_dir_entry *parent) { return NULL; }
211 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
212 umode_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 struct file *proc_ns_fget(int fd)
230 return ERR_PTR(-EINVAL);
233 #endif /* CONFIG_PROC_FS */
235 #if !defined(CONFIG_PROC_KCORE)
237 kclist_add(struct kcore_list *new, void *addr, size_t size, int type)
241 extern void kclist_add(struct kcore_list *, void *, size_t, int type);
245 struct proc_ns_operations {
248 void *(*get)(struct task_struct *task);
249 void (*put)(void *ns);
250 int (*install)(struct nsproxy *nsproxy, void *ns);
252 extern const struct proc_ns_operations netns_operations;
253 extern const struct proc_ns_operations utsns_operations;
254 extern const struct proc_ns_operations ipcns_operations;
257 int (*proc_get_link)(struct dentry *, struct path *);
258 int (*proc_read)(struct task_struct *task, char *page);
259 int (*proc_show)(struct seq_file *m,
260 struct pid_namespace *ns, struct pid *pid,
261 struct task_struct *task);
264 struct ctl_table_header;
271 struct proc_dir_entry *pde;
272 struct ctl_table_header *sysctl;
273 struct ctl_table *sysctl_entry;
275 const struct proc_ns_operations *ns_ops;
276 struct inode vfs_inode;
279 static inline struct proc_inode *PROC_I(const struct inode *inode)
281 return container_of(inode, struct proc_inode, vfs_inode);
284 static inline struct proc_dir_entry *PDE(const struct inode *inode)
286 return PROC_I(inode)->pde;
289 static inline struct net *PDE_NET(struct proc_dir_entry *pde)
291 return pde->parent->data;
294 #endif /* _LINUX_PROC_FS_H */