[mirror_ubuntu-artful-kernel.git] / fs / proc / internal.h

/* Internal procfs definitions
 *
 * Copyright (C) 2004 Red Hat, Inc. All Rights Reserved.
 * Written by David Howells (dhowells@redhat.com)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version
 * 2 of the License, or (at your option) any later version.
 */

#include <linux/proc_fs.h>
#include <linux/proc_ns.h>
#include <linux/spinlock.h>
#include <linux/atomic.h>
#include <linux/binfmts.h>
#include <linux/sched/coredump.h>
#include <linux/sched/task.h>

struct ctl_table_header;
struct mempolicy;

/*
 * 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.
 *
 * parent/subdir are used for the directory structure (every /proc file has a
 * parent, but "subdir" is empty for all non-directory entries).
 * subdir_node is used to build the rb tree "subdir" of the parent.
 */
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;
	const struct file_operations *proc_fops;
	struct proc_dir_entry *parent;
	struct rb_root subdir;
	struct rb_node subdir_node;
	void *data;
	atomic_t count;		/* use count */
	atomic_t in_use;	/* number of callers into module in progress; */
			/* negative -> it's going away RSN */
	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[];
} __randomize_layout;

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

struct proc_inode {
	struct pid *pid;
	unsigned int fd;
	union proc_op op;
	struct proc_dir_entry *pde;
	struct ctl_table_header *sysctl;
	struct ctl_table *sysctl_entry;
	struct hlist_node sysctl_inodes;
	const struct proc_ns_operations *ns_ops;
	struct inode vfs_inode;
} __randomize_layout;

/*
 * General functions
 */
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 void *__PDE_DATA(const struct inode *inode)
{
	return PDE(inode)->data;
}

static inline struct pid *proc_pid(struct inode *inode)
{
	return PROC_I(inode)->pid;
}

static inline struct task_struct *get_proc_task(struct inode *inode)
{
	return get_pid_task(proc_pid(inode), PIDTYPE_PID);
}

void task_dump_owner(struct task_struct *task, mode_t mode,
		     kuid_t *ruid, kgid_t *rgid);

static inline unsigned name_to_int(const struct qstr *qstr)
{
	const char *name = qstr->name;
	int len = qstr->len;
	unsigned n = 0;

	if (len > 1 && *name == '0')
		goto out;
	while (len-- > 0) {
		unsigned c = *name++ - '0';
		if (c > 9)
			goto out;
		if (n >= (~0U-9)/10)
			goto out;
		n *= 10;
		n += c;
	}
	return n;
out:
	return ~0U;
}

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

/*
 * array.c
 */
extern const struct file_operations proc_tid_children_operations;

extern int proc_tid_stat(struct seq_file *, struct pid_namespace *,
			 struct pid *, struct task_struct *);
extern int proc_tgid_stat(struct seq_file *, struct pid_namespace *,
			  struct pid *, struct task_struct *);
extern int proc_pid_status(struct seq_file *, struct pid_namespace *,
			   struct pid *, struct task_struct *);
extern int proc_pid_statm(struct seq_file *, struct pid_namespace *,
			  struct pid *, struct task_struct *);

/*
 * base.c
 */
extern const struct dentry_operations pid_dentry_operations;
extern int pid_getattr(const struct path *, struct kstat *, u32, unsigned int);
extern int proc_setattr(struct dentry *, struct iattr *);
extern struct inode *proc_pid_make_inode(struct super_block *, struct task_struct *, umode_t);
extern int pid_revalidate(struct dentry *, unsigned int);
extern int pid_delete_dentry(const struct dentry *);
extern int proc_pid_readdir(struct file *, struct dir_context *);
extern struct dentry *proc_pid_lookup(struct inode *, struct dentry *, unsigned int);
extern loff_t mem_lseek(struct file *, loff_t, int);

/* Lookups */
typedef int instantiate_t(struct inode *, struct dentry *,
				     struct task_struct *, const void *);
extern bool proc_fill_cache(struct file *, struct dir_context *, const char *, int,
			   instantiate_t, struct task_struct *, const void *);

/*
 * generic.c
 */
extern struct dentry *proc_lookup(struct inode *, struct dentry *, unsigned int);
extern struct dentry *proc_lookup_de(struct proc_dir_entry *, struct inode *,
				     struct dentry *);
