[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;

/*
 * 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).
 *
 * "get_info" is called at "read", while "owner" is used to protect module
 * from unloading while proc_dir_entry is in use
 */

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);
typedef int (get_info_t)(char *, char **, off_t, int);
typedef struct proc_dir_entry *(shadow_proc_t)(struct task_struct *task,
						struct proc_dir_entry *pde);

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;
	get_info_t *get_info;
	struct module *owner;
	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;
	shadow_proc_t *shadow_proc;
};

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 struct proc_dir_entry proc_root;
extern struct proc_dir_entry *proc_root_fs;
extern struct proc_dir_entry *proc_bus;
extern struct proc_dir_entry *proc_root_driver;
extern struct proc_dir_entry *proc_root_kcore;

extern spinlock_t proc_subdir_lock;

extern void proc_root_init(void);
extern void proc_misc_init(void);

struct mm_struct;

void proc_flush_task(struct task_struct *task);
struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
unsigned long task_vsize(struct mm_struct *);
int task_statm(struct mm_struct *, int *, int *, int *, int *);
char *task_mem(struct mm_struct *, char *);

struct proc_dir_entry *de_get(struct proc_dir_entry *de);
void de_put(struct proc_dir_entry *de);

extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
						struct proc_dir_entry *parent);
extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);

extern struct vfsmount *proc_mnt;
struct pid_namespace;
extern int proc_fill_super(struct super_block *);
extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *);

/*
 * These are generic /proc routines that use the internal
 * "struct proc_dir_entry" tree to traverse the filesystem.
 *
 * The /proc root directory has extended versions to take care
 * of the /proc/<pid> subdirectories.
 */
extern int proc_readdir(struct file *, void *, filldir_t);
extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *);

extern const struct file_operations proc_kcore_operations;
extern const struct file_operations proc_kmsg_operations;
extern const struct file_operations ppc_htab_operations;

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 *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;
}
 
static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
	mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
{
	struct proc_dir_entry *res=create_proc_entry(name,mode,base);
	if (res) res->get_info=get_info;
	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);

#else

#define proc_root_driver NULL
#define proc_bus NULL

#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; }

#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; }
static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
	mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
	{ 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) {};

extern struct proc_dir_entry proc_root;

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

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

#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 dentry **, struct vfsmount **);
	int (*proc_read)(struct task_struct *task, char *page);
};

