[deliverable/linux.git] / include / linux / proc_fs.h

#ifndef _LINUX_PROC_FS_H
#define _LINUX_PROC_FS_H

#include <linux/slab.h>
#include <linux/fs.h>
#include <linux/spinlock.h>
#include <linux/magic.h>
#include <linux/atomic.h>

struct net;
struct completion;
struct mm_struct;

/*
 * The proc filesystem constants/structures
 */

/*
 * Offset of the first process in the /proc root directory..
 */
#define FIRST_PROCESS_ENTRY 256

/* Worst case buffer size needed for holding an integer. */
#define PROC_NUMBUF 13

/*
 * We always define these enumerators
 */

enum {
	PROC_ROOT_INO		= 1,
	PROC_IPC_INIT_INO	= 0xEFFFFFFFU,
	PROC_UTS_INIT_INO	= 0xEFFFFFFEU,
	PROC_USER_INIT_INO	= 0xEFFFFFFDU,
	PROC_PID_INIT_INO	= 0xEFFFFFFCU,
};

/*
 * This is not completely implemented yet. The idea is to
 * create an in-memory tree (like the actual /proc filesystem
 * tree) of these proc_dir_entries, so that we can dynamically
 * add new files to /proc.
 *
 * The "next" pointer creates a linked list of one /proc directory,
 * while parent/subdir create the directory structure (every
 * /proc file has a parent, but "subdir" is NULL for all
 * non-directory entries).
 */

typedef	int (read_proc_t)(char *page, char **start, off_t off,
			  int count, int *eof, void *data);
typedef	int (write_proc_t)(struct file *file, const char __user *buffer,
			   unsigned long count, void *data);

struct proc_dir_entry {
	unsigned int low_ino;
	umode_t mode;
	nlink_t nlink;
	kuid_t uid;
	kgid_t gid;
	loff_t size;
	const struct inode_operations *proc_iops;
	/*
	 * NULL ->proc_fops means "PDE is going away RSN" or
	 * "PDE is just created". In either case, e.g. ->read_proc won't be
	 * called because it's too late or too early, respectively.
	 *
	 * If you're allocating ->proc_fops dynamically, save a pointer
	 * somewhere.
	 */
	const struct file_operations *proc_fops;
	struct proc_dir_entry *next, *parent, *subdir;
	void *data;
	read_proc_t *read_proc;
	write_proc_t *write_proc;
	atomic_t count;		/* use count */
	int pde_users;	/* number of callers into module in progress */
	struct completion *pde_unload_completion;
	struct list_head pde_openers;	/* who did ->open, but not ->release */
	spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
	u8 namelen;
	char name[];
};

enum kcore_type {
	KCORE_TEXT,
	KCORE_VMALLOC,
	KCORE_RAM,
	KCORE_VMEMMAP,
	KCORE_OTHER,
};

struct kcore_list {
	struct list_head list;
	unsigned long addr;
	size_t size;
	int type;
};

struct vmcore {
	struct list_head list;
	unsigned long long paddr;
	unsigned long long size;
	loff_t offset;
};

#ifdef CONFIG_PROC_FS

extern void proc_root_init(void);

void proc_flush_task(struct task_struct *task);

extern struct proc_dir_entry *create_proc_entry(const char *name, umode_t mode,
						struct proc_dir_entry *parent);
struct proc_dir_entry *proc_create_data(const char *name, umode_t mode,
				struct proc_dir_entry *parent,
				const struct file_operations *proc_fops,
				void *data);
extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);

struct pid_namespace;

extern int pid_ns_prepare_proc(struct pid_namespace *ns);
extern void pid_ns_release_proc(struct pid_namespace *ns);

/*
 * proc_tty.c
 */
struct tty_driver;
extern void proc_tty_init(void);
extern void proc_tty_register_driver(struct tty_driver *driver);
extern void proc_tty_unregister_driver(struct tty_driver *driver);

/*
 * proc_devtree.c
 */
