[linux-block.git] / include / linux / proc_fs.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * The proc filesystem constants/structures
 */
#ifndef _LINUX_PROC_FS_H
#define _LINUX_PROC_FS_H

#include <linux/compiler.h>
#include <linux/types.h>
#include <linux/fs.h>

struct proc_dir_entry;
struct seq_file;
struct seq_operations;

enum {
	/*
	 * All /proc entries using this ->proc_ops instance are never removed.
	 *
	 * If in doubt, ignore this flag.
	 */
#ifdef MODULE
	PROC_ENTRY_PERMANENT = 0U,
#else
	PROC_ENTRY_PERMANENT = 1U << 0,
#endif
};

struct proc_ops {
	unsigned int proc_flags;
	int	(*proc_open)(struct inode *, struct file *);
	ssize_t	(*proc_read)(struct file *, char __user *, size_t, loff_t *);
	ssize_t (*proc_read_iter)(struct kiocb *, struct iov_iter *);
	ssize_t	(*proc_write)(struct file *, const char __user *, size_t, loff_t *);
	/* mandatory unless nonseekable_open() or equivalent is used */
	loff_t	(*proc_lseek)(struct file *, loff_t, int);
	int	(*proc_release)(struct inode *, struct file *);
	__poll_t (*proc_poll)(struct file *, struct poll_table_struct *);
	long	(*proc_ioctl)(struct file *, unsigned int, unsigned long);
#ifdef CONFIG_COMPAT
	long	(*proc_compat_ioctl)(struct file *, unsigned int, unsigned long);
#endif
	int	(*proc_mmap)(struct file *, struct vm_area_struct *);
	unsigned long (*proc_get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
} __randomize_layout;

/* definitions for hide_pid field */
enum proc_hidepid {
	HIDEPID_OFF	  = 0,
	HIDEPID_NO_ACCESS = 1,
	HIDEPID_INVISIBLE = 2,
	HIDEPID_NOT_PTRACEABLE = 4, /* Limit pids to only ptraceable pids */
};

/* definitions for proc mount option pidonly */
enum proc_pidonly {
	PROC_PIDONLY_OFF = 0,
	PROC_PIDONLY_ON  = 1,
};

struct proc_fs_info {
	struct pid_namespace *pid_ns;
	struct dentry *proc_self;        /* For /proc/self */
	struct dentry *proc_thread_self; /* For /proc/thread-self */
	kgid_t pid_gid;
	enum proc_hidepid hide_pid;
	enum proc_pidonly pidonly;
};

static inline struct proc_fs_info *proc_sb_info(struct super_block *sb)
{
	return sb->s_fs_info;
}

#ifdef CONFIG_PROC_FS

typedef int (*proc_write_t)(struct file *, char *, size_t);

extern void proc_root_init(void);
extern void proc_flush_pid(struct pid *);

extern struct proc_dir_entry *proc_symlink(const char *,
		struct proc_dir_entry *, const char *);
struct proc_dir_entry *_proc_mkdir(const char *, umode_t, struct proc_dir_entry *, void *, bool);
extern struct proc_dir_entry *proc_mkdir(const char *, struct proc_dir_entry *);
extern struct proc_dir_entry *proc_mkdir_data(const char *, umode_t,
					      struct proc_dir_entry *, void *);
extern struct proc_dir_entry *proc_mkdir_mode(const char *, umode_t,
					      struct proc_dir_entry *);
struct proc_dir_entry *proc_create_mount_point(const char *name);

struct proc_dir_entry *proc_create_seq_private(const char *name, umode_t mode,
		struct proc_dir_entry *parent, const struct seq_operations *ops,
		unsigned int state_size, void *data);
#define proc_create_seq_data(name, mode, parent, ops, data) \
	proc_create_seq_private(name, mode, parent, ops, 0, data)
#define proc_create_seq(name, mode, parent, ops) \
	proc_create_seq_private(name, mode, parent, ops, 0, NULL)
struct proc_dir_entry *proc_create_single_data(const char *name, umode_t mode,
		struct proc_dir_entry *parent,
		int (*show)(struct seq_file *, void *), void *data);
#define proc_create_single(name, mode, parent, show) \
	proc_create_single_data(name, mode, parent, show, NULL)
 
extern struct proc_dir_entry *proc_create_data(const char *, umode_t,
					       struct proc_dir_entry *,
					       const struct proc_ops *,
					       void *);

struct proc_dir_entry *proc_create(const char *name, umode_t mode, struct proc_dir_entry *parent, const struct proc_ops *proc_ops);
extern void proc_set_size(struct proc_dir_entry *, loff_t);
extern void proc_set_user(struct proc_dir_entry *, kuid_t, kgid_t);

/*
 * Obtain the private data passed by user through proc_create_data() or
 * related.
 */
static inline void *pde_data(const struct inode *inode)
{
	return inode->i_private;
}

extern void *proc_get_parent_data(const struct inode *);
extern void proc_remove(struct proc_dir_entry *);
extern void remove_proc_entry(const char *, struct proc_dir_entry *);
extern int remove_proc_subtree(const char *, struct proc_dir_entry *);

struct proc_dir_entry *proc_create_net_data(const char *name, umode_t mode,
		struct proc_dir_entry *parent, const struct seq_operations *ops,
		unsigned int state_size, void *data);
#define proc_create_net(name, mode, parent, ops, state_size) \
	proc_create_net_data(name, mode, parent, ops, state_size, NULL)
struct proc_dir_entry *proc_create_net_single(const char *name, umode_t mode,
		struct proc_dir_entry *parent,
		int (*show)(struct seq_file *, void *), void *data);
struct proc_dir_entry *proc_create_net_data_write(const char *name, umode_t mode,
						  struct proc_dir_entry *parent,
						  const struct seq_operations *ops,
						  proc_write_t write,
						  unsigned int state_size, void *data);
struct proc_dir_entry *proc_create_net_single_write(const char *name, umode_t mode,
						    struct proc_dir_entry *parent,
						    int (*show)(struct seq_file *, void *),
						    proc_write_t write,
						    void *data);
extern struct pid *tgid_pidfd_to_pid(const struct file *file);

struct bpf_iter_aux_info;
extern int bpf_iter_init_seq_net(void *priv_data, struct bpf_iter_aux_info *aux);
extern void bpf_iter_fini_seq_net(void *priv_data);

#ifdef CONFIG_PROC_PID_ARCH_STATUS
/*
 * The architecture which selects CONFIG_PROC_PID_ARCH_STATUS must
 * provide proc_pid_arch_status() definition.
 */
int proc_pid_arch_status(struct seq_file *m, struct pid_namespace *ns,
			struct pid *pid, struct task_struct *task);
#endif /* CONFIG_PROC_PID_ARCH_STATUS */

void arch_report_meminfo(struct seq_file *m);
void arch_proc_pid_thread_features(struct seq_file *m, struct task_struct *task);

#else /* CONFIG_PROC_FS */

static inline void proc_root_init(void)
{
}

static inline void proc_flush_pid(struct pid *pid)
{
}

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_create_mount_point(const char *name) { return NULL; }
static inline struct proc_dir_entry *_proc_mkdir(const char *name, umode_t mode,
		struct proc_dir_entry *parent, void *data, bool force_lookup)
{
	return NULL;
}
static inline struct proc_dir_entry *proc_mkdir_data(const char *name,
	umode_t mode, struct proc_dir_entry *parent, void *data) { return NULL; }
static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
	umode_t mode, struct proc_dir_entry *parent) { return NULL; }
