[GitHub/mt8127/android_kernel_alcatel_ttab.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,
};

/*
 * 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);

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

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

#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 {
	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;
d161a13f	53	umode_t mode;
1da177e4	54	nlink_t nlink;
dcb0f222 EB	55	kuid_t uid;
dcb0f222 EB	56	kgid_t gid;
22e6c1b3	57	loff_t size;
c5ef1c42	58	const struct inode_operations *proc_iops;
786d7e16 AD	59	/*
	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.
	63	*
	64	* If you're allocating ->proc_fops dynamically, save a pointer
	65	* somewhere.
	66	*/
c5ef1c42	67	const struct file_operations *proc_fops;
1da177e4 LT	68	struct proc_dir_entry next, parent, *subdir;
	69	void *data;
	70	read_proc_t *read_proc;
	71	write_proc_t *write_proc;
	72	atomic_t count; /* use count */
786d7e16	73	int pde_users; /* number of callers into module in progress */
786d7e16	74	struct completion *pde_unload_completion;
881adb85	75	struct list_head pde_openers; /* who did ->open, but not ->release */
09570f91 DH	76	spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
	77	u8 namelen;
	78	char name[];
1da177e4 LT	79	};
1da177e4 LT	80
c30bb2a2 KH	81	enum kcore_type {
	82	KCORE_TEXT,
	83	KCORE_VMALLOC,
	84	KCORE_RAM,
26562c59	85	KCORE_VMEMMAP,
c30bb2a2 KH	86	KCORE_OTHER,
	87	};
	88
1da177e4	89	struct kcore_list {
2ef43ec7	90	struct list_head list;
1da177e4 LT	91	unsigned long addr;
1da177e4 LT	92	size_t size;
c30bb2a2	93	int type;
1da177e4 LT	94	};
1da177e4 LT	95
666bfddb VG	96	struct vmcore {
	97	struct list_head list;
	98	unsigned long long paddr;
80e8ff63	99	unsigned long long size;
666bfddb VG	100	loff_t offset;
	101	};
	102
1da177e4 LT	103	#ifdef CONFIG_PROC_FS
1da177e4 LT	104
1da177e4	105	extern void proc_root_init(void);
1da177e4	106
48e6484d	107	void proc_flush_task(struct task_struct *task);
7695650a	108
d161a13f	109	extern struct proc_dir_entry create_proc_entry(const char name, umode_t mode,
1da177e4	110	struct proc_dir_entry *parent);
d161a13f	111	struct proc_dir_entry proc_create_data(const char name, umode_t mode,
2d3a4e36	112	struct proc_dir_entry *parent,
59b74351 DL	113	const struct file_operations *proc_fops,
59b74351 DL	114	void *data);
1da177e4 LT	115	extern void remove_proc_entry(const char name, struct proc_dir_entry parent);
1da177e4 LT	116
07543f5c	117	struct pid_namespace;
1da177e4	118
6f4e6433 PE	119	extern int pid_ns_prepare_proc(struct pid_namespace *ns);
	120	extern void pid_ns_release_proc(struct pid_namespace *ns);
	121
1da177e4 LT	122	/*
	123	* proc_tty.c
	124	*/
	125	struct tty_driver;
	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);
	129
	130	/*
	131	* proc_devtree.c
	132	*/
183d0202	133	#ifdef CONFIG_PROC_DEVICETREE
1da177e4	134	struct device_node;
183d0202	135	struct property;
1da177e4	136	extern void proc_device_tree_init(void);
1da177e4	137	extern void proc_device_tree_add_node(struct device_node , struct proc_dir_entry );
183d0202	138	extern void proc_device_tree_add_prop(struct proc_dir_entry pde, struct property prop);
898b5395 DB	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);
1da177e4 LT	144	#endif /* CONFIG_PROC_DEVICETREE */
	145
	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 *);
d161a13f	149	extern struct proc_dir_entry proc_mkdir_mode(const char name, umode_t mode,
1da177e4 LT	150	struct proc_dir_entry *parent);
1da177e4 LT	151
d161a13f	152	static inline struct proc_dir_entry proc_create(const char name, umode_t mode,
59b74351 DL	153	struct proc_dir_entry parent, const struct file_operations proc_fops)
	154	{
	155	return proc_create_data(name, mode, parent, proc_fops, NULL);
	156	}
	157
1da177e4	158	static inline struct proc_dir_entry create_proc_read_entry(const char name,
d161a13f	159	umode_t mode, struct proc_dir_entry *base,
1da177e4 LT	160	read_proc_t read_proc, void data)
	161	{
	162	struct proc_dir_entry *res=create_proc_entry(name,mode,base);
	163	if (res) {
	164	res->read_proc=read_proc;
	165	res->data=data;
	166	}
	167	return res;
	168	}
	169
457c4cbc	170	extern struct proc_dir_entry proc_net_fops_create(struct net net,
d161a13f	171	const char name, umode_t mode, const struct file_operations fops);
457c4cbc	172	extern void proc_net_remove(struct net net, const char name);
e5d69b9f DL	173	extern struct proc_dir_entry proc_net_mkdir(struct net net, const char *name,
e5d69b9f DL	174	struct proc_dir_entry *parent);
1da177e4	175
6b4e306a	176	extern struct file *proc_ns_fget(int fd);
8823c079	177	extern bool proc_ns_inode(struct inode *inode);
6b4e306a	178
1da177e4 LT	179	#else
1da177e4 LT	180
457c4cbc	181	#define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; })
457c4cbc	182	static inline void proc_net_remove(struct net net, const char name) {}
1da177e4	183
60347f67 PE	184	static inline void proc_flush_task(struct task_struct *task)
	185	{
	186	}
