[linux-2.6-block.git] / fs / 9p / v9fs.h

/*
 * V9FS definitions.
 *
 *  Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com>
 *  Copyright (C) 2002 by Ron Minnich <rminnich@lanl.gov>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2
 *  as published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to:
 *  Free Software Foundation
 *  51 Franklin Street, Fifth Floor
 *  Boston, MA  02111-1301  USA
 *
 */
#ifndef FS_9P_V9FS_H
#define FS_9P_V9FS_H

#include <linux/backing-dev.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
};

/* possible values of ->cache */
/**
 * enum p9_cache_modes - user specified cache preferences
 * @CACHE_NONE: do not cache data, dentries, or directory contents (default)
 * @CACHE_LOOSE: cache data, dentries, and directory contents w/no consistency
 *
 * eventually support loose, tight, time, session, default always none
 */

enum p9_cache_modes {
	CACHE_NONE,
	CACHE_MMAP,
	CACHE_LOOSE,
	CACHE_FSCACHE,
	nr__p9_cache_modes
};

/**
 * 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_modes
 * @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 char flags;
	unsigned char nodev;
	unsigned short debug;
	unsigned int afid;
	unsigned int cache;
#ifdef CONFIG_9P_FSCACHE
	char *cachetag;
	struct fscache_cookie *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 {
#ifdef CONFIG_9P_FSCACHE
	struct mutex fscache_lock;
	struct fscache_cookie *fscache;
#endif
	struct p9_qid qid;
	unsigned int cache_validity;
	struct p9_fid *writeback_fid;
	struct mutex v_mutex;
	struct inode vfs_inode;
};

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

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

struct p9_fid *v9fs_session_init(struct v9fs_session_info *, const char *,
									char *);
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 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 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
9e82cf6a EVH	1	/*
	2	* V9FS definitions.
	3	*
8a0dc95f	4	* Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com>
9e82cf6a EVH	5	* Copyright (C) 2002 by Ron Minnich <rminnich@lanl.gov>
	6	*
	7	* This program is free software; you can redistribute it and/or modify
42e8c509 EVH	8	* it under the terms of the GNU General Public License version 2
42e8c509 EVH	9	* as published by the Free Software Foundation.
9e82cf6a EVH	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to:
	18	* Free Software Foundation
	19	* 51 Franklin Street, Fifth Floor
	20	* Boston, MA 02111-1301 USA
	21	*
	22	*/
e0459f57 AK	23	#ifndef FS_9P_V9FS_H
	24	#define FS_9P_V9FS_H
	25
0ed07ddb	26	#include <linux/backing-dev.h>
9e82cf6a	27
ee443996 EVH	28	/**
ee443996 EVH	29	* enum p9_session_flags - option flags for each 9P session
dd6102fb	30	* @V9FS_PROTO_2000U: whether or not to use 9P2000.u extensions
45bc21ed	31	* @V9FS_PROTO_2000L: whether or not to use 9P2000.l extensions
ee443996 EVH	32	* @V9FS_ACCESS_SINGLE: only the mounting user can access the hierarchy
ee443996 EVH	33	* @V9FS_ACCESS_USER: a new attach will be issued for every user (default)
e782ef71	34	* @V9FS_ACCESS_CLIENT: Just like user, but access check is performed on client.
ee443996 EVH	35	* @V9FS_ACCESS_ANY: use a single attach for all users
ee443996 EVH	36	* @V9FS_ACCESS_MASK: bit mask of different ACCESS options
e782ef71	37	* @V9FS_POSIX_ACL: POSIX ACLs are enforced
ee443996 EVH	38	*
	39	* Session flags reflect options selected by users at mount time
	40	*/
76381a42 AK	41	#define V9FS_ACCESS_ANY (V9FS_ACCESS_SINGLE \| \
	42	V9FS_ACCESS_USER \| \
	43	V9FS_ACCESS_CLIENT)
	44	#define V9FS_ACCESS_MASK V9FS_ACCESS_ANY
