[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,
	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);
extern int remove_proc_subtree(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;
#ifdef CONFIG_TTY
extern void proc_tty_init(void);
#else
static inline void proc_tty_init(void)
{ }
#endif
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_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

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

#define proc_create(name, mode, parent, fops)  ({ (void)(mode), 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)
#define remove_proc_subtree(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	119	extern void remove_proc_entry(const char name, struct proc_dir_entry parent);
8ce584c7	120	extern int remove_proc_subtree(const char name, struct proc_dir_entry parent);
1da177e4	121
07543f5c	122	struct pid_namespace;
1da177e4	123
6f4e6433 PE	124	extern int pid_ns_prepare_proc(struct pid_namespace *ns);
	125	extern void pid_ns_release_proc(struct pid_namespace *ns);
	126
1da177e4 LT	127	/*
	128	* proc_tty.c
	129	*/
	130	struct tty_driver;
4f73bc4d	131	#ifdef CONFIG_TTY
1da177e4	132	extern void proc_tty_init(void);
4f73bc4d JM	133	#else
	134	static inline void proc_tty_init(void)
	135	{ }
	136	#endif
1da177e4 LT	137	extern void proc_tty_register_driver(struct tty_driver *driver);
	138	extern void proc_tty_unregister_driver(struct tty_driver *driver);
	139
	140	/*
	141	* proc_devtree.c
	142	*/
183d0202	143	#ifdef CONFIG_PROC_DEVICETREE
1da177e4	144	struct device_node;
183d0202	145	struct property;
1da177e4	146	extern void proc_device_tree_init(void);
1da177e4	147	extern void proc_device_tree_add_node(struct device_node , struct proc_dir_entry );
183d0202	148	extern void proc_device_tree_add_prop(struct proc_dir_entry pde, struct property prop);
898b5395 DB	149	extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
	150	struct property *prop);
	151	extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
	152	struct property *newprop,
	153	struct property *oldprop);
1da177e4 LT	154	#endif /* CONFIG_PROC_DEVICETREE */
	155
	156	extern struct proc_dir_entry proc_symlink(const char ,
	157	struct proc_dir_entry , const char );
	158	extern struct proc_dir_entry proc_mkdir(const char ,struct proc_dir_entry *);
d161a13f	159	extern struct proc_dir_entry proc_mkdir_mode(const char name, umode_t mode,
1da177e4 LT	160	struct proc_dir_entry *parent);
1da177e4 LT	161
d161a13f	162	static inline struct proc_dir_entry proc_create(const char name, umode_t mode,
59b74351 DL	163	struct proc_dir_entry parent, const struct file_operations proc_fops)
	164	{
	165	return proc_create_data(name, mode, parent, proc_fops, NULL);
	166	}
	167
1da177e4	168	static inline struct proc_dir_entry create_proc_read_entry(const char name,
d161a13f	169	umode_t mode, struct proc_dir_entry *base,
1da177e4 LT	170	read_proc_t read_proc, void data)
	171	{
	172	struct proc_dir_entry *res=create_proc_entry(name,mode,base);
	173	if (res) {
	174	res->read_proc=read_proc;
	175	res->data=data;
	176	}
	177	return res;
	178	}
	179
e5d69b9f DL	180	extern struct proc_dir_entry proc_net_mkdir(struct net net, const char *name,
e5d69b9f DL	181	struct proc_dir_entry *parent);
1da177e4	182
6b4e306a	183	extern struct file *proc_ns_fget(int fd);
8823c079	184	extern bool proc_ns_inode(struct inode *inode);
6b4e306a	185
33d6dce6 EB	186	extern int proc_alloc_inum(unsigned int *pino);
33d6dce6 EB	187	extern void proc_free_inum(unsigned int inum);
1da177e4 LT	188	#else
1da177e4 LT	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; }
4fc1a601 G	196
	197	#define proc_create(name, mode, parent, fops) ({ (void)(mode), NULL; })
	198
59b74351	199	static inline struct proc_dir_entry proc_create_data(const char name,
d161a13f	200	umode_t mode, struct proc_dir_entry *parent,
59b74351 DL	201	const struct file_operations proc_fops, void data)
	202	{
	203	return NULL;
	204	}
1da177e4	205	#define remove_proc_entry(name, parent) do {} while (0)
8ce584c7	206	#define remove_proc_subtree(name, parent) do {} while (0)
1da177e4 LT	207
	208	static inline struct proc_dir_entry proc_symlink(const char name,
	209	struct proc_dir_entry parent,const char dest) {return NULL;}
	210	static inline struct proc_dir_entry proc_mkdir(const char name,
	211	struct proc_dir_entry *parent) {return NULL;}
