[linux.git] / fs / 9p / v9fs.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * V9FS definitions.
 *
 *  Copyright (C) 2004-2008 by Eric Van Hensbergen <[email protected]>
 *  Copyright (C) 2002 by Ron Minnich <[email protected]>
 */
#ifndef FS_9P_V9FS_H
#define FS_9P_V9FS_H

#include <linux/backing-dev.h>
#include <linux/netfs.h>

/**
 * enum p9_session_flags - option flags for each 9P session
 * @V9FS_PROTO_2000U: whether or not to use 9P2000.u extensions
 * @V9FS_PROTO_2000L: whether or not to use 9P2000.l extensions
 * @V9FS_ACCESS_SINGLE: only the mounting user can access the hierarchy
 * @V9FS_ACCESS_USER: a new attach will be issued for every user (default)
 * @V9FS_ACCESS_CLIENT: Just like user, but access check is performed on client.
 * @V9FS_ACCESS_ANY: use a single attach for all users
 * @V9FS_ACCESS_MASK: bit mask of different ACCESS options
 * @V9FS_POSIX_ACL: POSIX ACLs are enforced
 *
 * Session flags reflect options selected by users at mount time
 */
#define	V9FS_ACCESS_ANY (V9FS_ACCESS_SINGLE | \
			 V9FS_ACCESS_USER |   \
			 V9FS_ACCESS_CLIENT)
#define V9FS_ACCESS_MASK V9FS_ACCESS_ANY
#define V9FS_ACL_MASK V9FS_POSIX_ACL

enum p9_session_flags {
	V9FS_PROTO_2000U    = 0x01,
	V9FS_PROTO_2000L    = 0x02,
	V9FS_ACCESS_SINGLE  = 0x04,
	V9FS_ACCESS_USER    = 0x08,
	V9FS_ACCESS_CLIENT  = 0x10,
	V9FS_POSIX_ACL      = 0x20,
	V9FS_NO_XATTR       = 0x40,
	V9FS_IGNORE_QV      = 0x80, /* ignore qid.version for cache hints */
	V9FS_DIRECT_IO      = 0x100,
	V9FS_SYNC           = 0x200
};

/**
 * enum p9_cache_shortcuts - human readable cache preferences
 * @CACHE_SC_NONE: disable all caches
 * @CACHE_SC_READAHEAD: only provide caching for readahead
 * @CACHE_SC_MMAP: provide caching to enable mmap
 * @CACHE_SC_LOOSE: non-coherent caching for files and meta data
 * @CACHE_SC_FSCACHE: persistent non-coherent caching for files and meta-data
 *
 */

enum p9_cache_shortcuts {
	CACHE_SC_NONE       = 0b00000000,
	CACHE_SC_READAHEAD  = 0b00000001,
	CACHE_SC_MMAP       = 0b00000101,
	CACHE_SC_LOOSE      = 0b00001111,
	CACHE_SC_FSCACHE    = 0b10001111,
};

/**
 * enum p9_cache_bits - possible values of ->cache
 * @CACHE_NONE: caches disabled
 * @CACHE_FILE: file caching (open to close)
 * @CACHE_META: meta-data and directory caching
 * @CACHE_WRITEBACK: write-back caching for files
 * @CACHE_LOOSE: don't check cache consistency
 * @CACHE_FSCACHE: local persistent caches
 *
 */

enum p9_cache_bits {
	CACHE_NONE          = 0b00000000,
	CACHE_FILE          = 0b00000001,
	CACHE_META          = 0b00000010,
	CACHE_WRITEBACK     = 0b00000100,
	CACHE_LOOSE         = 0b00001000,
	CACHE_FSCACHE       = 0b10000000,
};

