[linux-2.6-block.git] / fs / proc / internal.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/* Internal procfs definitions
 *
 * Copyright (C) 2004 Red Hat, Inc. All Rights Reserved.
 * Written by David Howells (dhowells@redhat.com)
 */

#include <linux/proc_fs.h>
#include <linux/proc_ns.h>
#include <linux/refcount.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 {
	/*
	 * number of callers into module in progress;
	 * negative -> it's going away RSN
	 */
	atomic_t in_use;
	refcount_t refcnt;
	struct list_head pde_openers;	/* who did ->open, but not ->release */
	/* protects ->pde_openers and all struct pde_opener instances */
	spinlock_t pde_unload_lock;
	struct completion *pde_unload_completion;
	const struct inode_operations *proc_iops;
	const struct file_operations *proc_fops;
	const struct dentry_operations *proc_dops;
	union {
		const struct seq_operations *seq_ops;
		int (*single_show)(struct seq_file *, void *);
	};
	proc_write_t write;
	void *data;
	unsigned int state_size;
	unsigned int low_ino;
	nlink_t nlink;
	kuid_t uid;
	kgid_t gid;
	loff_t size;
	struct proc_dir_entry *parent;
	struct rb_root subdir;
	struct rb_node subdir_node;
	char *name;
	umode_t mode;
	u8 namelen;
	char inline_name[];
} __randomize_layout;

#define SIZEOF_PDE	(				\
	sizeof(struct proc_dir_entry) < 128 ? 128 :	\
	sizeof(struct proc_dir_entry) < 192 ? 192 :	\
	sizeof(struct proc_dir_entry) < 256 ? 256 :	\
	sizeof(struct proc_dir_entry) < 512 ? 512 :	\
	0)
#define SIZEOF_PDE_INLINE_NAME (SIZEOF_PDE - sizeof(struct proc_dir_entry))

extern struct kmem_cache *proc_dir_entry_cache;
void pde_free(struct proc_dir_entry *pde);

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(const struct inode *inode)
{
	return PROC_I(inode)->pid;
}

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

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

unsigned name_to_int(const struct qstr *qstr);
/*
 * 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 void proc_task_name(struct seq_file *m, struct task_struct *p,
			   bool escape);
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 void pid_update_inode(struct task_struct *, struct inode *);
extern int pid_delete_dentry(const struct dentry *);
extern int proc_pid_readdir(struct file *, struct dir_context *);
struct dentry *proc_pid_lookup(struct dentry *, unsigned int);
extern loff_t mem_lseek(struct file *, loff_t, int);

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

/*
 * generic.c
 */
struct proc_dir_entry *proc_create_reg(const char *name, umode_t mode,
		struct proc_dir_entry **parent, void *data);
struct proc_dir_entry *proc_register(struct proc_dir_entry *dir,
		struct proc_dir_entry *dp);
extern struct dentry *proc_lookup(struct inode *, struct dentry *, unsigned int);
struct dentry *proc_lookup_de(struct inode *, struct dentry *, struct proc_dir_entry *);
extern int proc_readdir(struct file *, struct dir_context *);
int proc_readdir_de(struct file *, struct dir_context *, struct proc_dir_entry *);

static inline struct proc_dir_entry *pde_get(struct proc_dir_entry *pde)
{
	refcount_inc(&pde->refcnt);
	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;
}
extern ssize_t proc_simple_write(struct file *, const char __user *, size_t, loff_t *);

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

void proc_init_kmemcache(void);
void set_proc_pid_nlink(void);
extern struct inode *proc_get_inode(struct super_block *, struct proc_dir_entry *);
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 void proc_self_init(void);

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