f12a20fc	212	static inline struct proc_dir_entry proc_mkdir_mode(const char name,
d161a13f	213	umode_t mode, struct proc_dir_entry *parent) { return NULL; }
1da177e4 LT	214
1da177e4 LT	215	static inline struct proc_dir_entry create_proc_read_entry(const char name,
d161a13f	216	umode_t mode, struct proc_dir_entry *base,
1da177e4	217	read_proc_t read_proc, void data) { return NULL; }
1da177e4 LT	218
	219	struct tty_driver;
	220	static inline void proc_tty_register_driver(struct tty_driver *driver) {};
	221	static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
	222
6f4e6433 PE	223	static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
	224	{
	225	return 0;
	226	}
	227
	228	static inline void pid_ns_release_proc(struct pid_namespace *ns)
	229	{
	230	}
	231
6b4e306a EB	232	static inline struct file *proc_ns_fget(int fd)
	233	{
	234	return ERR_PTR(-EINVAL);
	235	}
	236
8823c079 EB	237	static inline bool proc_ns_inode(struct inode *inode)
	238	{
	239	return false;
	240	}
	241
33d6dce6 EB	242	static inline int proc_alloc_inum(unsigned int *inum)
	243	{
	244	*inum = 1;
	245	return 0;
	246	}
	247	static inline void proc_free_inum(unsigned int inum)
	248	{
	249	}
1da177e4 LT	250	#endif /* CONFIG_PROC_FS */
	251
	252	#if !defined(CONFIG_PROC_KCORE)
c30bb2a2 KH	253	static inline void
c30bb2a2 KH	254	kclist_add(struct kcore_list new, void addr, size_t size, int type)
1da177e4 LT	255	{
	256	}
	257	#else
c30bb2a2	258	extern void kclist_add(struct kcore_list , void , size_t, int type);
1da177e4 LT	259	#endif
1da177e4 LT	260
6b4e306a EB	261	struct nsproxy;
	262	struct proc_ns_operations {
	263	const char *name;
	264	int type;
	265	void (get)(struct task_struct *task);
	266	void (put)(void ns);
	267	int (install)(struct nsproxy nsproxy, void *ns);
98f842e6	268	unsigned int (inum)(void ns);
6b4e306a	269	};
13b6f576	270	extern const struct proc_ns_operations netns_operations;
34482e89	271	extern const struct proc_ns_operations utsns_operations;
a00eaf11	272	extern const struct proc_ns_operations ipcns_operations;
57e8391d	273	extern const struct proc_ns_operations pidns_operations;
cde1975b	274	extern const struct proc_ns_operations userns_operations;
8823c079	275	extern const struct proc_ns_operations mntns_operations;
6b4e306a	276
20cdc894	277	union proc_op {
7773fbc5	278	int (proc_get_link)(struct dentry , struct path *);
20cdc894	279	int (proc_read)(struct task_struct task, char *page);
be614086 EB	280	int (proc_show)(struct seq_file m,
	281	struct pid_namespace ns, struct pid pid,
	282	struct task_struct *task);
20cdc894 EB	283	};
20cdc894 EB	284
9043476f AV	285	struct ctl_table_header;
	286	struct ctl_table;
	287
1da177e4	288	struct proc_inode {
13b41b09	289	struct pid *pid;
aed7a6c4	290	int fd;
20cdc894	291	union proc_op op;
1da177e4	292	struct proc_dir_entry *pde;
9043476f AV	293	struct ctl_table_header *sysctl;
9043476f AV	294	struct ctl_table *sysctl_entry;
6b4e306a EB	295	void *ns;
6b4e306a EB	296	const struct proc_ns_operations *ns_ops;
1da177e4 LT	297	struct inode vfs_inode;
	298	};
	299
	300	static inline struct proc_inode PROC_I(const struct inode inode)
	301	{
	302	return container_of(inode, struct proc_inode, vfs_inode);
	303	}
	304
	305	static inline struct proc_dir_entry PDE(const struct inode inode)
	306	{
	307	return PROC_I(inode)->pde;
	308	}
	309
457c4cbc EB	310	static inline struct net PDE_NET(struct proc_dir_entry pde)
	311	{
	312	return pde->parent->data;
	313	}
	314
138d22b5 CG	315	#include <linux/signal.h>
	316
	317	void render_sigset_t(struct seq_file m, const char header, sigset_t *set);
1da177e4	318	#endif /* _LINUX_PROC_FS_H */