extern int proc_readdir(struct file *, struct dir_context *);
extern int proc_readdir_de(struct proc_dir_entry *, struct file *, struct dir_context *);

static inline struct proc_dir_entry *pde_get(struct proc_dir_entry *pde)
{
	atomic_inc(&pde->count);
	return pde;
}
extern void pde_put(struct proc_dir_entry *);

static inline bool is_empty_pde(const struct proc_dir_entry *pde)
{
	return S_ISDIR(pde->mode) && !pde->proc_iops;
}

/*
 * inode.c
 */
struct pde_opener {
	struct file *file;
	struct list_head lh;
	bool closing;
	struct completion *c;
};
extern const struct inode_operations proc_link_inode_operations;

extern const struct inode_operations proc_pid_link_inode_operations;

extern void proc_init_inodecache(void);
void set_proc_pid_nlink(void);
extern struct inode *proc_get_inode(struct super_block *, struct proc_dir_entry *);
extern int proc_fill_super(struct super_block *, void *data, int flags);
extern void proc_entry_rundown(struct proc_dir_entry *);

/*
 * proc_namespaces.c
 */
extern const struct inode_operations proc_ns_dir_inode_operations;
extern const struct file_operations proc_ns_dir_operations;

/*
 * proc_net.c
 */
extern const struct file_operations proc_net_operations;
extern const struct inode_operations proc_net_inode_operations;

#ifdef CONFIG_NET
extern int proc_net_init(void);
#else
static inline int proc_net_init(void) { return 0; }
#endif

/*
 * proc_self.c
 */
extern int proc_setup_self(struct super_block *);

/*
 * proc_thread_self.c
 */
extern int proc_setup_thread_self(struct super_block *);
extern void proc_thread_self_init(void);

/*
 * proc_sysctl.c
 */
#ifdef CONFIG_PROC_SYSCTL
extern int proc_sys_init(void);
extern void proc_sys_evict_inode(struct inode *inode,
				 struct ctl_table_header *head);
#else
static inline void proc_sys_init(void) { }
static inline void proc_sys_evict_inode(struct  inode *inode,
					struct ctl_table_header *head) { }
#endif

/*
 * proc_tty.c
 */
#ifdef CONFIG_TTY
extern void proc_tty_init(void);
#else
static inline void proc_tty_init(void) {}
#endif

/*
 * root.c
 */
extern struct proc_dir_entry proc_root;
extern int proc_parse_options(char *options, struct pid_namespace *pid);

extern void proc_self_init(void);
extern int proc_remount(struct super_block *, int *, char *);

/*
 * task_[no]mmu.c
 */
struct proc_maps_private {
	struct inode *inode;
	struct task_struct *task;
	struct mm_struct *mm;
#ifdef CONFIG_MMU
	struct vm_area_struct *tail_vma;
#endif
#ifdef CONFIG_NUMA
	struct mempolicy *task_mempolicy;
#endif
} __randomize_layout;

struct mm_struct *proc_mem_open(struct inode *inode, unsigned int mode);

extern const struct file_operations proc_pid_maps_operations;
extern const struct file_operations proc_tid_maps_operations;
extern const struct file_operations proc_pid_numa_maps_operations;
extern const struct file_operations proc_tid_numa_maps_operations;
extern const struct file_operations proc_pid_smaps_operations;
extern const struct file_operations proc_tid_smaps_operations;
extern const struct file_operations proc_clear_refs_operations;
extern const struct file_operations proc_pagemap_operations;

extern unsigned long task_vsize(struct mm_struct *);
extern unsigned long task_statm(struct mm_struct *,
				unsigned long *, unsigned long *,
				unsigned long *, unsigned long *);
extern void task_mem(struct seq_file *, struct mm_struct *);
Commit	Line	Data
59d8053f	1	/* Internal procfs definitions
1da177e4 LT	2	*
	3	* Copyright (C) 2004 Red Hat, Inc. All Rights Reserved.
	4	* Written by David Howells (dhowells@redhat.com)
	5	*
	6	* This program is free software; you can redistribute it and/or
	7	* modify it under the terms of the GNU General Public License
	8	* as published by the Free Software Foundation; either version
	9	* 2 of the License, or (at your option) any later version.
	10	*/
	11
	12	#include <linux/proc_fs.h>