#define proc_create_seq_private(name, mode, parent, ops, size, data) ({NULL;})
#define proc_create_seq_data(name, mode, parent, ops, data) ({NULL;})
#define proc_create_seq(name, mode, parent, ops) ({NULL;})
#define proc_create_single(name, mode, parent, show) ({NULL;})
#define proc_create_single_data(name, mode, parent, show, data) ({NULL;})

static inline struct proc_dir_entry *
proc_create(const char *name, umode_t mode, struct proc_dir_entry *parent,
	    const struct proc_ops *proc_ops)
{ return NULL; }

static inline struct proc_dir_entry *
proc_create_data(const char *name, umode_t mode, struct proc_dir_entry *parent,
		 const struct proc_ops *proc_ops, void *data)
{ return NULL; }

static inline void proc_set_size(struct proc_dir_entry *de, loff_t size) {}
static inline void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) {}
static inline void *pde_data(const struct inode *inode) {BUG(); return NULL;}
static inline void *proc_get_parent_data(const struct inode *inode) { BUG(); return NULL; }

static inline void proc_remove(struct proc_dir_entry *de) {}
#define remove_proc_entry(name, parent) do {} while (0)
static inline int remove_proc_subtree(const char *name, struct proc_dir_entry *parent) { return 0; }

#define proc_create_net_data(name, mode, parent, ops, state_size, data) ({NULL;})
#define proc_create_net_data_write(name, mode, parent, ops, write, state_size, data) ({NULL;})
#define proc_create_net(name, mode, parent, state_size, ops) ({NULL;})
#define proc_create_net_single(name, mode, parent, show, data) ({NULL;})
#define proc_create_net_single_write(name, mode, parent, show, write, data) ({NULL;})