e782ef71	45	#define V9FS_ACL_MASK V9FS_POSIX_ACL
76381a42	46
ee443996	47	enum p9_session_flags {
dd6102fb	48	V9FS_PROTO_2000U = 0x01,
45bc21ed	49	V9FS_PROTO_2000L = 0x02,
dd6102fb SK	50	V9FS_ACCESS_SINGLE = 0x04,
dd6102fb SK	51	V9FS_ACCESS_USER = 0x08,
e782ef71 VJJ	52	V9FS_ACCESS_CLIENT = 0x10,
e782ef71 VJJ	53	V9FS_POSIX_ACL = 0x20
ee443996 EVH	54	};
	55
	56	/* possible values of ->cache */
	57	/**
	58	* enum p9_cache_modes - user specified cache preferences
	59	* @CACHE_NONE: do not cache data, dentries, or directory contents (default)
	60	* @CACHE_LOOSE: cache data, dentries, and directory contents w/no consistency
	61	*
	62	* eventually support loose, tight, time, session, default always none
	63	*/
	64
	65	enum p9_cache_modes {
	66	CACHE_NONE,
fb89b45c	67	CACHE_MMAP,
ee443996	68	CACHE_LOOSE,
60e78d2c	69	CACHE_FSCACHE,
c4fac910	70	nr__p9_cache_modes
ee443996 EVH	71	};
	72
	73	/**
	74	* struct v9fs_session_info - per-instance session information
	75	* @flags: session options of type &p9_session_flags
	76	* @nodev: set to 1 to disable device mapping
	77	* @debug: debug level
	78	* @afid: authentication handle
	79	* @cache: cache mode of type &p9_cache_modes
60e78d2c AK	80	* @cachetag: the tag of the cache associated with this session
60e78d2c AK	81	* @fscache: session cookie associated with FS-Cache
ee443996 EVH	82	* @uname: string user name to mount hierarchy as
	83	* @aname: mount specifier for remote hierarchy
	84	* @maxdata: maximum data to be sent/recvd per protocol message
	85	* @dfltuid: default numeric userid to mount hierarchy as
	86	* @dfltgid: default numeric groupid to mount hierarchy as
	87	* @uid: if %V9FS_ACCESS_SINGLE, the numeric uid which mounted the hierarchy
	88	* @clnt: reference to 9P network client instantiated for this session
60e78d2c	89	* @slist: reference to list of registered 9p sessions
ee443996 EVH	90	*
	91	* This structure holds state for each session instance established during
	92	* a sys_mount() .
	93	*
	94	* Bugs: there seems to be a lot of state which could be condensed and/or
	95	* removed.
	96	*/
9e82cf6a EVH	97
	98	struct v9fs_session_info {
	99	/* options */
ee443996 EVH	100	unsigned char flags;
	101	unsigned char nodev;
	102	unsigned short debug;
	103	unsigned int afid;
	104	unsigned int cache;
60e78d2c AK	105	#ifdef CONFIG_9P_FSCACHE
	106	char *cachetag;
	107	struct fscache_cookie *fscache;
	108	#endif
9e82cf6a	109
ba17674f LI	110	char uname; / user name to mount as */
ba17674f LI	111	char aname; / name of remote hierarchy being mounted */
8a0dc95f	112	unsigned int maxdata; /* max data for client interface */
76ed23a5 EB	113	kuid_t dfltuid; /* default uid/muid for legacy support */
	114	kgid_t dfltgid; /* default gid for legacy support */
	115	kuid_t uid; /* if ACCESS_SINGLE, the uid that has access */
bd238fb4	116	struct p9_client clnt; / 9p client */
60e78d2c	117	struct list_head slist; /* list of sessions registered with v9fs */
a534c8d1	118	struct rw_semaphore rename_sem;
5e172f75	119	long session_lock_timeout; /* retry interval for blocking locks */
9e82cf6a EVH	120	};
9e82cf6a EVH	121
b3cbea03 AK	122	/* cache_validity flags */
	123	#define V9FS_INO_INVALID_ATTR 0x01
	124
a78ce05d AK	125	struct v9fs_inode {
a78ce05d AK	126	#ifdef CONFIG_9P_FSCACHE
8f5fed1e	127	struct mutex fscache_lock;
a78ce05d	128	struct fscache_cookie *fscache;
a78ce05d	129	#endif
fd2421f5	130	struct p9_qid qid;
b3cbea03	131	unsigned int cache_validity;
6b39f6d2	132	struct p9_fid *writeback_fid;
5a7e0a8c	133	struct mutex v_mutex;
a78ce05d AK	134	struct inode vfs_inode;
	135	};
	136
	137	static inline struct v9fs_inode V9FS_I(const struct inode inode)
	138	{
	139	return container_of(inode, struct v9fs_inode, vfs_inode);
	140	}
	141