#ifdef CONFIG_PROC_DEVICETREE
struct device_node;
struct property;
extern void proc_device_tree_init(void);
extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
					 struct property *prop);
extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
					 struct property *newprop,
					 struct property *oldprop);
#endif /* CONFIG_PROC_DEVICETREE */

extern struct proc_dir_entry *proc_symlink(const char *,
		struct proc_dir_entry *, const char *);
extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
extern struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode,
			struct proc_dir_entry *parent);

static inline struct proc_dir_entry *proc_create(const char *name, umode_t mode,
	struct proc_dir_entry *parent, const struct file_operations *proc_fops)
{
	return proc_create_data(name, mode, parent, proc_fops, NULL);
}

static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
	umode_t mode, struct proc_dir_entry *base, 
	read_proc_t *read_proc, void * data)
{
	struct proc_dir_entry *res=create_proc_entry(name,mode,base);
	if (res) {
		res->read_proc=read_proc;
		res->data=data;
	}
	return res;
}
 
extern struct proc_dir_entry *proc_net_fops_create(struct net *net,
	const char *name, umode_t mode, const struct file_operations *fops);
extern void proc_net_remove(struct net *net, const char *name);
extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
	struct proc_dir_entry *parent);

extern struct file *proc_ns_fget(int fd);
extern bool proc_ns_inode(struct inode *inode);

extern int proc_alloc_inum(unsigned int *pino);
extern void proc_free_inum(unsigned int inum);
#else

#define proc_net_fops_create(net, name, mode, fops)  ({ (void)(mode), NULL; })
static inline void proc_net_remove(struct net *net, const char *name) {}

static inline void proc_flush_task(struct task_struct *task)
{
}

static inline struct proc_dir_entry *create_proc_entry(const char *name,
	umode_t mode, struct proc_dir_entry *parent) { return NULL; }
static inline struct proc_dir_entry *proc_create(const char *name,
	umode_t mode, struct proc_dir_entry *parent,
	const struct file_operations *proc_fops)
{
	return NULL;
}
static inline struct proc_dir_entry *proc_create_data(const char *name,
	umode_t mode, struct proc_dir_entry *parent,
	const struct file_operations *proc_fops, void *data)
{
	return NULL;
}
#define remove_proc_entry(name, parent) do {} while (0)

static inline struct proc_dir_entry *proc_symlink(const char *name,
		struct proc_dir_entry *parent,const char *dest) {return NULL;}
static inline struct proc_dir_entry *proc_mkdir(const char *name,
	struct proc_dir_entry *parent) {return NULL;}
static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
	umode_t mode, struct proc_dir_entry *parent) { return NULL; }

static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
	umode_t mode, struct proc_dir_entry *base, 
	read_proc_t *read_proc, void * data) { return NULL; }

struct tty_driver;
static inline void proc_tty_register_driver(struct tty_driver *driver) {};
static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};

static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
{
	return 0;
}

static inline void pid_ns_release_proc(struct pid_namespace *ns)
{
}

static inline struct file *proc_ns_fget(int fd)
{
	return ERR_PTR(-EINVAL);
}

static inline bool proc_ns_inode(struct inode *inode)
{
	return false;
}

static inline int proc_alloc_inum(unsigned int *inum)
{
	*inum = 1;
	return 0;
}
static inline void proc_free_inum(unsigned int inum)
{
}
#endif /* CONFIG_PROC_FS */

#if !defined(CONFIG_PROC_KCORE)
static inline void
kclist_add(struct kcore_list *new, void *addr, size_t size, int type)
{
}
#else
extern void kclist_add(struct kcore_list *, void *, size_t, int type);
#endif

