[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 <asm/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,
};

/*
 * 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;
	unsigned short namelen;
	const char *name;
	mode_t mode;
	nlink_t nlink;
	uid_t uid;
	gid_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 */
	spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
	struct completion *pde_unload_completion;
	struct list_head pde_openers;	/* who did ->open, but not ->release */
};

struct kcore_list {
	struct kcore_list *next;
	unsigned long addr;
	size_t size;
};

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, mode_t mode,
						struct proc_dir_entry *parent);
struct proc_dir_entry *proc_create_data(const char *name, mode_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, mode_t mode,
			struct proc_dir_entry *parent);

static inline struct proc_dir_entry *proc_create(const char *name, mode_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,
	mode_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, mode_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);

/* While the {get|set|dup}_mm_exe_file functions are for mm_structs, they are
 * only needed to implement /proc/<pid>|self/exe so we define them here. */
extern void set_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file);
extern struct file *get_mm_exe_file(struct mm_struct *mm);
extern void dup_mm_exe_file(struct mm_struct *oldmm, struct mm_struct *newmm);

#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,
	mode_t mode, struct proc_dir_entry *parent) { return NULL; }
static inline struct proc_dir_entry *proc_create(const char *name,
	mode_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,
	mode_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 *create_proc_read_entry(const char *name,
	mode_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 void set_mm_exe_file(struct mm_struct *mm,
				   struct file *new_exe_file)
{}

static inline struct file *get_mm_exe_file(struct mm_struct *mm)
{
	return NULL;
}

static inline void dup_mm_exe_file(struct mm_struct *oldmm,
	       			   struct mm_struct *newmm)
{}

#endif /* CONFIG_PROC_FS */

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

union proc_op {
	int (*proc_get_link)(struct inode *, 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;
	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;
}

struct proc_maps_private {
	struct pid *pid;
	struct task_struct *task;
#ifdef CONFIG_MMU
	struct vm_area_struct *tail_vma;
#endif
};

#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>
1da177e4 LT	8	#include <asm/atomic.h>
1da177e4 LT	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 {
	31	PROC_ROOT_INO = 1,
	32	};
	33
1da177e4 LT	34	/*
	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.
	39	*
	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).
1da177e4 LT	44	*/
	45
	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);
1da177e4 LT	50
	51	struct proc_dir_entry {
	52	unsigned int low_ino;
	53	unsigned short namelen;
	54	const char *name;
	55	mode_t mode;
	56	nlink_t nlink;
	57	uid_t uid;
	58	gid_t gid;
22e6c1b3	59	loff_t size;
c5ef1c42	60	const struct inode_operations *proc_iops;
786d7e16 AD	61	/*
	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.
	65	*
	66	* If you're allocating ->proc_fops dynamically, save a pointer
	67	* somewhere.
	68	*/
c5ef1c42	69	const struct file_operations *proc_fops;
1da177e4 LT	70	struct proc_dir_entry next, parent, *subdir;
	71	void *data;
	72	read_proc_t *read_proc;
	73	write_proc_t *write_proc;
	74	atomic_t count; /* use count */
786d7e16 AD	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;
881adb85	78	struct list_head pde_openers; /* who did ->open, but not ->release */
1da177e4 LT	79	};
	80
	81	struct kcore_list {
	82	struct kcore_list *next;
	83	unsigned long addr;
	84	size_t size;
	85	};
	86
666bfddb VG	87	struct vmcore {
	88	struct list_head list;
	89	unsigned long long paddr;
80e8ff63	90	unsigned long long size;
666bfddb VG	91	loff_t offset;
	92	};
	93
1da177e4 LT	94	#ifdef CONFIG_PROC_FS
1da177e4 LT	95
1da177e4	96	extern void proc_root_init(void);
1da177e4	97
48e6484d	98	void proc_flush_task(struct task_struct *task);
7695650a	99
1da177e4 LT	100	extern struct proc_dir_entry create_proc_entry(const char name, mode_t mode,
1da177e4 LT	101	struct proc_dir_entry *parent);
59b74351	102	struct proc_dir_entry proc_create_data(const char name, mode_t mode,
2d3a4e36	103	struct proc_dir_entry *parent,
59b74351 DL	104	const struct file_operations *proc_fops,
59b74351 DL	105	void *data);
1da177e4 LT	106	extern void remove_proc_entry(const char name, struct proc_dir_entry parent);
1da177e4 LT	107
07543f5c	108	struct pid_namespace;
1da177e4	109
6f4e6433 PE	110	extern int pid_ns_prepare_proc(struct pid_namespace *ns);
	111	extern void pid_ns_release_proc(struct pid_namespace *ns);
	112
1da177e4 LT	113	/*
	114	* proc_tty.c
	115	*/
	116	struct tty_driver;
	117	extern void proc_tty_init(void);
	118	extern void proc_tty_register_driver(struct tty_driver *driver);
	119	extern void proc_tty_unregister_driver(struct tty_driver *driver);
	120
	121	/*
	122	* proc_devtree.c
	123	*/
183d0202	124	#ifdef CONFIG_PROC_DEVICETREE
1da177e4	125	struct device_node;
183d0202	126	struct property;
1da177e4	127	extern void proc_device_tree_init(void);
1da177e4	128	extern void proc_device_tree_add_node(struct device_node , struct proc_dir_entry );
183d0202	129	extern void proc_device_tree_add_prop(struct proc_dir_entry pde, struct property prop);
898b5395 DB	130	extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
	131	struct property *prop);
	132	extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
	133	struct property *newprop,
	134	struct property *oldprop);