59d8053f DH	13	#include <linux/proc_ns.h>
	14	#include <linux/spinlock.h>
	15	#include <linux/atomic.h>
e579d2c2	16	#include <linux/binfmts.h>
f7ccbae4	17	#include <linux/sched/coredump.h>
f719ff9b	18	#include <linux/sched/task.h>
1da177e4	19
59d8053f DH	20	struct ctl_table_header;
59d8053f DH	21	struct mempolicy;
77b14db5	22
59d8053f DH	23	/*
	24	* This is not completely implemented yet. The idea is to
	25	* create an in-memory tree (like the actual /proc filesystem
	26	* tree) of these proc_dir_entries, so that we can dynamically
	27	* add new files to /proc.
	28	*
710585d4 ND	29	* parent/subdir are used for the directory structure (every /proc file has a
	30	* parent, but "subdir" is empty for all non-directory entries).
	31	* subdir_node is used to build the rb tree "subdir" of the parent.
59d8053f DH	32	*/
	33	struct proc_dir_entry {
	34	unsigned int low_ino;
	35	umode_t mode;
	36	nlink_t nlink;
	37	kuid_t uid;
	38	kgid_t gid;
	39	loff_t size;
	40	const struct inode_operations *proc_iops;
	41	const struct file_operations *proc_fops;
710585d4 ND	42	struct proc_dir_entry *parent;
	43	struct rb_root subdir;
	44	struct rb_node subdir_node;
59d8053f DH	45	void *data;
	46	atomic_t count; /* use count */
	47	atomic_t in_use; /* number of callers into module in progress; */
	48	/* negative -> it's going away RSN */
	49	struct completion *pde_unload_completion;
	50	struct list_head pde_openers; /* who did ->open, but not ->release */
	51	spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
	52	u8 namelen;
	53	char name[];
3859a271	54	} __randomize_layout;
1da177e4	55
59d8053f DH	56	union proc_op {
59d8053f DH	57	int (proc_get_link)(struct dentry , struct path *);
59d8053f DH	58	int (proc_show)(struct seq_file m,
	59	struct pid_namespace ns, struct pid pid,
	60	struct task_struct *task);
9eee8d63	61	const char *lsm;
59d8053f	62	};
99f89551	63
59d8053f	64	struct proc_inode {
f2beb798	65	struct pid *pid;
771187d6	66	unsigned int fd;
59d8053f DH	67	union proc_op op;
	68	struct proc_dir_entry *pde;
	69	struct ctl_table_header *sysctl;
	70	struct ctl_table *sysctl_entry;
2fd1d2c4	71	struct hlist_node sysctl_inodes;
3d3d35b1	72	const struct proc_ns_operations *ns_ops;
59d8053f	73	struct inode vfs_inode;
3859a271	74	} __randomize_layout;
f2beb798	75
c30480b9 DH	76	/*
	77	* General functions
	78	*/
	79	static inline struct proc_inode PROC_I(const struct inode inode)
	80	{
	81	return container_of(inode, struct proc_inode, vfs_inode);
	82	}
	83
	84	static inline struct proc_dir_entry PDE(const struct inode inode)
	85	{
	86	return PROC_I(inode)->pde;
	87	}
	88
	89	static inline void __PDE_DATA(const struct inode inode)
	90	{
	91	return PDE(inode)->data;
	92	}
fee781e6	93
13b41b09	94	static inline struct pid proc_pid(struct inode inode)
99f89551	95	{
13b41b09	96	return PROC_I(inode)->pid;
99f89551 EB	97	}
	98
	99	static inline struct task_struct get_proc_task(struct inode inode)
1da177e4	100	{
13b41b09	101	return get_pid_task(proc_pid(inode), PIDTYPE_PID);
1da177e4 LT	102	}
1da177e4 LT	103
68eb94f1 EB	104	void task_dump_owner(struct task_struct *task, mode_t mode,
68eb94f1 EB	105	kuid_t ruid, kgid_t rgid);
faf60af1	106
dbcdb504	107	static inline unsigned name_to_int(const struct qstr *qstr)
faf60af1	108	{
dbcdb504 AD	109	const char *name = qstr->name;
dbcdb504 AD	110	int len = qstr->len;
faf60af1 CG	111	unsigned n = 0;
	112
	113	if (len > 1 && *name == '0')
	114	goto out;
	115	while (len-- > 0) {
	116	unsigned c = *name++ - '0';
	117	if (c > 9)
	118	goto out;
	119	if (n >= (~0U-9)/10)
	120	goto out;
	121	n *= 10;
	122	n += c;
	123	}
	124	return n;
	125	out:
	126	return ~0U;
	127	}
	128