struct nsproxy;
struct proc_ns_operations {
	const char *name;
	int type;
	void *(*get)(struct task_struct *task);
	void (*put)(void *ns);
	int (*install)(struct nsproxy *nsproxy, void *ns);
	unsigned int (*inum)(void *ns);
};
extern const struct proc_ns_operations netns_operations;
extern const struct proc_ns_operations utsns_operations;
extern const struct proc_ns_operations ipcns_operations;
extern const struct proc_ns_operations pidns_operations;
extern const struct proc_ns_operations userns_operations;
extern const struct proc_ns_operations mntns_operations;

union proc_op {
	int (*proc_get_link)(struct dentry *, struct path *);
	int (*proc_read)(struct task_struct *task, char *page);
	int (*proc_show)(struct seq_file *m,
		struct pid_namespace *ns, struct pid *pid,
		struct task_struct *task);
};

struct ctl_table_header;
struct ctl_table;

struct proc_inode {
	struct pid *pid;
	int fd;
	union proc_op op;
	struct proc_dir_entry *pde;
	struct ctl_table_header *sysctl;
	struct ctl_table *sysctl_entry;
	void *ns;
	const struct proc_ns_operations *ns_ops;
	struct inode vfs_inode;
};

static inline struct proc_inode *PROC_I(const struct inode *inode)
{
	return container_of(inode, struct proc_inode, vfs_inode);
}

static inline struct proc_dir_entry *PDE(const struct inode *inode)
{
	return PROC_I(inode)->pde;
}

static inline struct net *PDE_NET(struct proc_dir_entry *pde)
{
	return pde->parent->data;
}

#include <linux/signal.h>

void render_sigset_t(struct seq_file *m, const char *header, sigset_t *set);
#endif /* _LINUX_PROC_FS_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef _LINUX_PROC_FS_H
	2	#define _LINUX_PROC_FS_H
	3
1da177e4 LT	4	#include <linux/slab.h>
1da177e4 LT	5	#include <linux/fs.h>
64a07bd8	6	#include <linux/spinlock.h>
e18fa700	7	#include <linux/magic.h>
60063497	8	#include <linux/atomic.h>
1da177e4	9
457c4cbc	10	struct net;
786d7e16	11	struct completion;
57d3c64f BN	12	struct mm_struct;
57d3c64f BN	13
1da177e4 LT	14	/*
	15	* The proc filesystem constants/structures
	16	*/
	17
	18	/*
	19	* Offset of the first process in the /proc root directory..
	20	*/
	21	#define FIRST_PROCESS_ENTRY 256
	22
f248dcb3 MM	23	/* Worst case buffer size needed for holding an integer. */
f248dcb3 MM	24	#define PROC_NUMBUF 13
1da177e4 LT	25
	26	/*
	27	* We always define these enumerators
	28	*/
	29
	30	enum {
98f842e6 EB	31	PROC_ROOT_INO = 1,
	32	PROC_IPC_INIT_INO = 0xEFFFFFFFU,
	33	PROC_UTS_INIT_INO = 0xEFFFFFFEU,
	34	PROC_USER_INIT_INO = 0xEFFFFFFDU,
	35	PROC_PID_INIT_INO = 0xEFFFFFFCU,
1da177e4 LT	36	};
1da177e4 LT	37
1da177e4 LT	38	/*
	39	* This is not completely implemented yet. The idea is to
	40	* create an in-memory tree (like the actual /proc filesystem
	41	* tree) of these proc_dir_entries, so that we can dynamically
	42	* add new files to /proc.
	43	*
	44	* The "next" pointer creates a linked list of one /proc directory,
	45	* while parent/subdir create the directory structure (every
	46	* /proc file has a parent, but "subdir" is NULL for all
	47	* non-directory entries).
1da177e4 LT	48	*/
	49
	50	typedef int (read_proc_t)(char page, char *start, off_t off,
	51	int count, int eof, void data);
	52	typedef int (write_proc_t)(struct file file, const char __user buffer,
	53	unsigned long count, void *data);