1da177e4 LT	135	#endif /* CONFIG_PROC_DEVICETREE */
	136
	137	extern struct proc_dir_entry proc_symlink(const char ,
	138	struct proc_dir_entry , const char );
	139	extern struct proc_dir_entry proc_mkdir(const char ,struct proc_dir_entry *);
	140	extern struct proc_dir_entry proc_mkdir_mode(const char name, mode_t mode,
	141	struct proc_dir_entry *parent);
	142
59b74351 DL	143	static inline struct proc_dir_entry proc_create(const char name, mode_t mode,
	144	struct proc_dir_entry parent, const struct file_operations proc_fops)
	145	{
	146	return proc_create_data(name, mode, parent, proc_fops, NULL);
	147	}
	148
1da177e4 LT	149	static inline struct proc_dir_entry create_proc_read_entry(const char name,
	150	mode_t mode, struct proc_dir_entry *base,
	151	read_proc_t read_proc, void data)
	152	{
	153	struct proc_dir_entry *res=create_proc_entry(name,mode,base);
	154	if (res) {
	155	res->read_proc=read_proc;
	156	res->data=data;
	157	}
	158	return res;
	159	}
	160
457c4cbc EB	161	extern struct proc_dir_entry proc_net_fops_create(struct net net,
	162	const char name, mode_t mode, const struct file_operations fops);
	163	extern void proc_net_remove(struct net net, const char name);
e5d69b9f DL	164	extern struct proc_dir_entry proc_net_mkdir(struct net net, const char *name,
e5d69b9f DL	165	struct proc_dir_entry *parent);
1da177e4	166
925d1c40 MH	167	/* While the {get\|set\|dup}_mm_exe_file functions are for mm_structs, they are
	168	* only needed to implement /proc/<pid>\|self/exe so we define them here. */
	169	extern void set_mm_exe_file(struct mm_struct mm, struct file new_exe_file);
	170	extern struct file get_mm_exe_file(struct mm_struct mm);
	171	extern void dup_mm_exe_file(struct mm_struct oldmm, struct mm_struct newmm);
	172
1da177e4 LT	173	#else
1da177e4 LT	174
457c4cbc	175	#define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; })
457c4cbc	176	static inline void proc_net_remove(struct net net, const char name) {}
1da177e4	177
60347f67 PE	178	static inline void proc_flush_task(struct task_struct *task)
	179	{
	180	}
1da177e4 LT	181
	182	static inline struct proc_dir_entry create_proc_entry(const char name,
	183	mode_t mode, struct proc_dir_entry *parent) { return NULL; }