1dd704b6	129	/*
59d8053f	130	* Offset of the first process in the /proc root directory..
1dd704b6	131	*/
59d8053f	132	#define FIRST_PROCESS_ENTRY 256
1dd704b6	133
59d8053f DH	134	/* Worst case buffer size needed for holding an integer. */
59d8053f DH	135	#define PROC_NUMBUF 13
881adb85	136
59d8053f DH	137	/*
	138	* array.c
	139	*/
	140	extern const struct file_operations proc_tid_children_operations;
3174c21b	141
59d8053f DH	142	extern int proc_tid_stat(struct seq_file , struct pid_namespace ,
	143	struct pid , struct task_struct );
	144	extern int proc_tgid_stat(struct seq_file , struct pid_namespace ,
	145	struct pid , struct task_struct );
	146	extern int proc_pid_status(struct seq_file , struct pid_namespace ,
	147	struct pid , struct task_struct );
	148	extern int proc_pid_statm(struct seq_file , struct pid_namespace ,
	149	struct pid , struct task_struct );
	150
	151	/*
	152	* base.c
	153	*/
	154	extern const struct dentry_operations pid_dentry_operations;
a528d35e	155	extern int pid_getattr(const struct path , struct kstat , u32, unsigned int);
59d8053f	156	extern int proc_setattr(struct dentry , struct iattr );
db978da8	157	extern struct inode proc_pid_make_inode(struct super_block , struct task_struct *, umode_t);
59d8053f DH	158	extern int pid_revalidate(struct dentry *, unsigned int);
59d8053f DH	159	extern int pid_delete_dentry(const struct dentry *);
f0c3b509	160	extern int proc_pid_readdir(struct file , struct dir_context );
59d8053f DH	161	extern struct dentry proc_pid_lookup(struct inode , struct dentry *, unsigned int);
59d8053f DH	162	extern loff_t mem_lseek(struct file *, loff_t, int);
866ad9a7	163
59d8053f	164	/* Lookups */
c52a47ac	165	typedef int instantiate_t(struct inode , struct dentry ,
59d8053f	166	struct task_struct , const void );
f0c3b509	167	extern bool proc_fill_cache(struct file , struct dir_context , const char *, int,
59d8053f	168	instantiate_t, struct task_struct , const void );
3174c21b	169
59d8053f DH	170	/*
	171	* generic.c
	172	*/
59d8053f DH	173	extern struct dentry proc_lookup(struct inode , struct dentry *, unsigned int);
	174	extern struct dentry proc_lookup_de(struct proc_dir_entry , struct inode *,
	175	struct dentry *);
f0c3b509 AV	176	extern int proc_readdir(struct file , struct dir_context );
f0c3b509 AV	177	extern int proc_readdir_de(struct proc_dir_entry , struct file , struct dir_context *);
3174c21b	178
135d5655 AD	179	static inline struct proc_dir_entry pde_get(struct proc_dir_entry pde)
	180	{
	181	atomic_inc(&pde->count);
	182	return pde;
	183	}
59d8053f	184	extern void pde_put(struct proc_dir_entry *);
3174c21b	185
eb6d38d5 EB	186	static inline bool is_empty_pde(const struct proc_dir_entry *pde)
	187	{
	188	return S_ISDIR(pde->mode) && !pde->proc_iops;
	189	}