1da177e4 LT	54
	55	struct proc_dir_entry {
	56	unsigned int low_ino;
d161a13f	57	umode_t mode;
1da177e4	58	nlink_t nlink;
dcb0f222 EB	59	kuid_t uid;
dcb0f222 EB	60	kgid_t gid;
22e6c1b3	61	loff_t size;
c5ef1c42	62	const struct inode_operations *proc_iops;
786d7e16 AD	63	/*
	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.
	67	*
	68	* If you're allocating ->proc_fops dynamically, save a pointer
	69	* somewhere.
	70	*/
c5ef1c42	71	const struct file_operations *proc_fops;
1da177e4 LT	72	struct proc_dir_entry next, parent, *subdir;
	73	void *data;
	74	read_proc_t *read_proc;
	75	write_proc_t *write_proc;
	76	atomic_t count; /* use count */
786d7e16	77	int pde_users; /* number of callers into module in progress */
786d7e16	78	struct completion *pde_unload_completion;
881adb85	79	struct list_head pde_openers; /* who did ->open, but not ->release */
09570f91 DH	80	spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
	81	u8 namelen;
	82	char name[];
1da177e4 LT	83	};
1da177e4 LT	84
c30bb2a2 KH	85	enum kcore_type {
	86	KCORE_TEXT,
	87	KCORE_VMALLOC,
	88	KCORE_RAM,
26562c59	89	KCORE_VMEMMAP,
c30bb2a2 KH	90	KCORE_OTHER,
	91	};
	92
1da177e4	93	struct kcore_list {
2ef43ec7	94	struct list_head list;
1da177e4 LT	95	unsigned long addr;
1da177e4 LT	96	size_t size;
c30bb2a2	97	int type;
1da177e4 LT	98	};
1da177e4 LT	99
666bfddb VG	100	struct vmcore {
	101	struct list_head list;
	102	unsigned long long paddr;
80e8ff63	103	unsigned long long size;
666bfddb VG	104	loff_t offset;
	105	};
	106
1da177e4 LT	107	#ifdef CONFIG_PROC_FS
1da177e4 LT	108
1da177e4	109	extern void proc_root_init(void);
1da177e4	110
48e6484d	111	void proc_flush_task(struct task_struct *task);
7695650a	112
d161a13f	113	extern struct proc_dir_entry create_proc_entry(const char name, umode_t mode,
1da177e4	114	struct proc_dir_entry *parent);
d161a13f	115	struct proc_dir_entry proc_create_data(const char name, umode_t mode,
2d3a4e36	116	struct proc_dir_entry *parent,
59b74351 DL	117	const struct file_operations *proc_fops,
59b74351 DL	118	void *data);
1da177e4 LT	119	extern void remove_proc_entry(const char name, struct proc_dir_entry parent);
1da177e4 LT	120
07543f5c	121	struct pid_namespace;
1da177e4	122
6f4e6433 PE	123	extern int pid_ns_prepare_proc(struct pid_namespace *ns);
	124	extern void pid_ns_release_proc(struct pid_namespace *ns);
	125
1da177e4 LT	126	/*
	127	* proc_tty.c
	128	*/
	129	struct tty_driver;
	130	extern void proc_tty_init(void);
	131	extern void proc_tty_register_driver(struct tty_driver *driver);
	132	extern void proc_tty_unregister_driver(struct tty_driver *driver);
	133
	134	/*
	135	* proc_devtree.c
	136	*/
183d0202	137	#ifdef CONFIG_PROC_DEVICETREE
1da177e4	138	struct device_node;
183d0202	139	struct property;
1da177e4	140	extern void proc_device_tree_init(void);
1da177e4	141	extern void proc_device_tree_add_node(struct device_node , struct proc_dir_entry );
183d0202	142	extern void proc_device_tree_add_prop(struct proc_dir_entry pde, struct property prop);
898b5395 DB	143	extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
	144	struct property *prop);
	145	extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
	146	struct property *newprop,
	147	struct property *oldprop);