/**
 * struct v9fs_session_info - per-instance session information
 * @flags: session options of type &p9_session_flags
 * @nodev: set to 1 to disable device mapping
 * @debug: debug level
 * @afid: authentication handle
 * @cache: cache mode of type &p9_cache_bits
 * @cachetag: the tag of the cache associated with this session
 * @fscache: session cookie associated with FS-Cache
 * @uname: string user name to mount hierarchy as
 * @aname: mount specifier for remote hierarchy
 * @maxdata: maximum data to be sent/recvd per protocol message
 * @dfltuid: default numeric userid to mount hierarchy as
 * @dfltgid: default numeric groupid to mount hierarchy as
 * @uid: if %V9FS_ACCESS_SINGLE, the numeric uid which mounted the hierarchy
 * @clnt: reference to 9P network client instantiated for this session
 * @slist: reference to list of registered 9p sessions
 *
 * This structure holds state for each session instance established during
 * a sys_mount() .
 *
 * Bugs: there seems to be a lot of state which could be condensed and/or
 * removed.
 */

struct v9fs_session_info {
	/* options */
	unsigned int flags;
	unsigned char nodev;
	unsigned short debug;
	unsigned int afid;
	unsigned int cache;
#ifdef CONFIG_9P_FSCACHE
	char *cachetag;
	struct fscache_volume *fscache;
#endif

	char *uname;		/* user name to mount as */
	char *aname;		/* name of remote hierarchy being mounted */
	unsigned int maxdata;	/* max data for client interface */
	kuid_t dfltuid;		/* default uid/muid for legacy support */
	kgid_t dfltgid;		/* default gid for legacy support */
	kuid_t uid;		/* if ACCESS_SINGLE, the uid that has access */
	struct p9_client *clnt;	/* 9p client */
	struct list_head slist; /* list of sessions registered with v9fs */
	struct rw_semaphore rename_sem;
	long session_lock_timeout; /* retry interval for blocking locks */
};

/* cache_validity flags */
#define V9FS_INO_INVALID_ATTR 0x01

struct v9fs_inode {
	struct netfs_inode netfs; /* Netfslib context and vfs inode */
	struct p9_qid qid;
	unsigned int cache_validity;
	struct mutex v_mutex;
};

static inline struct v9fs_inode *V9FS_I(const struct inode *inode)
{
	return container_of(inode, struct v9fs_inode, netfs.inode);
}

static inline struct fscache_cookie *v9fs_inode_cookie(struct v9fs_inode *v9inode)
{
#ifdef CONFIG_9P_FSCACHE
	return netfs_i_cookie(&v9inode->netfs);
#else
	return NULL;
#endif
}

static inline struct fscache_volume *v9fs_session_cache(struct v9fs_session_info *v9ses)
{
#ifdef CONFIG_9P_FSCACHE
	return v9ses->fscache;
#else
	return NULL;
#endif
}


extern int v9fs_show_options(struct seq_file *m, struct dentry *root);

struct p9_fid *v9fs_session_init(struct v9fs_session_info *v9ses,
				 const char *dev_name, char *data);
extern void v9fs_session_close(struct v9fs_session_info *v9ses);
extern void v9fs_session_cancel(struct v9fs_session_info *v9ses);
extern void v9fs_session_begin_cancel(struct v9fs_session_info *v9ses);
extern struct dentry *v9fs_vfs_lookup(struct inode *dir, struct dentry *dentry,
				      unsigned int flags);
extern int v9fs_vfs_unlink(struct inode *i, struct dentry *d);
extern int v9fs_vfs_rmdir(struct inode *i, struct dentry *d);
extern int v9fs_vfs_rename(struct mnt_idmap *idmap,
			   struct inode *old_dir, struct dentry *old_dentry,
			   struct inode *new_dir, struct dentry *new_dentry,
			   unsigned int flags);
extern struct inode *v9fs_inode_from_fid(struct v9fs_session_info *v9ses,
					 struct p9_fid *fid,
					 struct super_block *sb, int new);
extern const struct inode_operations v9fs_dir_inode_operations_dotl;
extern const struct inode_operations v9fs_file_inode_operations_dotl;
extern const struct inode_operations v9fs_symlink_inode_operations_dotl;
extern const struct netfs_request_ops v9fs_req_ops;
extern struct inode *v9fs_inode_from_fid_dotl(struct v9fs_session_info *v9ses,
					      struct p9_fid *fid,
					      struct super_block *sb, int new);