static inline struct pid *tgid_pidfd_to_pid(const struct file *file)
{
	return ERR_PTR(-EBADF);
}

#endif /* CONFIG_PROC_FS */

struct net;

static inline struct proc_dir_entry *proc_net_mkdir(
	struct net *net, const char *name, struct proc_dir_entry *parent)
{
	return _proc_mkdir(name, 0, parent, net, true);
}

struct ns_common;
int open_related_ns(struct ns_common *ns,
		   struct ns_common *(*get_ns)(struct ns_common *ns));

/* get the associated pid namespace for a file in procfs */
static inline struct pid_namespace *proc_pid_ns(struct super_block *sb)
{
	return proc_sb_info(sb)->pid_ns;
}

bool proc_ns_file(const struct file *file);

#endif /* _LINUX_PROC_FS_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	/*
	3	* The proc filesystem constants/structures
	4	*/
59d8053f DH	5	#ifndef _LINUX_PROC_FS_H
59d8053f DH	6	#define _LINUX_PROC_FS_H
1da177e4	7
d919b33d	8	#include <linux/compiler.h>
59d8053f DH	9	#include <linux/types.h>
59d8053f DH	10	#include <linux/fs.h>
1da177e4	11
59d8053f	12	struct proc_dir_entry;
3f3942ac	13	struct seq_file;
fddda2b7	14	struct seq_operations;
1da177e4	15
d919b33d AD	16	enum {
	17	/*
	18	* All /proc entries using this ->proc_ops instance are never removed.
	19	*
	20	* If in doubt, ignore this flag.
	21	*/
	22	#ifdef MODULE
	23	PROC_ENTRY_PERMANENT = 0U,
	24	#else
	25	PROC_ENTRY_PERMANENT = 1U << 0,
	26	#endif
	27	};
	28