1da177e4 LT	148	#endif /* CONFIG_PROC_DEVICETREE */
	149
	150	extern struct proc_dir_entry proc_symlink(const char ,
	151	struct proc_dir_entry , const char );
	152	extern struct proc_dir_entry proc_mkdir(const char ,struct proc_dir_entry *);
d161a13f	153	extern struct proc_dir_entry proc_mkdir_mode(const char name, umode_t mode,
1da177e4 LT	154	struct proc_dir_entry *parent);
1da177e4 LT	155
d161a13f	156	static inline struct proc_dir_entry proc_create(const char name, umode_t mode,
59b74351 DL	157	struct proc_dir_entry parent, const struct file_operations proc_fops)
	158	{
	159	return proc_create_data(name, mode, parent, proc_fops, NULL);
	160	}
	161
1da177e4	162	static inline struct proc_dir_entry create_proc_read_entry(const char name,
d161a13f	163	umode_t mode, struct proc_dir_entry *base,
1da177e4 LT	164	read_proc_t read_proc, void data)
	165	{
	166	struct proc_dir_entry *res=create_proc_entry(name,mode,base);
	167	if (res) {
	168	res->read_proc=read_proc;
	169	res->data=data;
	170	}
	171	return res;
	172	}
	173
457c4cbc	174	extern struct proc_dir_entry proc_net_fops_create(struct net net,
d161a13f	175	const char name, umode_t mode, const struct file_operations fops);
457c4cbc	176	extern void proc_net_remove(struct net net, const char name);
e5d69b9f DL	177	extern struct proc_dir_entry proc_net_mkdir(struct net net, const char *name,
e5d69b9f DL	178	struct proc_dir_entry *parent);
1da177e4	179
6b4e306a	180	extern struct file *proc_ns_fget(int fd);
8823c079	181	extern bool proc_ns_inode(struct inode *inode);
6b4e306a	182
33d6dce6 EB	183	extern int proc_alloc_inum(unsigned int *pino);
33d6dce6 EB	184	extern void proc_free_inum(unsigned int inum);
1da177e4 LT	185	#else
1da177e4 LT	186
457c4cbc	187	#define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; })
457c4cbc	188	static inline void proc_net_remove(struct net net, const char name) {}
1da177e4	189
60347f67 PE	190	static inline void proc_flush_task(struct task_struct *task)
	191	{
	192	}
1da177e4 LT	193
1da177e4 LT	194	static inline struct proc_dir_entry create_proc_entry(const char name,
d161a13f	195	umode_t mode, struct proc_dir_entry *parent) { return NULL; }
2d3a4e36	196	static inline struct proc_dir_entry proc_create(const char name,
d161a13f	197	umode_t mode, struct proc_dir_entry *parent,
2d3a4e36 AD	198	const struct file_operations *proc_fops)
	199	{
	200	return NULL;
	201	}
59b74351	202	static inline struct proc_dir_entry proc_create_data(const char name,
d161a13f	203	umode_t mode, struct proc_dir_entry *parent,
59b74351 DL	204	const struct file_operations proc_fops, void data)
	205	{
	206	return NULL;
	207	}
1da177e4 LT	208	#define remove_proc_entry(name, parent) do {} while (0)
	209
	210	static inline struct proc_dir_entry proc_symlink(const char name,
	211	struct proc_dir_entry parent,const char dest) {return NULL;}
	212	static inline struct proc_dir_entry proc_mkdir(const char name,
	213	struct proc_dir_entry *parent) {return NULL;}
f12a20fc	214	static inline struct proc_dir_entry proc_mkdir_mode(const char name,
d161a13f	215	umode_t mode, struct proc_dir_entry *parent) { return NULL; }
1da177e4 LT	216
1da177e4 LT	217	static inline struct proc_dir_entry create_proc_read_entry(const char name,
d161a13f	218	umode_t mode, struct proc_dir_entry *base,
1da177e4	219	read_proc_t read_proc, void data) { return NULL; }
1da177e4 LT	220
	221	struct tty_driver;
	222	static inline void proc_tty_register_driver(struct tty_driver *driver) {};
	223	static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
	224
