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

/**
 * enum p9_session_flags - option flags for each 9P session
 * @V9FS_EXTENDED: whether or not to use 9P2000.u 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_ANY: use a single attach for all users
 * @V9FS_ACCESS_MASK: bit mask of different ACCESS options
 *
 * Session flags reflect options selected by users at mount time
 */
enum p9_session_flags {
	V9FS_EXTENDED		= 0x01,
	V9FS_ACCESS_SINGLE	= 0x02,
	V9FS_ACCESS_USER	= 0x04,
	V9FS_ACCESS_ANY		= 0x06,
	V9FS_ACCESS_MASK	= 0x06,
};

/* 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_LOOSE,
	CACHE_FSCACHE,
};

/**
 * 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
 * @options: copy of options string given by user
 * @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 */
	unsigned int dfltuid;	/* default uid/muid for legacy support */
	unsigned int dfltgid;	/* default gid for legacy support */
	u32 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 p9_fid *v9fs_session_init(struct v9fs_session_info *, const char *,
									char *);
void v9fs_session_close(struct v9fs_session_info *v9ses);
void v9fs_session_cancel(struct v9fs_session_info *v9ses);

#define V9FS_MAGIC 0x01021997

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

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

static inline int v9fs_extended(struct v9fs_session_info *v9ses)
{
	return v9ses->flags & V9FS_EXTENDED;
}
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	*/
	23
ee443996 EVH	24	/**
	25	* enum p9_session_flags - option flags for each 9P session
	26	* @V9FS_EXTENDED: whether or not to use 9P2000.u extensions
	27	* @V9FS_ACCESS_SINGLE: only the mounting user can access the hierarchy
	28	* @V9FS_ACCESS_USER: a new attach will be issued for every user (default)
	29	* @V9FS_ACCESS_ANY: use a single attach for all users
	30	* @V9FS_ACCESS_MASK: bit mask of different ACCESS options
	31	*
	32	* Session flags reflect options selected by users at mount time
	33	*/
	34	enum p9_session_flags {
	35	V9FS_EXTENDED = 0x01,
	36	V9FS_ACCESS_SINGLE = 0x02,
	37	V9FS_ACCESS_USER = 0x04,
	38	V9FS_ACCESS_ANY = 0x06,
	39	V9FS_ACCESS_MASK = 0x06,
	40	};
	41
	42	/* possible values of ->cache */
	43	/**
	44	* enum p9_cache_modes - user specified cache preferences
	45	* @CACHE_NONE: do not cache data, dentries, or directory contents (default)
	46	* @CACHE_LOOSE: cache data, dentries, and directory contents w/no consistency
	47	*
	48	* eventually support loose, tight, time, session, default always none
	49	*/
	50
	51	enum p9_cache_modes {
	52	CACHE_NONE,
	53	CACHE_LOOSE,
60e78d2c	54	CACHE_FSCACHE,
ee443996 EVH	55	};
	56
	57	/**
	58	* struct v9fs_session_info - per-instance session information
	59	* @flags: session options of type &p9_session_flags
	60	* @nodev: set to 1 to disable device mapping
	61	* @debug: debug level
	62	* @afid: authentication handle
	63	* @cache: cache mode of type &p9_cache_modes
60e78d2c AK	64	* @cachetag: the tag of the cache associated with this session
60e78d2c AK	65	* @fscache: session cookie associated with FS-Cache
ee443996 EVH	66	* @options: copy of options string given by user
	67	* @uname: string user name to mount hierarchy as
	68	* @aname: mount specifier for remote hierarchy
	69	* @maxdata: maximum data to be sent/recvd per protocol message
	70	* @dfltuid: default numeric userid to mount hierarchy as
	71	* @dfltgid: default numeric groupid to mount hierarchy as
	72	* @uid: if %V9FS_ACCESS_SINGLE, the numeric uid which mounted the hierarchy
	73	* @clnt: reference to 9P network client instantiated for this session
60e78d2c	74	* @slist: reference to list of registered 9p sessions
ee443996 EVH	75	*
	76	* This structure holds state for each session instance established during
	77	* a sys_mount() .
	78	*
	79	* Bugs: there seems to be a lot of state which could be condensed and/or
	80	* removed.
	81	*/
9e82cf6a EVH	82
	83	struct v9fs_session_info {
	84	/* options */
ee443996 EVH	85	unsigned char flags;
	86	unsigned char nodev;
	87	unsigned short debug;
	88	unsigned int afid;
	89	unsigned int cache;
60e78d2c AK	90	#ifdef CONFIG_9P_FSCACHE
	91	char *cachetag;
	92	struct fscache_cookie *fscache;
	93	#endif
9e82cf6a	94
ba17674f LI	95	char uname; / user name to mount as */
ba17674f LI	96	char aname; / name of remote hierarchy being mounted */
8a0dc95f	97	unsigned int maxdata; /* max data for client interface */
bd32b82d LI	98	unsigned int dfltuid; /* default uid/muid for legacy support */
bd32b82d LI	99	unsigned int dfltgid; /* default gid for legacy support */
ba17674f	100	u32 uid; /* if ACCESS_SINGLE, the uid that has access */
bd238fb4	101	struct p9_client clnt; / 9p client */
60e78d2c	102	struct list_head slist; /* list of sessions registered with v9fs */
9e82cf6a EVH	103	};
9e82cf6a EVH	104
bd238fb4 LI	105	struct p9_fid v9fs_session_init(struct v9fs_session_info , const char *,
bd238fb4 LI	106	char *);
9e82cf6a	107	void v9fs_session_close(struct v9fs_session_info *v9ses);
322b329a	108	void v9fs_session_cancel(struct v9fs_session_info *v9ses);
9e82cf6a EVH	109
	110	#define V9FS_MAGIC 0x01021997
	111
	112	/* other default globals */
bd32b82d	113	#define V9FS_PORT 564
9e82cf6a EVH	114	#define V9FS_DEFUSER "nobody"
9e82cf6a EVH	115	#define V9FS_DEFANAME ""
bd32b82d LI	116	#define V9FS_DEFUID (-2)
bd32b82d LI	117	#define V9FS_DEFGID (-2)
9e82cf6a	118
bd238fb4 LI	119	static inline struct v9fs_session_info v9fs_inode2v9ses(struct inode inode)
	120	{
	121	return (inode->i_sb->s_fs_info);
	122	}
2405669b LI	123
	124	static inline int v9fs_extended(struct v9fs_session_info *v9ses)
	125	{
	126	return v9ses->flags & V9FS_EXTENDED;
	127	}