struct proc_inode {
	struct pid *pid;
	int fd;
	union proc_op op;
	struct proc_dir_entry *pde;
	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 net *get_proc_net(const struct inode *inode);

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 AD	11	struct completion;
786d7e16 AD	12
1da177e4 LT	13	/*
	14	* The proc filesystem constants/structures
	15	*/
	16
	17	/*
	18	* Offset of the first process in the /proc root directory..
	19	*/
	20	#define FIRST_PROCESS_ENTRY 256
	21
f248dcb3 MM	22	/* Worst case buffer size needed for holding an integer. */
f248dcb3 MM	23	#define PROC_NUMBUF 13
1da177e4 LT	24
	25	/*
	26	* We always define these enumerators
	27	*/
	28
	29	enum {
	30	PROC_ROOT_INO = 1,
	31	};
	32
1da177e4 LT	33	/*
	34	* This is not completely implemented yet. The idea is to
	35	* create an in-memory tree (like the actual /proc filesystem
	36	* tree) of these proc_dir_entries, so that we can dynamically
	37	* add new files to /proc.
	38	*
	39	* The "next" pointer creates a linked list of one /proc directory,
	40	* while parent/subdir create the directory structure (every
	41	* /proc file has a parent, but "subdir" is NULL for all
	42	* non-directory entries).
	43	*
	44	* "get_info" is called at "read", while "owner" is used to protect module
	45	* from unloading while proc_dir_entry is in use
	46	*/
	47
	48	typedef int (read_proc_t)(char page, char *start, off_t off,
	49	int count, int eof, void data);
	50	typedef int (write_proc_t)(struct file file, const char __user buffer,
	51	unsigned long count, void *data);
	52	typedef int (get_info_t)(char , char *, off_t, int);
2b1e300a EB	53	typedef struct proc_dir_entry (shadow_proc_t)(struct task_struct task,
2b1e300a EB	54	struct proc_dir_entry *pde);
1da177e4 LT	55
	56	struct proc_dir_entry {
	57	unsigned int low_ino;
	58	unsigned short namelen;
	59	const char *name;
	60	mode_t mode;
	61	nlink_t nlink;
	62	uid_t uid;
	63	gid_t gid;
22e6c1b3	64	loff_t size;
c5ef1c42	65	const struct inode_operations *proc_iops;
786d7e16 AD	66	/*
	67	* NULL ->proc_fops means "PDE is going away RSN" or
	68	* "PDE is just created". In either case, e.g. ->read_proc won't be
	69	* called because it's too late or too early, respectively.
	70	*
	71	* If you're allocating ->proc_fops dynamically, save a pointer
	72	* somewhere.
	73	*/
c5ef1c42	74	const struct file_operations *proc_fops;
1da177e4 LT	75	get_info_t *get_info;
	76	struct module *owner;
	77	struct proc_dir_entry next, parent, *subdir;
	78	void *data;
	79	read_proc_t *read_proc;
	80	write_proc_t *write_proc;
	81	atomic_t count; /* use count */
786d7e16 AD	82	int pde_users; /* number of callers into module in progress */
	83	spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
	84	struct completion *pde_unload_completion;
2b1e300a	85	shadow_proc_t *shadow_proc;
1da177e4 LT	86	};
	87
	88	struct kcore_list {
	89	struct kcore_list *next;
	90	unsigned long addr;
	91	size_t size;
	92	};
	93
666bfddb VG	94	struct vmcore {
	95	struct list_head list;
	96	unsigned long long paddr;
80e8ff63	97	unsigned long long size;
666bfddb VG	98	loff_t offset;
	99	};
	100
1da177e4 LT	101	#ifdef CONFIG_PROC_FS
	102
	103	extern struct proc_dir_entry proc_root;
	104	extern struct proc_dir_entry *proc_root_fs;
1da177e4 LT	105	extern struct proc_dir_entry *proc_bus;
	106	extern struct proc_dir_entry *proc_root_driver;
	107	extern struct proc_dir_entry *proc_root_kcore;
	108
64a07bd8 SR	109	extern spinlock_t proc_subdir_lock;
64a07bd8 SR	110
1da177e4 LT	111	extern void proc_root_init(void);
	112	extern void proc_misc_init(void);
	113
	114	struct mm_struct;
	115
48e6484d	116	void proc_flush_task(struct task_struct *task);
1da177e4	117	struct dentry proc_pid_lookup(struct inode dir, struct dentry * dentry, struct nameidata *);
1da177e4 LT	118	int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
	119	unsigned long task_vsize(struct mm_struct *);
	120	int task_statm(struct mm_struct , int , int , int , int *);
	121	char task_mem(struct mm_struct , char *);
	122
7695650a AD	123	struct proc_dir_entry de_get(struct proc_dir_entry de);
	124	void de_put(struct proc_dir_entry *de);
	125
1da177e4 LT	126	extern struct proc_dir_entry create_proc_entry(const char name, mode_t mode,
	127	struct proc_dir_entry *parent);
	128	extern void remove_proc_entry(const char name, struct proc_dir_entry parent);
	129
	130	extern struct vfsmount *proc_mnt;
07543f5c PE	131	struct pid_namespace;
07543f5c PE	132	extern int proc_fill_super(struct super_block *);
1da177e4 LT	133	extern struct inode proc_get_inode(struct super_block , unsigned int, struct proc_dir_entry *);
1da177e4 LT	134
1da177e4 LT	135	/*
	136	* These are generic /proc routines that use the internal
	137	* "struct proc_dir_entry" tree to traverse the filesystem.
	138	*
	139	* The /proc root directory has extended versions to take care
	140	* of the /proc/<pid> subdirectories.
	141	*/
	142	extern int proc_readdir(struct file , void , filldir_t);
	143	extern struct dentry proc_lookup(struct inode , struct dentry , struct nameidata );
	144
4b6f5d20 AV	145	extern const struct file_operations proc_kcore_operations;
	146	extern const struct file_operations proc_kmsg_operations;
	147	extern const struct file_operations ppc_htab_operations;
1da177e4	148
6f4e6433 PE	149	extern int pid_ns_prepare_proc(struct pid_namespace *ns);
	150	extern void pid_ns_release_proc(struct pid_namespace *ns);
	151
1da177e4 LT	152	/*
	153	* proc_tty.c
	154	*/
	155	struct tty_driver;
	156	extern void proc_tty_init(void);
	157	extern void proc_tty_register_driver(struct tty_driver *driver);
	158	extern void proc_tty_unregister_driver(struct tty_driver *driver);
	159
	160	/*
	161	* proc_devtree.c
	162	*/
183d0202	163	#ifdef CONFIG_PROC_DEVICETREE
1da177e4	164	struct device_node;
183d0202	165	struct property;
1da177e4	166	extern void proc_device_tree_init(void);
1da177e4	167	extern void proc_device_tree_add_node(struct device_node , struct proc_dir_entry );
183d0202	168	extern void proc_device_tree_add_prop(struct proc_dir_entry pde, struct property prop);
898b5395 DB	169	extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
	170	struct property *prop);
	171	extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
	172	struct property *newprop,
	173	struct property *oldprop);