d56c0d45	29	struct proc_ops {
d919b33d	30	unsigned int proc_flags;
d56c0d45 AD	31	int (proc_open)(struct inode , struct file *);
d56c0d45 AD	32	ssize_t (proc_read)(struct file , char __user , size_t, loff_t );
fd5a13f4	33	ssize_t (proc_read_iter)(struct kiocb , struct iov_iter *);
d56c0d45	34	ssize_t (proc_write)(struct file , const char __user , size_t, loff_t );
d4455fac	35	/* mandatory unless nonseekable_open() or equivalent is used */
d56c0d45 AD	36	loff_t (proc_lseek)(struct file , loff_t, int);
	37	int (proc_release)(struct inode , struct file *);
	38	__poll_t (proc_poll)(struct file , struct poll_table_struct *);
	39	long (proc_ioctl)(struct file , unsigned int, unsigned long);
	40	#ifdef CONFIG_COMPAT
	41	long (proc_compat_ioctl)(struct file , unsigned int, unsigned long);
	42	#endif
	43	int (proc_mmap)(struct file , struct vm_area_struct *);
	44	unsigned long (proc_get_unmapped_area)(struct file , unsigned long, unsigned long, unsigned long, unsigned long);
d919b33d	45	} __randomize_layout;
d56c0d45	46
fa10fed3	47	/* definitions for hide_pid field */
e61bb8b3	48	enum proc_hidepid {
fa10fed3 AG	49	HIDEPID_OFF = 0,
	50	HIDEPID_NO_ACCESS = 1,
	51	HIDEPID_INVISIBLE = 2,
24a71ce5	52	HIDEPID_NOT_PTRACEABLE = 4, /* Limit pids to only ptraceable pids */
fa10fed3 AG	53	};
fa10fed3 AG	54
6814ef2d	55	/* definitions for proc mount option pidonly */
e61bb8b3	56	enum proc_pidonly {
6814ef2d AG	57	PROC_PIDONLY_OFF = 0,
	58	PROC_PIDONLY_ON = 1,
	59	};
	60
fa10fed3 AG	61	struct proc_fs_info {
	62	struct pid_namespace *pid_ns;
	63	struct dentry proc_self; / For /proc/self */
	64	struct dentry proc_thread_self; / For /proc/thread-self */
	65	kgid_t pid_gid;
e61bb8b3 AG	66	enum proc_hidepid hide_pid;
e61bb8b3 AG	67	enum proc_pidonly pidonly;
fa10fed3 AG	68	};
	69
	70	static inline struct proc_fs_info proc_sb_info(struct super_block sb)
	71	{
	72	return sb->s_fs_info;
	73	}
	74
1da177e4 LT	75	#ifdef CONFIG_PROC_FS
1da177e4 LT	76
564def71 DH	77	typedef int (proc_write_t)(struct file , char *, size_t);
564def71 DH	78
1da177e4	79	extern void proc_root_init(void);
7bc3e6e5	80	extern void proc_flush_pid(struct pid *);
1da177e4	81
1da177e4 LT	82	extern struct proc_dir_entry proc_symlink(const char ,
1da177e4 LT	83	struct proc_dir_entry , const char );
c6c75ded	84	struct proc_dir_entry _proc_mkdir(const char , umode_t, struct proc_dir_entry , void , bool);
59d8053f	85	extern struct proc_dir_entry proc_mkdir(const char , struct proc_dir_entry *);
270b5ac2 DH	86	extern struct proc_dir_entry proc_mkdir_data(const char , umode_t,
270b5ac2 DH	87	struct proc_dir_entry , void );
59d8053f DH	88	extern struct proc_dir_entry proc_mkdir_mode(const char , umode_t,
59d8053f DH	89	struct proc_dir_entry *);
f97df70b	90	struct proc_dir_entry proc_create_mount_point(const char name);
fddda2b7	91
44414d82	92	struct proc_dir_entry proc_create_seq_private(const char name, umode_t mode,
fddda2b7	93	struct proc_dir_entry parent, const struct seq_operations ops,
44414d82 CH	94	unsigned int state_size, void *data);
	95	#define proc_create_seq_data(name, mode, parent, ops, data) \
	96	proc_create_seq_private(name, mode, parent, ops, 0, data)
fddda2b7	97	#define proc_create_seq(name, mode, parent, ops) \
44414d82	98	proc_create_seq_private(name, mode, parent, ops, 0, NULL)
3f3942ac CH	99	struct proc_dir_entry proc_create_single_data(const char name, umode_t mode,
	100	struct proc_dir_entry *parent,
	101	int (show)(struct seq_file , void ), void data);
	102	#define proc_create_single(name, mode, parent, show) \
	103	proc_create_single_data(name, mode, parent, show, NULL)
