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 {
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 */
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);
107 void proc_flush_task(struct task_struct *task);
109 extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
110 struct proc_dir_entry *parent);
111 struct proc_dir_entry *proc_create_data(const char *name, mode_t mode,
112 struct proc_dir_entry *parent,
113 const struct file_operations *proc_fops,
115 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
117 struct pid_namespace;
119 extern int pid_ns_prepare_proc(struct pid_namespace *ns);
120 extern void pid_ns_release_proc(struct pid_namespace *ns);
126 extern void proc_tty_init(void);
127 extern void proc_tty_register_driver(struct tty_driver *driver);
128 extern void proc_tty_unregister_driver(struct tty_driver *driver);
133 #ifdef CONFIG_PROC_DEVICETREE
136 extern void proc_device_tree_init(void);
137 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
138 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
139 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
140 struct property *prop);
141 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
142 struct property *newprop,
143 struct property *oldprop);
144 #endif /* CONFIG_PROC_DEVICETREE */
146 extern struct proc_dir_entry *proc_symlink(const char *,
147 struct proc_dir_entry *, const char *);
148 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
149 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
150 struct proc_dir_entry *parent);
152 static inline struct proc_dir_entry *proc_create(const char *name, mode_t mode,
153 struct proc_dir_entry *parent, const struct file_operations *proc_fops)
155 return proc_create_data(name, mode, parent, proc_fops, NULL);
158 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
159 mode_t mode, struct proc_dir_entry *base,
160 read_proc_t *read_proc, void * data)
162 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
164 res->read_proc=read_proc;
170 extern struct proc_dir_entry *proc_net_fops_create(struct net *net,
171 const char *name, mode_t mode, const struct file_operations *fops);
172 extern void proc_net_remove(struct net *net, const char *name);
173 extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
174 struct proc_dir_entry *parent);
176 extern struct file *proc_ns_fget(int fd);
180 #define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; })
181 static inline void proc_net_remove(struct net *net, const char *name) {}
183 static inline void proc_flush_task(struct task_struct *task)
187 static inline struct proc_dir_entry *create_proc_entry(const char *name,
188 mode_t mode, struct proc_dir_entry *parent) { return NULL; }
189 static inline struct proc_dir_entry *proc_create(const char *name,
190 mode_t mode, struct proc_dir_entry *parent,
191 const struct file_operations *proc_fops)
195 static inline struct proc_dir_entry *proc_create_data(const char *name,
196 mode_t mode, struct proc_dir_entry *parent,
197 const struct file_operations *proc_fops, void *data)
201 #define remove_proc_entry(name, parent) do {} while (0)
203 static inline struct proc_dir_entry *proc_symlink(const char *name,
204 struct proc_dir_entry *parent,const char *dest) {return NULL;}
205 static inline struct proc_dir_entry *proc_mkdir(const char *name,
206 struct proc_dir_entry *parent) {return NULL;}
207 static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
208 mode_t mode, struct proc_dir_entry *parent) { return NULL; }
210 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
211 mode_t mode, struct proc_dir_entry *base,
212 read_proc_t *read_proc, void * data) { return NULL; }
215 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
216 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
218 static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
223 static inline void pid_ns_release_proc(struct pid_namespace *ns)
227 static inline struct file *proc_ns_fget(int fd)
229 return ERR_PTR(-EINVAL);
232 #endif /* CONFIG_PROC_FS */
234 #if !defined(CONFIG_PROC_KCORE)
236 kclist_add(struct kcore_list *new, void *addr, size_t size, int type)
240 extern void kclist_add(struct kcore_list *, void *, size_t, int type);
244 struct proc_ns_operations {
247 void *(*get)(struct task_struct *task);
248 void (*put)(void *ns);
249 int (*install)(struct nsproxy *nsproxy, void *ns);
251 extern const struct proc_ns_operations netns_operations;
252 extern const struct proc_ns_operations utsns_operations;
253 extern const struct proc_ns_operations ipcns_operations;
256 int (*proc_get_link)(struct inode *, struct path *);
257 int (*proc_read)(struct task_struct *task, char *page);
258 int (*proc_show)(struct seq_file *m,
259 struct pid_namespace *ns, struct pid *pid,
260 struct task_struct *task);
263 struct ctl_table_header;
270 struct proc_dir_entry *pde;
271 struct ctl_table_header *sysctl;
272 struct ctl_table *sysctl_entry;
274 const struct proc_ns_operations *ns_ops;
275 struct inode vfs_inode;
278 static inline struct proc_inode *PROC_I(const struct inode *inode)
280 return container_of(inode, struct proc_inode, vfs_inode);
283 static inline struct proc_dir_entry *PDE(const struct inode *inode)
285 return PROC_I(inode)->pde;
288 static inline struct net *PDE_NET(struct proc_dir_entry *pde)
290 return pde->parent->data;
293 #endif /* _LINUX_PROC_FS_H */