6f4e6433 PE	225	static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
	226	{
	227	return 0;
	228	}
	229
	230	static inline void pid_ns_release_proc(struct pid_namespace *ns)
	231	{
	232	}
	233
6b4e306a EB	234	static inline struct file *proc_ns_fget(int fd)
	235	{
	236	return ERR_PTR(-EINVAL);
	237	}
	238
8823c079 EB	239	static inline bool proc_ns_inode(struct inode *inode)
	240	{
	241	return false;
	242	}
	243
33d6dce6 EB	244	static inline int proc_alloc_inum(unsigned int *inum)
	245	{
	246	*inum = 1;
	247	return 0;
	248	}
	249	static inline void proc_free_inum(unsigned int inum)
	250	{
	251	}
1da177e4 LT	252	#endif /* CONFIG_PROC_FS */
	253
	254	#if !defined(CONFIG_PROC_KCORE)
c30bb2a2 KH	255	static inline void
c30bb2a2 KH	256	kclist_add(struct kcore_list new, void addr, size_t size, int type)
1da177e4 LT	257	{
	258	}
	259	#else
c30bb2a2	260	extern void kclist_add(struct kcore_list , void , size_t, int type);
1da177e4 LT	261	#endif
1da177e4 LT	262
6b4e306a EB	263	struct nsproxy;
	264	struct proc_ns_operations {
	265	const char *name;
	266	int type;
	267	void (get)(struct task_struct *task);
	268	void (put)(void ns);
	269	int (install)(struct nsproxy nsproxy, void *ns);
98f842e6	270	unsigned int (inum)(void ns);
6b4e306a	271	};
13b6f576	272	extern const struct proc_ns_operations netns_operations;
34482e89	273	extern const struct proc_ns_operations utsns_operations;
a00eaf11	274	extern const struct proc_ns_operations ipcns_operations;
57e8391d	275	extern const struct proc_ns_operations pidns_operations;
cde1975b	276	extern const struct proc_ns_operations userns_operations;
8823c079	277	extern const struct proc_ns_operations mntns_operations;
6b4e306a	278
20cdc894	279	union proc_op {
7773fbc5	280	int (proc_get_link)(struct dentry , struct path *);
20cdc894	281	int (proc_read)(struct task_struct task, char *page);
be614086 EB	282	int (proc_show)(struct seq_file m,
	283	struct pid_namespace ns, struct pid pid,
	284	struct task_struct *task);
20cdc894 EB	285	};
20cdc894 EB	286
9043476f AV	287	struct ctl_table_header;
	288	struct ctl_table;
	289
1da177e4	290	struct proc_inode {
13b41b09	291	struct pid *pid;
aed7a6c4	292	int fd;
20cdc894	293	union proc_op op;
1da177e4	294	struct proc_dir_entry *pde;
9043476f AV	295	struct ctl_table_header *sysctl;
9043476f AV	296	struct ctl_table *sysctl_entry;
6b4e306a EB	297	void *ns;
6b4e306a EB	298	const struct proc_ns_operations *ns_ops;
1da177e4 LT	299	struct inode vfs_inode;
	300	};
	301
	302	static inline struct proc_inode PROC_I(const struct inode inode)
	303	{
	304	return container_of(inode, struct proc_inode, vfs_inode);
	305	}
	306
	307	static inline struct proc_dir_entry PDE(const struct inode inode)
	308	{
	309	return PROC_I(inode)->pde;
	310	}
	311
457c4cbc EB	312	static inline struct net PDE_NET(struct proc_dir_entry pde)
	313	{
	314	return pde->parent->data;
	315	}
	316
138d22b5 CG	317	#include <linux/signal.h>
	318
	319	void render_sigset_t(struct seq_file m, const char header, sigset_t *set);
1da177e4	320	#endif /* _LINUX_PROC_FS_H */