/* other default globals */
#define V9FS_PORT	564
#define V9FS_DEFUSER	"nobody"
#define V9FS_DEFANAME	""
#define V9FS_DEFUID	KUIDT_INIT(-2)
#define V9FS_DEFGID	KGIDT_INIT(-2)

static inline struct v9fs_session_info *v9fs_inode2v9ses(struct inode *inode)
{
	return inode->i_sb->s_fs_info;
}

static inline struct v9fs_session_info *v9fs_dentry2v9ses(struct dentry *dentry)
{
	return dentry->d_sb->s_fs_info;
}

static inline int v9fs_proto_dotu(struct v9fs_session_info *v9ses)
{
	return v9ses->flags & V9FS_PROTO_2000U;
}

static inline int v9fs_proto_dotl(struct v9fs_session_info *v9ses)
{
	return v9ses->flags & V9FS_PROTO_2000L;
}

/**
 * v9fs_get_inode_from_fid - Helper routine to populate an inode by
 * issuing a attribute request
 * @v9ses: session information
 * @fid: fid to issue attribute request for
 * @sb: superblock on which to create inode
 *
 */
static inline struct inode *
v9fs_get_inode_from_fid(struct v9fs_session_info *v9ses, struct p9_fid *fid,
			struct super_block *sb)
{
	if (v9fs_proto_dotl(v9ses))
		return v9fs_inode_from_fid_dotl(v9ses, fid, sb, 0);
	else
		return v9fs_inode_from_fid(v9ses, fid, sb, 0);
}

/**
 * v9fs_get_new_inode_from_fid - Helper routine to populate an inode by
 * issuing a attribute request
 * @v9ses: session information
 * @fid: fid to issue attribute request for
 * @sb: superblock on which to create inode
 *
 */
static inline struct inode *
v9fs_get_new_inode_from_fid(struct v9fs_session_info *v9ses, struct p9_fid *fid,
			    struct super_block *sb)
{
	if (v9fs_proto_dotl(v9ses))
		return v9fs_inode_from_fid_dotl(v9ses, fid, sb, 1);
	else
		return v9fs_inode_from_fid(v9ses, fid, sb, 1);
}

#endif
Commit	Line	Data
1f327613	1	/* SPDX-License-Identifier: GPL-2.0-only */
9e82cf6a EVH	2	/*
	3	* V9FS definitions.
	4	*
8a0dc95f	5	* Copyright (C) 2004-2008 by Eric Van Hensbergen <[email protected]>
9e82cf6a	6	* Copyright (C) 2002 by Ron Minnich <[email protected]>
9e82cf6a	7	*/
e0459f57 AK	8	#ifndef FS_9P_V9FS_H
	9	#define FS_9P_V9FS_H
	10
0ed07ddb	11	#include <linux/backing-dev.h>
bc899ee1	12	#include <linux/netfs.h>
9e82cf6a	13
ee443996 EVH	14	/**
ee443996 EVH	15	* enum p9_session_flags - option flags for each 9P session
dd6102fb	16	* @V9FS_PROTO_2000U: whether or not to use 9P2000.u extensions
45bc21ed	17	* @V9FS_PROTO_2000L: whether or not to use 9P2000.l extensions
ee443996 EVH	18	* @V9FS_ACCESS_SINGLE: only the mounting user can access the hierarchy
ee443996 EVH	19	* @V9FS_ACCESS_USER: a new attach will be issued for every user (default)
e782ef71	20	* @V9FS_ACCESS_CLIENT: Just like user, but access check is performed on client.
ee443996 EVH	21	* @V9FS_ACCESS_ANY: use a single attach for all users
ee443996 EVH	22	* @V9FS_ACCESS_MASK: bit mask of different ACCESS options
e782ef71	23	* @V9FS_POSIX_ACL: POSIX ACLs are enforced
ee443996 EVH	24	*
	25	* Session flags reflect options selected by users at mount time
	26	*/