c4fac910 DH	142	extern int v9fs_show_options(struct seq_file m, struct dentry root);
c4fac910 DH	143
bd238fb4 LI	144	struct p9_fid v9fs_session_init(struct v9fs_session_info , const char *,
bd238fb4 LI	145	char *);
53c06f4e AK	146	extern void v9fs_session_close(struct v9fs_session_info *v9ses);
	147	extern void v9fs_session_cancel(struct v9fs_session_info *v9ses);
	148	extern void v9fs_session_begin_cancel(struct v9fs_session_info *v9ses);
	149	extern struct dentry v9fs_vfs_lookup(struct inode dir, struct dentry *dentry,
00cd8dd3	150	unsigned int flags);
53c06f4e AK	151	extern int v9fs_vfs_unlink(struct inode i, struct dentry d);
	152	extern int v9fs_vfs_rmdir(struct inode i, struct dentry d);
	153	extern int v9fs_vfs_rename(struct inode old_dir, struct dentry old_dentry,
1cd66c93 MS	154	struct inode new_dir, struct dentry new_dentry,
1cd66c93 MS	155	unsigned int flags);
a78ce05d AK	156	extern struct inode v9fs_inode_from_fid(struct v9fs_session_info v9ses,
a78ce05d AK	157	struct p9_fid *fid,
ed80fcfa	158	struct super_block *sb, int new);
53c06f4e AK	159	extern const struct inode_operations v9fs_dir_inode_operations_dotl;
	160	extern const struct inode_operations v9fs_file_inode_operations_dotl;
	161	extern const struct inode_operations v9fs_symlink_inode_operations_dotl;
a78ce05d AK	162	extern struct inode v9fs_inode_from_fid_dotl(struct v9fs_session_info v9ses,
a78ce05d AK	163	struct p9_fid *fid,
ed80fcfa	164	struct super_block *sb, int new);
9e82cf6a	165
9e82cf6a	166	/* other default globals */
bd32b82d	167	#define V9FS_PORT 564
9e82cf6a EVH	168	#define V9FS_DEFUSER "nobody"
9e82cf6a EVH	169	#define V9FS_DEFANAME ""
76ed23a5 EB	170	#define V9FS_DEFUID KUIDT_INIT(-2)
76ed23a5 EB	171	#define V9FS_DEFGID KGIDT_INIT(-2)
9e82cf6a	172
bd238fb4 LI	173	static inline struct v9fs_session_info v9fs_inode2v9ses(struct inode inode)
	174	{
	175	return (inode->i_sb->s_fs_info);
	176	}
2405669b	177
42869c8a AK	178	static inline struct v9fs_session_info v9fs_dentry2v9ses(struct dentry dentry)
	179	{
	180	return dentry->d_sb->s_fs_info;
	181	}
	182
dd6102fb	183	static inline int v9fs_proto_dotu(struct v9fs_session_info *v9ses)
2405669b	184	{
dd6102fb SK	185	return v9ses->flags & V9FS_PROTO_2000U;
	186	}
	187
	188	static inline int v9fs_proto_dotl(struct v9fs_session_info *v9ses)
	189	{
45bc21ed	190	return v9ses->flags & V9FS_PROTO_2000L;
2405669b	191	}
53c06f4e AK	192
53c06f4e AK	193	/**
a78ce05d	194	* v9fs_get_inode_from_fid - Helper routine to populate an inode by
53c06f4e AK	195	* issuing a attribute request
	196	* @v9ses: session information
	197	* @fid: fid to issue attribute request for
	198	* @sb: superblock on which to create inode
	199	*
	200	*/
	201	static inline struct inode *
a78ce05d AK	202	v9fs_get_inode_from_fid(struct v9fs_session_info v9ses, struct p9_fid fid,
a78ce05d AK	203	struct super_block *sb)
53c06f4e AK	204	{
53c06f4e AK	205	if (v9fs_proto_dotl(v9ses))
ed80fcfa	206	return v9fs_inode_from_fid_dotl(v9ses, fid, sb, 0);
53c06f4e	207	else
ed80fcfa	208	return v9fs_inode_from_fid(v9ses, fid, sb, 0);
53c06f4e	209	}
ed80fcfa AK	210
	211	/**
	212	* v9fs_get_new_inode_from_fid - Helper routine to populate an inode by
	213	* issuing a attribute request
	214	* @v9ses: session information
	215	* @fid: fid to issue attribute request for
	216	* @sb: superblock on which to create inode
	217	*
	218	*/
	219	static inline struct inode *
	220	v9fs_get_new_inode_from_fid(struct v9fs_session_info v9ses, struct p9_fid fid,
	221	struct super_block *sb)
	222	{
	223	if (v9fs_proto_dotl(v9ses))
	224	return v9fs_inode_from_fid_dotl(v9ses, fid, sb, 1);
	225	else
	226	return v9fs_inode_from_fid(v9ses, fid, sb, 1);
	227	}
	228
e0459f57	229	#endif