59d8053f DH	104
	105	extern struct proc_dir_entry proc_create_data(const char , umode_t,
	106	struct proc_dir_entry *,
d56c0d45	107	const struct proc_ops *,
59d8053f DH	108	void *);
59d8053f DH	109
d56c0d45	110	struct proc_dir_entry proc_create(const char name, umode_t mode, struct proc_dir_entry parent, const struct proc_ops proc_ops);
271a15ea DH	111	extern void proc_set_size(struct proc_dir_entry *, loff_t);
271a15ea DH	112	extern void proc_set_user(struct proc_dir_entry *, kuid_t, kgid_t);
6dfbbae1 MS	113
	114	/*
	115	* Obtain the private data passed by user through proc_create_data() or
	116	* related.
	117	*/
	118	static inline void pde_data(const struct inode inode)
	119	{
	120	return inode->i_private;
	121	}
	122
4a520d27	123	extern void proc_get_parent_data(const struct inode );
59d8053f DH	124	extern void proc_remove(struct proc_dir_entry *);
	125	extern void remove_proc_entry(const char , struct proc_dir_entry );
	126	extern int remove_proc_subtree(const char , struct proc_dir_entry );
	127
c3506372 CH	128	struct proc_dir_entry proc_create_net_data(const char name, umode_t mode,
	129	struct proc_dir_entry parent, const struct seq_operations ops,
	130	unsigned int state_size, void *data);
9573e8f7 ML	131	#define proc_create_net(name, mode, parent, ops, state_size) \
9573e8f7 ML	132	proc_create_net_data(name, mode, parent, ops, state_size, NULL)
3617d949 CH	133	struct proc_dir_entry proc_create_net_single(const char name, umode_t mode,
	134	struct proc_dir_entry *parent,
	135	int (show)(struct seq_file , void ), void data);
564def71 DH	136	struct proc_dir_entry proc_create_net_data_write(const char name, umode_t mode,
	137	struct proc_dir_entry *parent,
	138	const struct seq_operations *ops,
	139	proc_write_t write,
	140	unsigned int state_size, void *data);
	141	struct proc_dir_entry proc_create_net_single_write(const char name, umode_t mode,
	142	struct proc_dir_entry *parent,
	143	int (show)(struct seq_file , void *),
	144	proc_write_t write,
	145	void *data);
3eb39f47	146	extern struct pid tgid_pidfd_to_pid(const struct file file);
c3506372	147
f9c79272 YS	148	struct bpf_iter_aux_info;
f9c79272 YS	149	extern int bpf_iter_init_seq_net(void priv_data, struct bpf_iter_aux_info aux);
138d0be3 YS	150	extern void bpf_iter_fini_seq_net(void *priv_data);
138d0be3 YS	151
68bc30bb AL	152	#ifdef CONFIG_PROC_PID_ARCH_STATUS
	153	/*
	154	* The architecture which selects CONFIG_PROC_PID_ARCH_STATUS must
	155	* provide proc_pid_arch_status() definition.
	156	*/
	157	int proc_pid_arch_status(struct seq_file m, struct pid_namespace ns,
	158	struct pid pid, struct task_struct task);
	159	#endif /* CONFIG_PROC_PID_ARCH_STATUS */
	160
ef104443	161	void arch_report_meminfo(struct seq_file *m);
0ee44885	162	void arch_proc_pid_thread_features(struct seq_file m, struct task_struct task);
ef104443	163
59d8053f	164	#else /* CONFIG_PROC_FS */
1da177e4	165
647f010b AM	166	static inline void proc_root_init(void)
	167	{
	168	}
	169
7bc3e6e5	170	static inline void proc_flush_pid(struct pid *pid)
60347f67 PE	171	{
60347f67 PE	172	}
1da177e4	173
1da177e4	174	static inline struct proc_dir_entry proc_symlink(const char name,
59d8053f	175	struct proc_dir_entry parent,const char dest) { return NULL;}
1da177e4 LT	176	static inline struct proc_dir_entry proc_mkdir(const char name,
1da177e4 LT	177	struct proc_dir_entry *parent) {return NULL;}
f97df70b	178	static inline struct proc_dir_entry proc_create_mount_point(const char name) { return NULL; }
c6c75ded AD	179	static inline struct proc_dir_entry _proc_mkdir(const char name, umode_t mode,
	180	struct proc_dir_entry parent, void data, bool force_lookup)
	181	{
	182	return NULL;
	183	}