76381a42 AK	27	#define V9FS_ACCESS_ANY (V9FS_ACCESS_SINGLE \| \
	28	V9FS_ACCESS_USER \| \
	29	V9FS_ACCESS_CLIENT)
	30	#define V9FS_ACCESS_MASK V9FS_ACCESS_ANY
e782ef71	31	#define V9FS_ACL_MASK V9FS_POSIX_ACL
76381a42	32
ee443996	33	enum p9_session_flags {
4eb31178 EVH	34	V9FS_PROTO_2000U = 0x01,
	35	V9FS_PROTO_2000L = 0x02,
	36	V9FS_ACCESS_SINGLE = 0x04,
	37	V9FS_ACCESS_USER = 0x08,
	38	V9FS_ACCESS_CLIENT = 0x10,
	39	V9FS_POSIX_ACL = 0x20,
	40	V9FS_NO_XATTR = 0x40,
	41	V9FS_IGNORE_QV = 0x80, /* ignore qid.version for cache hints */
	42	V9FS_DIRECT_IO = 0x100,
	43	V9FS_SYNC = 0x200
ee443996 EVH	44	};
ee443996 EVH	45
ee443996	46	/**
4eb31178 EVH	47	* enum p9_cache_shortcuts - human readable cache preferences
	48	* @CACHE_SC_NONE: disable all caches
	49	* @CACHE_SC_READAHEAD: only provide caching for readahead
	50	* @CACHE_SC_MMAP: provide caching to enable mmap
	51	* @CACHE_SC_LOOSE: non-coherent caching for files and meta data
	52	* @CACHE_SC_FSCACHE: persistent non-coherent caching for files and meta-data
ee443996	53	*
ee443996 EVH	54	*/
ee443996 EVH	55
4eb31178 EVH	56	enum p9_cache_shortcuts {
	57	CACHE_SC_NONE = 0b00000000,
	58	CACHE_SC_READAHEAD = 0b00000001,
	59	CACHE_SC_MMAP = 0b00000101,
	60	CACHE_SC_LOOSE = 0b00001111,
	61	CACHE_SC_FSCACHE = 0b10001111,
	62	};
	63
	64	/**
	65	* enum p9_cache_bits - possible values of ->cache
	66	* @CACHE_NONE: caches disabled
	67	* @CACHE_FILE: file caching (open to close)
	68	* @CACHE_META: meta-data and directory caching
	69	* @CACHE_WRITEBACK: write-back caching for files
	70	* @CACHE_LOOSE: don't check cache consistency
	71	* @CACHE_FSCACHE: local persistent caches
	72	*
	73	*/
	74
	75	enum p9_cache_bits {
	76	CACHE_NONE = 0b00000000,
	77	CACHE_FILE = 0b00000001,
	78	CACHE_META = 0b00000010,
	79	CACHE_WRITEBACK = 0b00000100,
	80	CACHE_LOOSE = 0b00001000,
	81	CACHE_FSCACHE = 0b10000000,
ee443996 EVH	82	};
	83
	84	/**
	85	* struct v9fs_session_info - per-instance session information
	86	* @flags: session options of type &p9_session_flags
	87	* @nodev: set to 1 to disable device mapping
	88	* @debug: debug level
	89	* @afid: authentication handle
4eb31178	90	* @cache: cache mode of type &p9_cache_bits
60e78d2c AK	91	* @cachetag: the tag of the cache associated with this session
60e78d2c AK	92	* @fscache: session cookie associated with FS-Cache
ee443996 EVH	93	* @uname: string user name to mount hierarchy as
	94	* @aname: mount specifier for remote hierarchy
	95	* @maxdata: maximum data to be sent/recvd per protocol message
	96	* @dfltuid: default numeric userid to mount hierarchy as
	97	* @dfltgid: default numeric groupid to mount hierarchy as
	98	* @uid: if %V9FS_ACCESS_SINGLE, the numeric uid which mounted the hierarchy
	99	* @clnt: reference to 9P network client instantiated for this session
60e78d2c	100	* @slist: reference to list of registered 9p sessions
ee443996 EVH	101	*
	102	* This structure holds state for each session instance established during
	103	* a sys_mount() .
	104	*
	105	* Bugs: there seems to be a lot of state which could be condensed and/or
	106	* removed.
	107	*/