2d3a4e36 AD	184	static inline struct proc_dir_entry proc_create(const char name,
	185	mode_t mode, struct proc_dir_entry *parent,
	186	const struct file_operations *proc_fops)
	187	{
	188	return NULL;
	189	}
59b74351 DL	190	static inline struct proc_dir_entry proc_create_data(const char name,
	191	mode_t mode, struct proc_dir_entry *parent,
	192	const struct file_operations proc_fops, void data)
	193	{
	194	return NULL;
	195	}
1da177e4 LT	196	#define remove_proc_entry(name, parent) do {} while (0)
	197
	198	static inline struct proc_dir_entry proc_symlink(const char name,
	199	struct proc_dir_entry parent,const char dest) {return NULL;}
	200	static inline struct proc_dir_entry proc_mkdir(const char name,
	201	struct proc_dir_entry *parent) {return NULL;}
	202
	203	static inline struct proc_dir_entry create_proc_read_entry(const char name,
	204	mode_t mode, struct proc_dir_entry *base,
	205	read_proc_t read_proc, void data) { return NULL; }
1da177e4 LT	206
	207	struct tty_driver;
	208	static inline void proc_tty_register_driver(struct tty_driver *driver) {};
	209	static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
	210
6f4e6433 PE	211	static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
	212	{
	213	return 0;
	214	}
	215
	216	static inline void pid_ns_release_proc(struct pid_namespace *ns)
	217	{
	218	}
	219
925d1c40 MH	220	static inline void set_mm_exe_file(struct mm_struct *mm,
	221	struct file *new_exe_file)
	222	{}
	223
	224	static inline struct file get_mm_exe_file(struct mm_struct mm)
	225	{
	226	return NULL;
	227	}
	228
	229	static inline void dup_mm_exe_file(struct mm_struct *oldmm,
	230	struct mm_struct *newmm)
	231	{}
	232
1da177e4 LT	233	#endif /* CONFIG_PROC_FS */
	234
	235	#if !defined(CONFIG_PROC_KCORE)
	236	static inline void kclist_add(struct kcore_list new, void addr, size_t size)
	237	{
	238	}
	239	#else
	240	extern void kclist_add(struct kcore_list , void , size_t);
	241	#endif
	242
20cdc894	243	union proc_op {
3dcd25f3	244	int (proc_get_link)(struct inode , struct path *);
20cdc894	245	int (proc_read)(struct task_struct task, char *page);
be614086 EB	246	int (proc_show)(struct seq_file m,
	247	struct pid_namespace ns, struct pid pid,
	248	struct task_struct *task);
20cdc894 EB	249	};
20cdc894 EB	250
9043476f AV	251	struct ctl_table_header;
	252	struct ctl_table;
	253
1da177e4	254	struct proc_inode {
13b41b09	255	struct pid *pid;
aed7a6c4	256	int fd;
20cdc894	257	union proc_op op;
1da177e4	258	struct proc_dir_entry *pde;
9043476f AV	259	struct ctl_table_header *sysctl;
9043476f AV	260	struct ctl_table *sysctl_entry;
1da177e4 LT	261	struct inode vfs_inode;
	262	};
	263
	264	static inline struct proc_inode PROC_I(const struct inode inode)
	265	{
	266	return container_of(inode, struct proc_inode, vfs_inode);
	267	}
	268
	269	static inline struct proc_dir_entry PDE(const struct inode inode)
	270	{
	271	return PROC_I(inode)->pde;
	272	}
	273
457c4cbc EB	274	static inline struct net PDE_NET(struct proc_dir_entry pde)
	275	{
	276	return pde->parent->data;
	277	}
	278
99f89551	279	struct proc_maps_private {
13b41b09	280	struct pid *pid;
99f89551	281	struct task_struct *task;
dbf8685c	282	#ifdef CONFIG_MMU
99f89551	283	struct vm_area_struct *tail_vma;
dbf8685c	284	#endif
99f89551 EB	285	};
99f89551 EB	286
1da177e4	287	#endif /* _LINUX_PROC_FS_H */