1da177e4 LT	187
1da177e4 LT	188	static inline struct proc_dir_entry create_proc_entry(const char name,
d161a13f	189	umode_t mode, struct proc_dir_entry *parent) { return NULL; }
2d3a4e36	190	static inline struct proc_dir_entry proc_create(const char name,
d161a13f	191	umode_t mode, struct proc_dir_entry *parent,
2d3a4e36 AD	192	const struct file_operations *proc_fops)
	193	{
	194	return NULL;
	195	}
59b74351	196	static inline struct proc_dir_entry proc_create_data(const char name,
d161a13f	197	umode_t mode, struct proc_dir_entry *parent,
59b74351 DL	198	const struct file_operations proc_fops, void data)
	199	{
	200	return NULL;
	201	}
1da177e4 LT	202	#define remove_proc_entry(name, parent) do {} while (0)
	203
	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;}
f12a20fc	208	static inline struct proc_dir_entry proc_mkdir_mode(const char name,
d161a13f	209	umode_t mode, struct proc_dir_entry *parent) { return NULL; }
1da177e4 LT	210
1da177e4 LT	211	static inline struct proc_dir_entry create_proc_read_entry(const char name,
d161a13f	212	umode_t mode, struct proc_dir_entry *base,
1da177e4	213	read_proc_t read_proc, void data) { return NULL; }
1da177e4 LT	214
	215	struct tty_driver;
	216	static inline void proc_tty_register_driver(struct tty_driver *driver) {};
	217	static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
	218
6f4e6433 PE	219	static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
	220	{
	221	return 0;
	222	}
	223
	224	static inline void pid_ns_release_proc(struct pid_namespace *ns)
	225	{
	226	}
	227
6b4e306a EB	228	static inline struct file *proc_ns_fget(int fd)
	229	{
	230	return ERR_PTR(-EINVAL);
	231	}
	232
8823c079 EB	233	static inline bool proc_ns_inode(struct inode *inode)
	234	{
	235	return false;
	236	}
	237
1da177e4 LT	238	#endif /* CONFIG_PROC_FS */
	239
	240	#if !defined(CONFIG_PROC_KCORE)
c30bb2a2 KH	241	static inline void
c30bb2a2 KH	242	kclist_add(struct kcore_list new, void addr, size_t size, int type)
1da177e4 LT	243	{
	244	}
	245	#else
c30bb2a2	246	extern void kclist_add(struct kcore_list , void , size_t, int type);
1da177e4 LT	247	#endif
1da177e4 LT	248
6b4e306a EB	249	struct nsproxy;
	250	struct proc_ns_operations {
	251	const char *name;
	252	int type;
	253	void (get)(struct task_struct *task);
	254	void (put)(void ns);
	255	int (install)(struct nsproxy nsproxy, void *ns);
	256	};
13b6f576	257	extern const struct proc_ns_operations netns_operations;
34482e89	258	extern const struct proc_ns_operations utsns_operations;
a00eaf11	259	extern const struct proc_ns_operations ipcns_operations;
57e8391d	260	extern const struct proc_ns_operations pidns_operations;
cde1975b	261	extern const struct proc_ns_operations userns_operations;
8823c079	262	extern const struct proc_ns_operations mntns_operations;
6b4e306a	263
20cdc894	264	union proc_op {
7773fbc5	265	int (proc_get_link)(struct dentry , struct path *);
20cdc894	266	int (proc_read)(struct task_struct task, char *page);
be614086 EB	267	int (proc_show)(struct seq_file m,
	268	struct pid_namespace ns, struct pid pid,
	269	struct task_struct *task);
20cdc894 EB	270	};
20cdc894 EB	271
9043476f AV	272	struct ctl_table_header;
	273	struct ctl_table;
	274
1da177e4	275	struct proc_inode {
13b41b09	276	struct pid *pid;
aed7a6c4	277	int fd;
20cdc894	278	union proc_op op;
1da177e4	279	struct proc_dir_entry *pde;
9043476f AV	280	struct ctl_table_header *sysctl;
9043476f AV	281	struct ctl_table *sysctl_entry;
6b4e306a EB	282	void *ns;
6b4e306a EB	283	const struct proc_ns_operations *ns_ops;
1da177e4 LT	284	struct inode vfs_inode;
	285	};
	286
	287	static inline struct proc_inode PROC_I(const struct inode inode)
	288	{
	289	return container_of(inode, struct proc_inode, vfs_inode);
	290	}
	291
	292	static inline struct proc_dir_entry PDE(const struct inode inode)
	293	{
	294	return PROC_I(inode)->pde;
	295	}
	296
457c4cbc EB	297	static inline struct net PDE_NET(struct proc_dir_entry pde)
	298	{
	299	return pde->parent->data;
	300	}
	301
1da177e4	302	#endif /* _LINUX_PROC_FS_H */