9e82cf6a EVH	108
	109	struct v9fs_session_info {
	110	/* options */
95f41d87	111	unsigned int flags;
ee443996 EVH	112	unsigned char nodev;
	113	unsigned short debug;
	114	unsigned int afid;
	115	unsigned int cache;
60e78d2c AK	116	#ifdef CONFIG_9P_FSCACHE
60e78d2c AK	117	char *cachetag;
24e42e32	118	struct fscache_volume *fscache;
60e78d2c	119	#endif
9e82cf6a	120
ba17674f LI	121	char uname; / user name to mount as */
ba17674f LI	122	char aname; / name of remote hierarchy being mounted */
8a0dc95f	123	unsigned int maxdata; /* max data for client interface */
76ed23a5 EB	124	kuid_t dfltuid; /* default uid/muid for legacy support */
	125	kgid_t dfltgid; /* default gid for legacy support */
	126	kuid_t uid; /* if ACCESS_SINGLE, the uid that has access */
bd238fb4	127	struct p9_client clnt; / 9p client */
60e78d2c	128	struct list_head slist; /* list of sessions registered with v9fs */
a534c8d1	129	struct rw_semaphore rename_sem;
5e172f75	130	long session_lock_timeout; /* retry interval for blocking locks */
9e82cf6a EVH	131	};
9e82cf6a EVH	132
b3cbea03 AK	133	/* cache_validity flags */
	134	#define V9FS_INO_INVALID_ATTR 0x01
	135
a78ce05d	136	struct v9fs_inode {
874c8ca1	137	struct netfs_inode netfs; /* Netfslib context and vfs inode */
fd2421f5	138	struct p9_qid qid;
b3cbea03	139	unsigned int cache_validity;
5a7e0a8c	140	struct mutex v_mutex;
a78ce05d AK	141	};
	142
	143	static inline struct v9fs_inode V9FS_I(const struct inode inode)
	144	{
874c8ca1	145	return container_of(inode, struct v9fs_inode, netfs.inode);
a78ce05d AK	146	}
a78ce05d AK	147
eb497943 DH	148	static inline struct fscache_cookie v9fs_inode_cookie(struct v9fs_inode v9inode)
	149	{
	150	#ifdef CONFIG_9P_FSCACHE
e81fb419	151	return netfs_i_cookie(&v9inode->netfs);
eb497943 DH	152	#else
	153	return NULL;
	154	#endif
	155	}
	156
24e42e32 DH	157	static inline struct fscache_volume v9fs_session_cache(struct v9fs_session_info v9ses)
	158	{
	159	#ifdef CONFIG_9P_FSCACHE
	160	return v9ses->fscache;
	161	#else
	162	return NULL;
	163	#endif
	164	}
	165
	166
c4fac910 DH	167	extern int v9fs_show_options(struct seq_file m, struct dentry root);
c4fac910 DH	168
772712c5 SM	169	struct p9_fid v9fs_session_init(struct v9fs_session_info v9ses,
772712c5 SM	170	const char dev_name, char data);
53c06f4e AK	171	extern void v9fs_session_close(struct v9fs_session_info *v9ses);
	172	extern void v9fs_session_cancel(struct v9fs_session_info *v9ses);
	173	extern void v9fs_session_begin_cancel(struct v9fs_session_info *v9ses);
	174	extern struct dentry v9fs_vfs_lookup(struct inode dir, struct dentry *dentry,
772712c5	175	unsigned int flags);
53c06f4e AK	176	extern int v9fs_vfs_unlink(struct inode i, struct dentry d);
53c06f4e AK	177	extern int v9fs_vfs_rmdir(struct inode i, struct dentry d);
e18275ae	178	extern int v9fs_vfs_rename(struct mnt_idmap *idmap,
549c7297	179	struct inode old_dir, struct dentry old_dentry,
1cd66c93 MS	180	struct inode new_dir, struct dentry new_dentry,
1cd66c93 MS	181	unsigned int flags);
a78ce05d AK	182	extern struct inode v9fs_inode_from_fid(struct v9fs_session_info v9ses,
a78ce05d AK	183	struct p9_fid *fid,
ed80fcfa	184	struct super_block *sb, int new);
53c06f4e AK	185	extern const struct inode_operations v9fs_dir_inode_operations_dotl;
	186	extern const struct inode_operations v9fs_file_inode_operations_dotl;
	187	extern const struct inode_operations v9fs_symlink_inode_operations_dotl;