eb6d38d5	190
3174c21b	191	/*
59d8053f	192	* inode.c
3174c21b	193	*/
59d8053f DH	194	struct pde_opener {
	195	struct file *file;
	196	struct list_head lh;
f5887c71	197	bool closing;
59d8053f DH	198	struct completion *c;
59d8053f DH	199	};
7e0e953b	200	extern const struct inode_operations proc_link_inode_operations;
6b4e306a	201
59d8053f	202	extern const struct inode_operations proc_pid_link_inode_operations;
6b4e306a	203
59d8053f	204	extern void proc_init_inodecache(void);
1270dd8d	205	void set_proc_pid_nlink(void);
59d8053f	206	extern struct inode proc_get_inode(struct super_block , struct proc_dir_entry *);
e94591d0	207	extern int proc_fill_super(struct super_block , void data, int flags);
59d8053f	208	extern void proc_entry_rundown(struct proc_dir_entry *);
6b4e306a	209
59d8053f DH	210	/*
	211	* proc_namespaces.c
	212	*/
6b4e306a EB	213	extern const struct inode_operations proc_ns_dir_inode_operations;
	214	extern const struct file_operations proc_ns_dir_operations;
	215
59d8053f DH	216	/*
	217	* proc_net.c
	218	*/
	219	extern const struct file_operations proc_net_operations;
	220	extern const struct inode_operations proc_net_inode_operations;
	221
	222	#ifdef CONFIG_NET
	223	extern int proc_net_init(void);
	224	#else
	225	static inline int proc_net_init(void) { return 0; }
	226	#endif
	227
	228	/*
	229	* proc_self.c
	230	*/
021ada7d	231	extern int proc_setup_self(struct super_block *);
34db8aaf	232
0097875b EB	233	/*
	234	* proc_thread_self.c
	235	*/
	236	extern int proc_setup_thread_self(struct super_block *);
	237	extern void proc_thread_self_init(void);
	238
34db8aaf	239	/*
59d8053f	240	* proc_sysctl.c
34db8aaf	241	*/
59d8053f DH	242	#ifdef CONFIG_PROC_SYSCTL
59d8053f DH	243	extern int proc_sys_init(void);
d6cffbbe KK	244	extern void proc_sys_evict_inode(struct inode *inode,
d6cffbbe KK	245	struct ctl_table_header *head);
59d8053f DH	246	#else
59d8053f DH	247	static inline void proc_sys_init(void) { }
d6cffbbe KK	248	static inline void proc_sys_evict_inode(struct inode *inode,
d6cffbbe KK	249	struct ctl_table_header *head) { }
59d8053f	250	#endif
34db8aaf DH	251
	252	/*
	253	* proc_tty.c
	254	*/
	255	#ifdef CONFIG_TTY
	256	extern void proc_tty_init(void);
	257	#else
	258	static inline void proc_tty_init(void) {}
	259	#endif
59d8053f DH	260
	261	/*
	262	* root.c
	263	*/
	264	extern struct proc_dir_entry proc_root;
e94591d0	265	extern int proc_parse_options(char options, struct pid_namespace pid);
59d8053f DH	266
	267	extern void proc_self_init(void);
	268	extern int proc_remount(struct super_block , int , char *);
	269
	270	/*
	271	* task_[no]mmu.c
	272	*/
	273	struct proc_maps_private {
2c03376d	274	struct inode *inode;
59d8053f	275	struct task_struct *task;
29a40ace	276	struct mm_struct *mm;
59d8053f DH	277	#ifdef CONFIG_MMU
	278	struct vm_area_struct *tail_vma;
	279	#endif
	280	#ifdef CONFIG_NUMA
	281	struct mempolicy *task_mempolicy;
	282	#endif
3859a271	283	} __randomize_layout;
59d8053f	284
5381e169 ON	285	struct mm_struct proc_mem_open(struct inode inode, unsigned int mode);
5381e169 ON	286
59d8053f DH	287	extern const struct file_operations proc_pid_maps_operations;
	288	extern const struct file_operations proc_tid_maps_operations;
	289	extern const struct file_operations proc_pid_numa_maps_operations;
	290	extern const struct file_operations proc_tid_numa_maps_operations;
	291	extern const struct file_operations proc_pid_smaps_operations;
	292	extern const struct file_operations proc_tid_smaps_operations;
	293	extern const struct file_operations proc_clear_refs_operations;
	294	extern const struct file_operations proc_pagemap_operations;
	295
	296	extern unsigned long task_vsize(struct mm_struct *);
	297	extern unsigned long task_statm(struct mm_struct *,
	298	unsigned long , unsigned long ,
	299	unsigned long , unsigned long );
	300	extern void task_mem(struct seq_file , struct mm_struct );