270b5ac2 DH	184	static inline struct proc_dir_entry proc_mkdir_data(const char name,
270b5ac2 DH	185	umode_t mode, struct proc_dir_entry parent, void data) { return NULL; }
f12a20fc	186	static inline struct proc_dir_entry proc_mkdir_mode(const char name,
d161a13f	187	umode_t mode, struct proc_dir_entry *parent) { return NULL; }
3f3942ac	188	#define proc_create_seq_private(name, mode, parent, ops, size, data) ({NULL;})
fddda2b7 CH	189	#define proc_create_seq_data(name, mode, parent, ops, data) ({NULL;})
fddda2b7 CH	190	#define proc_create_seq(name, mode, parent, ops) ({NULL;})
3f3942ac CH	191	#define proc_create_single(name, mode, parent, show) ({NULL;})
3f3942ac CH	192	#define proc_create_single_data(name, mode, parent, show, data) ({NULL;})
ae62fbe2 HG	193
	194	static inline struct proc_dir_entry *
	195	proc_create(const char name, umode_t mode, struct proc_dir_entry parent,
	196	const struct proc_ops *proc_ops)
	197	{ return NULL; }
	198
	199	static inline struct proc_dir_entry *
	200	proc_create_data(const char name, umode_t mode, struct proc_dir_entry parent,
	201	const struct proc_ops proc_ops, void data)
	202	{ return NULL; }
59d8053f	203
271a15ea DH	204	static inline void proc_set_size(struct proc_dir_entry *de, loff_t size) {}
271a15ea DH	205	static inline void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) {}
359745d7	206	static inline void pde_data(const struct inode inode) {BUG(); return NULL;}
59d8053f	207	static inline void proc_get_parent_data(const struct inode inode) { BUG(); return NULL; }
1da177e4	208
59d8053f DH	209	static inline void proc_remove(struct proc_dir_entry *de) {}
	210	#define remove_proc_entry(name, parent) do {} while (0)
	211	static inline int remove_proc_subtree(const char name, struct proc_dir_entry parent) { return 0; }
9043476f	212
c3506372	213	#define proc_create_net_data(name, mode, parent, ops, state_size, data) ({NULL;})
c3d96f69	214	#define proc_create_net_data_write(name, mode, parent, ops, write, state_size, data) ({NULL;})
c3506372	215	#define proc_create_net(name, mode, parent, state_size, ops) ({NULL;})
3617d949	216	#define proc_create_net_single(name, mode, parent, show, data) ({NULL;})
c3d96f69	217	#define proc_create_net_single_write(name, mode, parent, show, write, data) ({NULL;})
c3506372	218
3eb39f47 CB	219	static inline struct pid tgid_pidfd_to_pid(const struct file file)
	220	{
	221	return ERR_PTR(-EBADF);
	222	}
	223
59d8053f	224	#endif /* CONFIG_PROC_FS */
1da177e4	225
f7790029 JL	226	struct net;
f7790029 JL	227
270b5ac2 DH	228	static inline struct proc_dir_entry *proc_net_mkdir(
	229	struct net net, const char name, struct proc_dir_entry *parent)
	230	{
c6c75ded	231	return _proc_mkdir(name, 0, parent, net, true);
270b5ac2 DH	232	}
270b5ac2 DH	233
c62cce2c AV	234	struct ns_common;
	235	int open_related_ns(struct ns_common *ns,
	236	struct ns_common (get_ns)(struct ns_common *ns));
	237
76f668be	238	/* get the associated pid namespace for a file in procfs */
9d78edea	239	static inline struct pid_namespace proc_pid_ns(struct super_block sb)
76f668be	240	{
9d78edea	241	return proc_sb_info(sb)->pid_ns;
76f668be CH	242	}
76f668be CH	243
303cc571 CB	244	bool proc_ns_file(const struct file *file);
303cc571 CB	245
1da177e4	246	#endif /* _LINUX_PROC_FS_H */