bc899ee1	188	extern const struct netfs_request_ops v9fs_req_ops;
a78ce05d AK	189	extern struct inode v9fs_inode_from_fid_dotl(struct v9fs_session_info v9ses,
a78ce05d AK	190	struct p9_fid *fid,
ed80fcfa	191	struct super_block *sb, int new);
9e82cf6a	192
9e82cf6a	193	/* other default globals */
bd32b82d	194	#define V9FS_PORT 564
9e82cf6a EVH	195	#define V9FS_DEFUSER "nobody"
9e82cf6a EVH	196	#define V9FS_DEFANAME ""
76ed23a5 EB	197	#define V9FS_DEFUID KUIDT_INIT(-2)
76ed23a5 EB	198	#define V9FS_DEFGID KGIDT_INIT(-2)
9e82cf6a	199
bd238fb4 LI	200	static inline struct v9fs_session_info v9fs_inode2v9ses(struct inode inode)
bd238fb4 LI	201	{
772712c5	202	return inode->i_sb->s_fs_info;
bd238fb4	203	}
2405669b	204
42869c8a AK	205	static inline struct v9fs_session_info v9fs_dentry2v9ses(struct dentry dentry)
	206	{
	207	return dentry->d_sb->s_fs_info;
	208	}
	209
dd6102fb	210	static inline int v9fs_proto_dotu(struct v9fs_session_info *v9ses)
2405669b	211	{
dd6102fb SK	212	return v9ses->flags & V9FS_PROTO_2000U;
	213	}
	214
	215	static inline int v9fs_proto_dotl(struct v9fs_session_info *v9ses)
	216	{
45bc21ed	217	return v9ses->flags & V9FS_PROTO_2000L;
2405669b	218	}
53c06f4e AK	219
53c06f4e AK	220	/**
a78ce05d	221	* v9fs_get_inode_from_fid - Helper routine to populate an inode by
53c06f4e AK	222	* issuing a attribute request
	223	* @v9ses: session information
	224	* @fid: fid to issue attribute request for
	225	* @sb: superblock on which to create inode
	226	*
	227	*/
	228	static inline struct inode *
a78ce05d AK	229	v9fs_get_inode_from_fid(struct v9fs_session_info v9ses, struct p9_fid fid,
a78ce05d AK	230	struct super_block *sb)
53c06f4e AK	231	{
53c06f4e AK	232	if (v9fs_proto_dotl(v9ses))
ed80fcfa	233	return v9fs_inode_from_fid_dotl(v9ses, fid, sb, 0);
53c06f4e	234	else
ed80fcfa	235	return v9fs_inode_from_fid(v9ses, fid, sb, 0);
53c06f4e	236	}
ed80fcfa AK	237
	238	/**
	239	* v9fs_get_new_inode_from_fid - Helper routine to populate an inode by
	240	* issuing a attribute request
	241	* @v9ses: session information
	242	* @fid: fid to issue attribute request for
	243	* @sb: superblock on which to create inode
	244	*
	245	*/
	246	static inline struct inode *
	247	v9fs_get_new_inode_from_fid(struct v9fs_session_info v9ses, struct p9_fid fid,
	248	struct super_block *sb)
	249	{
	250	if (v9fs_proto_dotl(v9ses))
	251	return v9fs_inode_from_fid_dotl(v9ses, fid, sb, 1);
	252	else
	253	return v9fs_inode_from_fid(v9ses, fid, sb, 1);
	254	}
	255
e0459f57	256	#endif