1da177e4 LT	174	#endif /* CONFIG_PROC_DEVICETREE */
	175
	176	extern struct proc_dir_entry proc_symlink(const char ,
	177	struct proc_dir_entry , const char );
	178	extern struct proc_dir_entry proc_mkdir(const char ,struct proc_dir_entry *);
	179	extern struct proc_dir_entry proc_mkdir_mode(const char name, mode_t mode,
	180	struct proc_dir_entry *parent);
	181
	182	static inline struct proc_dir_entry create_proc_read_entry(const char name,
	183	mode_t mode, struct proc_dir_entry *base,
	184	read_proc_t read_proc, void data)
	185	{
	186	struct proc_dir_entry *res=create_proc_entry(name,mode,base);
	187	if (res) {
	188	res->read_proc=read_proc;
	189	res->data=data;
	190	}
	191	return res;
	192	}
	193
	194	static inline struct proc_dir_entry create_proc_info_entry(const char name,
	195	mode_t mode, struct proc_dir_entry base, get_info_t get_info)
	196	{
	197	struct proc_dir_entry *res=create_proc_entry(name,mode,base);
	198	if (res) res->get_info=get_info;
	199	return res;
	200	}
1da177e4	201
457c4cbc EB	202	extern struct proc_dir_entry proc_net_fops_create(struct net net,
	203	const char name, mode_t mode, const struct file_operations fops);
	204	extern void proc_net_remove(struct net net, const char name);
e5d69b9f DL	205	extern struct proc_dir_entry proc_net_mkdir(struct net net, const char *name,
e5d69b9f DL	206	struct proc_dir_entry *parent);
1da177e4 LT	207
	208	#else
	209
	210	#define proc_root_driver NULL
1da177e4 LT	211	#define proc_bus NULL
1da177e4 LT	212
457c4cbc	213	#define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; })
457c4cbc	214	static inline void proc_net_remove(struct net net, const char name) {}
1da177e4	215
60347f67 PE	216	static inline void proc_flush_task(struct task_struct *task)
	217	{
	218	}
1da177e4 LT	219
	220	static inline struct proc_dir_entry create_proc_entry(const char name,
	221	mode_t mode, struct proc_dir_entry *parent) { return NULL; }
	222
	223	#define remove_proc_entry(name, parent) do {} while (0)
	224
	225	static inline struct proc_dir_entry proc_symlink(const char name,
	226	struct proc_dir_entry parent,const char dest) {return NULL;}
	227	static inline struct proc_dir_entry proc_mkdir(const char name,
	228	struct proc_dir_entry *parent) {return NULL;}
	229
	230	static inline struct proc_dir_entry create_proc_read_entry(const char name,
	231	mode_t mode, struct proc_dir_entry *base,
	232	read_proc_t read_proc, void data) { return NULL; }
	233	static inline struct proc_dir_entry create_proc_info_entry(const char name,
	234	mode_t mode, struct proc_dir_entry base, get_info_t get_info)
	235	{ return NULL; }
	236
	237	struct tty_driver;
	238	static inline void proc_tty_register_driver(struct tty_driver *driver) {};
	239	static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
	240
	241	extern struct proc_dir_entry proc_root;
	242
6f4e6433 PE	243	static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
	244	{
	245	return 0;
	246	}
	247
	248	static inline void pid_ns_release_proc(struct pid_namespace *ns)
	249	{
	250	}
	251
1da177e4 LT	252	#endif /* CONFIG_PROC_FS */
	253
	254	#if !defined(CONFIG_PROC_KCORE)
	255	static inline void kclist_add(struct kcore_list new, void addr, size_t size)
	256	{
	257	}
	258	#else
	259	extern void kclist_add(struct kcore_list , void , size_t);
	260	#endif
	261
20cdc894 EB	262	union proc_op {
	263	int (proc_get_link)(struct inode , struct dentry , struct vfsmount );
	264	int (proc_read)(struct task_struct task, char *page);
	265	};
	266
1da177e4	267	struct proc_inode {
13b41b09	268	struct pid *pid;
aed7a6c4	269	int fd;
20cdc894	270	union proc_op op;
1da177e4 LT	271	struct proc_dir_entry *pde;
	272	struct inode vfs_inode;
	273	};
	274
	275	static inline struct proc_inode PROC_I(const struct inode inode)
	276	{
	277	return container_of(inode, struct proc_inode, vfs_inode);
	278	}
	279
	280	static inline struct proc_dir_entry PDE(const struct inode inode)
	281	{
	282	return PROC_I(inode)->pde;
	283	}
	284
457c4cbc EB	285	static inline struct net PDE_NET(struct proc_dir_entry pde)
	286	{
	287	return pde->parent->data;
	288	}
	289
077130c0	290	struct net get_proc_net(const struct inode inode);
457c4cbc	291
99f89551	292	struct proc_maps_private {
13b41b09	293	struct pid *pid;
99f89551	294	struct task_struct *task;
dbf8685c	295	#ifdef CONFIG_MMU
99f89551	296	struct vm_area_struct *tail_vma;
dbf8685c	297	#endif
99f89551 EB	298	};
99f89551 EB	299
1da177e4	300	#endif /* _LINUX_PROC_FS_H */