[deliverable/linux.git] / fs / 9p / v9fs.c

/*
 *  linux/fs/9p/v9fs.c
 *
 *  This file contains functions assisting in mapping VFS to 9P2000
 *
 *  Copyright (C) 2004 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
 *
 */

#include <linux/module.h>
#include <linux/errno.h>
#include <linux/fs.h>
#include <linux/sched.h>
#include <linux/parser.h>
#include <linux/idr.h>
#include <net/9p/9p.h>
#include <net/9p/transport.h>
#include <net/9p/conn.h>
#include <net/9p/client.h>
#include "v9fs.h"
#include "v9fs_vfs.h"

/*
  * Option Parsing (code inspired by NFS code)
  *  NOTE: each transport will parse its own options
  */

enum {
	/* Options that take integer arguments */
	Opt_debug, Opt_msize, Opt_dfltuid, Opt_dfltgid, Opt_afid,
	/* String options */
	Opt_uname, Opt_remotename, Opt_trans,
	/* Options that take no arguments */
	Opt_legacy, Opt_nodevmap,
	/* Cache options */
	Opt_cache_loose,
	/* Access options */
	Opt_access,
	/* Error token */
	Opt_err
};

static match_table_t tokens = {
	{Opt_debug, "debug=%x"},
	{Opt_msize, "msize=%u"},
	{Opt_dfltuid, "dfltuid=%u"},
	{Opt_dfltgid, "dfltgid=%u"},
	{Opt_afid, "afid=%u"},
	{Opt_uname, "uname=%s"},
	{Opt_remotename, "aname=%s"},
	{Opt_trans, "trans=%s"},
	{Opt_legacy, "noextend"},
	{Opt_nodevmap, "nodevmap"},
	{Opt_cache_loose, "cache=loose"},
	{Opt_cache_loose, "loose"},
	{Opt_access, "access=%s"},
	{Opt_err, NULL}
};

/**
 * v9fs_parse_options - parse mount options into session structure
 * @options: options string passed from mount
 * @v9ses: existing v9fs session information
 *
 */

static void v9fs_parse_options(struct v9fs_session_info *v9ses)
{
	char *options = v9ses->options;
	substring_t args[MAX_OPT_ARGS];
	char *p;
	int option;
	int ret;
	char *s, *e;

	/* setup defaults */
	v9ses->maxdata = 8192;
	v9ses->afid = ~0;
	v9ses->debug = 0;
	v9ses->cache = 0;
	v9ses->trans = v9fs_default_trans();

	if (!options)
		return;

	while ((p = strsep(&options, ",")) != NULL) {
		int token;
		if (!*p)
			continue;
		token = match_token(p, tokens, args);
		if (token < Opt_uname) {
			if ((ret = match_int(&args[0], &option)) < 0) {
				P9_DPRINTK(P9_DEBUG_ERROR,
					"integer field, but no integer?\n");
				continue;
			}
		}
		switch (token) {
		case Opt_debug:
			v9ses->debug = option;
#ifdef CONFIG_NET_9P_DEBUG
			p9_debug_level = option;
#endif
			break;
		case Opt_msize:
			v9ses->maxdata = option;
			break;
		case Opt_dfltuid:
			v9ses->dfltuid = option;
			break;
		case Opt_dfltgid:
			v9ses->dfltgid = option;
			break;
		case Opt_afid:
			v9ses->afid = option;
			break;
		case Opt_trans:
			v9ses->trans = v9fs_match_trans(&args[0]);
			break;
		case Opt_uname:
			match_strcpy(v9ses->uname, &args[0]);
			break;
		case Opt_remotename:
			match_strcpy(v9ses->aname, &args[0]);
			break;
		case Opt_legacy:
			v9ses->flags &= ~V9FS_EXTENDED;
			break;
		case Opt_nodevmap:
			v9ses->nodev = 1;
			break;
		case Opt_cache_loose:
			v9ses->cache = CACHE_LOOSE;
			break;

		case Opt_access:
			s = match_strdup(&args[0]);
			v9ses->flags &= ~V9FS_ACCESS_MASK;
			if (strcmp(s, "user") == 0)
				v9ses->flags |= V9FS_ACCESS_USER;
			else if (strcmp(s, "any") == 0)
				v9ses->flags |= V9FS_ACCESS_ANY;
			else {
				v9ses->flags |= V9FS_ACCESS_SINGLE;
				v9ses->uid = simple_strtol(s, &e, 10);
				if (*e != '\0')
					v9ses->uid = ~0;
			}
			break;

		default:
			continue;
		}
	}
}

/**
 * v9fs_session_init - initialize session
 * @v9ses: session information structure
 * @dev_name: device being mounted
 * @data: options
 *
 */

struct p9_fid *v9fs_session_init(struct v9fs_session_info *v9ses,
		  const char *dev_name, char *data)
{
	int retval = -EINVAL;
	struct p9_trans *trans = NULL;
	struct p9_fid *fid;

	v9ses->uname = __getname();
	if (!v9ses->uname)
		return ERR_PTR(-ENOMEM);

	v9ses->aname = __getname();
	if (!v9ses->aname) {
		__putname(v9ses->uname);
		return ERR_PTR(-ENOMEM);
	}

	v9ses->flags = V9FS_EXTENDED | V9FS_ACCESS_USER;
	strcpy(v9ses->uname, V9FS_DEFUSER);
	strcpy(v9ses->aname, V9FS_DEFANAME);
	v9ses->uid = ~0;
	v9ses->dfltuid = V9FS_DEFUID;
	v9ses->dfltgid = V9FS_DEFGID;
	v9ses->options = kstrdup(data, GFP_KERNEL);
	v9fs_parse_options(v9ses);

	if (v9ses->trans == NULL) {
		retval = -EPROTONOSUPPORT;
		P9_DPRINTK(P9_DEBUG_ERROR,
				"No transport defined or default transport\n");
		goto error;
	}

	trans = v9ses->trans->create(dev_name, v9ses->options);
	if (IS_ERR(trans)) {
		retval = PTR_ERR(trans);
		trans = NULL;
		goto error;
	}
	if ((v9ses->maxdata+P9_IOHDRSZ) > v9ses->trans->maxsize)
		v9ses->maxdata = v9ses->trans->maxsize-P9_IOHDRSZ;

	v9ses->clnt = p9_client_create(trans, v9ses->maxdata+P9_IOHDRSZ,
		v9fs_extended(v9ses));

	if (IS_ERR(v9ses->clnt)) {
		retval = PTR_ERR(v9ses->clnt);
		v9ses->clnt = NULL;
		P9_DPRINTK(P9_DEBUG_ERROR, "problem initializing 9p client\n");
		goto error;
	}

	if (!v9ses->clnt->dotu)
		v9ses->flags &= ~V9FS_EXTENDED;

	/* for legacy mode, fall back to V9FS_ACCESS_ANY */
	if (!v9fs_extended(v9ses) &&
		((v9ses->flags&V9FS_ACCESS_MASK) == V9FS_ACCESS_USER)) {

		v9ses->flags &= ~V9FS_ACCESS_MASK;
		v9ses->flags |= V9FS_ACCESS_ANY;
		v9ses->uid = ~0;
	}

	fid = p9_client_attach(v9ses->clnt, NULL, v9ses->uname, ~0,
							v9ses->aname);
	if (IS_ERR(fid)) {
		retval = PTR_ERR(fid);
		fid = NULL;
		P9_DPRINTK(P9_DEBUG_ERROR, "cannot attach\n");
		goto error;
	}

	if ((v9ses->flags & V9FS_ACCESS_MASK) == V9FS_ACCESS_SINGLE)
		fid->uid = v9ses->uid;
	else
		fid->uid = ~0;

	return fid;

error:
	v9fs_session_close(v9ses);
	return ERR_PTR(retval);
}

/**
 * v9fs_session_close - shutdown a session
 * @v9ses: session information structure
 *
 */

void v9fs_session_close(struct v9fs_session_info *v9ses)
{
	if (v9ses->clnt) {
		p9_client_destroy(v9ses->clnt);
		v9ses->clnt = NULL;
	}

	__putname(v9ses->uname);
	__putname(v9ses->aname);
	kfree(v9ses->options);
}

/**
 * v9fs_session_cancel - mark transport as disconnected
 * 	and cancel all pending requests.
 */
void v9fs_session_cancel(struct v9fs_session_info *v9ses) {
	P9_DPRINTK(P9_DEBUG_ERROR, "cancel session %p\n", v9ses);
	p9_client_disconnect(v9ses->clnt);
}

extern int v9fs_error_init(void);

/**
 * v9fs_init - Initialize module
 *
 */

static int __init init_v9fs(void)
{
	printk(KERN_INFO "Installing v9fs 9p2000 file system support\n");
	/* TODO: Setup list of registered trasnport modules */
	return register_filesystem(&v9fs_fs_type);
}

/**
 * v9fs_init - shutdown module
 *
 */

static void __exit exit_v9fs(void)
{
	unregister_filesystem(&v9fs_fs_type);
}

module_init(init_v9fs)
module_exit(exit_v9fs)

MODULE_AUTHOR("Latchesar Ionkov <lucho@ionkov.net>");
MODULE_AUTHOR("Eric Van Hensbergen <ericvh@gmail.com>");
MODULE_AUTHOR("Ron Minnich <rminnich@lanl.gov>");
MODULE_LICENSE("GPL");
Commit	Line	Data
9e82cf6a EVH	1	/*
	2	* linux/fs/9p/v9fs.c
	3	*
	4	* This file contains functions assisting in mapping VFS to 9P2000
	5	*
	6	* Copyright (C) 2004 by Eric Van Hensbergen <ericvh@gmail.com>
	7	* Copyright (C) 2002 by Ron Minnich <rminnich@lanl.gov>
	8	*
	9	* This program is free software; you can redistribute it and/or modify
42e8c509 EVH	10	* it under the terms of the GNU General Public License version 2
42e8c509 EVH	11	* as published by the Free Software Foundation.
9e82cf6a EVH	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to:
	20	* Free Software Foundation
	21	* 51 Franklin Street, Fifth Floor
	22	* Boston, MA 02111-1301 USA
	23	*
	24	*/
	25
9e82cf6a EVH	26	#include <linux/module.h>
	27	#include <linux/errno.h>
	28	#include <linux/fs.h>
914e2637	29	#include <linux/sched.h>
9e82cf6a EVH	30	#include <linux/parser.h>
9e82cf6a EVH	31	#include <linux/idr.h>
bd238fb4 LI	32	#include <net/9p/9p.h>
	33	#include <net/9p/transport.h>
	34	#include <net/9p/conn.h>
	35	#include <net/9p/client.h>
9e82cf6a	36	#include "v9fs.h"
9e82cf6a	37	#include "v9fs_vfs.h"
9e82cf6a EVH	38
	39	/*
	40	* Option Parsing (code inspired by NFS code)
a80d923e	41	* NOTE: each transport will parse its own options
9e82cf6a EVH	42	*/
	43
	44	enum {
	45	/* Options that take integer arguments */
bd32b82d	46	Opt_debug, Opt_msize, Opt_dfltuid, Opt_dfltgid, Opt_afid,
9e82cf6a	47	/* String options */
a80d923e	48	Opt_uname, Opt_remotename, Opt_trans,
9e82cf6a	49	/* Options that take no arguments */
a80d923e	50	Opt_legacy, Opt_nodevmap,
e03abc0c EVH	51	/* Cache options */
e03abc0c EVH	52	Opt_cache_loose,
ba17674f LI	53	/* Access options */
ba17674f LI	54	Opt_access,
9e82cf6a EVH	55	/* Error token */
	56	Opt_err
	57	};
	58
	59	static match_table_t tokens = {
9e2f6688	60	{Opt_debug, "debug=%x"},
9e82cf6a	61	{Opt_msize, "msize=%u"},
bd32b82d LI	62	{Opt_dfltuid, "dfltuid=%u"},
bd32b82d LI	63	{Opt_dfltgid, "dfltgid=%u"},
9e82cf6a	64	{Opt_afid, "afid=%u"},
67543e50	65	{Opt_uname, "uname=%s"},
9e82cf6a	66	{Opt_remotename, "aname=%s"},
a80d923e	67	{Opt_trans, "trans=%s"},
9e82cf6a EVH	68	{Opt_legacy, "noextend"},
9e82cf6a EVH	69	{Opt_nodevmap, "nodevmap"},
e03abc0c EVH	70	{Opt_cache_loose, "cache=loose"},
e03abc0c EVH	71	{Opt_cache_loose, "loose"},
ba17674f	72	{Opt_access, "access=%s"},
9e82cf6a EVH	73	{Opt_err, NULL}
	74	};
	75
9e82cf6a EVH	76	/**
	77	* v9fs_parse_options - parse mount options into session structure
	78	* @options: options string passed from mount
	79	* @v9ses: existing v9fs session information
	80	*
	81	*/
	82
a80d923e	83	static void v9fs_parse_options(struct v9fs_session_info *v9ses)
9e82cf6a	84	{
a80d923e	85	char *options = v9ses->options;
9e82cf6a	86	substring_t args[MAX_OPT_ARGS];
a80d923e	87	char *p;
9e82cf6a EVH	88	int option;
9e82cf6a EVH	89	int ret;
ba17674f	90	char s, e;
9e82cf6a EVH	91
9e82cf6a EVH	92	/* setup defaults */
a80d923e	93	v9ses->maxdata = 8192;
9e82cf6a EVH	94	v9ses->afid = ~0;
9e82cf6a EVH	95	v9ses->debug = 0;
e03abc0c	96	v9ses->cache = 0;
fb0466c3	97	v9ses->trans = v9fs_default_trans();
9e82cf6a EVH	98
	99	if (!options)
	100	return;
	101
	102	while ((p = strsep(&options, ",")) != NULL) {
	103	int token;
	104	if (!*p)
	105	continue;
	106	token = match_token(p, tokens, args);
67543e50	107	if (token < Opt_uname) {
9e82cf6a	108	if ((ret = match_int(&args[0], &option)) < 0) {
bd238fb4	109	P9_DPRINTK(P9_DEBUG_ERROR,
9e82cf6a EVH	110	"integer field, but no integer?\n");
	111	continue;
	112	}
9e82cf6a EVH	113	}
9e82cf6a EVH	114	switch (token) {
9e2f6688 EVH	115	case Opt_debug:
9e2f6688 EVH	116	v9ses->debug = option;
10fa16e7	117	#ifdef CONFIG_NET_9P_DEBUG
9e2f6688	118	p9_debug_level = option;
10fa16e7	119	#endif
9e2f6688	120	break;
9e82cf6a EVH	121	case Opt_msize:
	122	v9ses->maxdata = option;
	123	break;
bd32b82d LI	124	case Opt_dfltuid:
bd32b82d LI	125	v9ses->dfltuid = option;
9e82cf6a	126	break;
bd32b82d LI	127	case Opt_dfltgid:
bd32b82d LI	128	v9ses->dfltgid = option;
9e82cf6a EVH	129	break;
	130	case Opt_afid:
	131	v9ses->afid = option;
	132	break;
a80d923e EVH	133	case Opt_trans:
a80d923e EVH	134	v9ses->trans = v9fs_match_trans(&args[0]);
9e82cf6a	135	break;
67543e50	136	case Opt_uname:
ba17674f	137	match_strcpy(v9ses->uname, &args[0]);
9e82cf6a EVH	138	break;
9e82cf6a EVH	139	case Opt_remotename:
ba17674f	140	match_strcpy(v9ses->aname, &args[0]);
9e82cf6a EVH	141	break;
9e82cf6a EVH	142	case Opt_legacy:
2405669b	143	v9ses->flags &= ~V9FS_EXTENDED;
9e82cf6a EVH	144	break;
	145	case Opt_nodevmap:
	146	v9ses->nodev = 1;
	147	break;
e03abc0c EVH	148	case Opt_cache_loose:
	149	v9ses->cache = CACHE_LOOSE;
	150	break;
ba17674f LI	151
	152	case Opt_access:
	153	s = match_strdup(&args[0]);
	154	v9ses->flags &= ~V9FS_ACCESS_MASK;
	155	if (strcmp(s, "user") == 0)
	156	v9ses->flags \|= V9FS_ACCESS_USER;
	157	else if (strcmp(s, "any") == 0)
	158	v9ses->flags \|= V9FS_ACCESS_ANY;
	159	else {
	160	v9ses->flags \|= V9FS_ACCESS_SINGLE;
	161	v9ses->uid = simple_strtol(s, &e, 10);
	162	if (*e != '\0')
	163	v9ses->uid = ~0;
	164	}
	165	break;
	166
9e82cf6a EVH	167	default:
	168	continue;
	169	}
	170	}
	171	}
	172
9e82cf6a EVH	173	/**
	174	* v9fs_session_init - initialize session
	175	* @v9ses: session information structure
	176	* @dev_name: device being mounted
	177	* @data: options
	178	*
	179	*/
	180
bd238fb4	181	struct p9_fid v9fs_session_init(struct v9fs_session_info v9ses,
9e82cf6a EVH	182	const char dev_name, char data)
9e82cf6a EVH	183	{
9e82cf6a	184	int retval = -EINVAL;
a80d923e	185	struct p9_trans *trans = NULL;
bd238fb4	186	struct p9_fid *fid;
9e82cf6a	187
ba17674f LI	188	v9ses->uname = __getname();
ba17674f LI	189	if (!v9ses->uname)
bd238fb4	190	return ERR_PTR(-ENOMEM);
9e82cf6a	191
ba17674f LI	192	v9ses->aname = __getname();
	193	if (!v9ses->aname) {
	194	__putname(v9ses->uname);
bd238fb4	195	return ERR_PTR(-ENOMEM);
9e82cf6a EVH	196	}
9e82cf6a EVH	197
ba17674f LI	198	v9ses->flags = V9FS_EXTENDED \| V9FS_ACCESS_USER;
	199	strcpy(v9ses->uname, V9FS_DEFUSER);
	200	strcpy(v9ses->aname, V9FS_DEFANAME);
	201	v9ses->uid = ~0;
bd32b82d LI	202	v9ses->dfltuid = V9FS_DEFUID;
bd32b82d LI	203	v9ses->dfltgid = V9FS_DEFGID;
a80d923e EVH	204	v9ses->options = kstrdup(data, GFP_KERNEL);
	205	v9fs_parse_options(v9ses);
	206
a80d923e EVH	207	if (v9ses->trans == NULL) {
	208	retval = -EPROTONOSUPPORT;
	209	P9_DPRINTK(P9_DEBUG_ERROR,
	210	"No transport defined or default transport\n");
bd238fb4	211	goto error;
a80d923e	212	}
9e82cf6a	213
a80d923e	214	trans = v9ses->trans->create(dev_name, v9ses->options);
bd238fb4 LI	215	if (IS_ERR(trans)) {
	216	retval = PTR_ERR(trans);
	217	trans = NULL;
	218	goto error;
a8e63bff	219	}
a80d923e EVH	220	if ((v9ses->maxdata+P9_IOHDRSZ) > v9ses->trans->maxsize)
a80d923e EVH	221	v9ses->maxdata = v9ses->trans->maxsize-P9_IOHDRSZ;
a8e63bff	222
a80d923e	223	v9ses->clnt = p9_client_create(trans, v9ses->maxdata+P9_IOHDRSZ,
2405669b	224	v9fs_extended(v9ses));
9e82cf6a	225
bd238fb4 LI	226	if (IS_ERR(v9ses->clnt)) {
	227	retval = PTR_ERR(v9ses->clnt);
	228	v9ses->clnt = NULL;
	229	P9_DPRINTK(P9_DEBUG_ERROR, "problem initializing 9p client\n");
	230	goto error;
9e82cf6a EVH	231	}
9e82cf6a EVH	232
ba17674f LI	233	if (!v9ses->clnt->dotu)
	234	v9ses->flags &= ~V9FS_EXTENDED;
	235
	236	/* for legacy mode, fall back to V9FS_ACCESS_ANY */
	237	if (!v9fs_extended(v9ses) &&
	238	((v9ses->flags&V9FS_ACCESS_MASK) == V9FS_ACCESS_USER)) {
	239
	240	v9ses->flags &= ~V9FS_ACCESS_MASK;
	241	v9ses->flags \|= V9FS_ACCESS_ANY;
	242	v9ses->uid = ~0;
	243	}
	244
	245	fid = p9_client_attach(v9ses->clnt, NULL, v9ses->uname, ~0,
	246	v9ses->aname);
bd238fb4 LI	247	if (IS_ERR(fid)) {
	248	retval = PTR_ERR(fid);
	249	fid = NULL;
	250	P9_DPRINTK(P9_DEBUG_ERROR, "cannot attach\n");
	251	goto error;
9e82cf6a EVH	252	}
9e82cf6a EVH	253
ba17674f LI	254	if ((v9ses->flags & V9FS_ACCESS_MASK) == V9FS_ACCESS_SINGLE)
	255	fid->uid = v9ses->uid;
	256	else
	257	fid->uid = ~0;
	258
bd238fb4	259	return fid;
9e82cf6a	260
bd238fb4	261	error:
9e82cf6a	262	v9fs_session_close(v9ses);
bd238fb4	263	return ERR_PTR(retval);
9e82cf6a EVH	264	}
	265
	266	/**
	267	* v9fs_session_close - shutdown a session
	268	* @v9ses: session information structure
	269	*
	270	*/
	271
	272	void v9fs_session_close(struct v9fs_session_info *v9ses)
	273	{
bd238fb4 LI	274	if (v9ses->clnt) {
	275	p9_client_destroy(v9ses->clnt);
	276	v9ses->clnt = NULL;
3cf6429a	277	}
9e82cf6a	278
ba17674f LI	279	__putname(v9ses->uname);
ba17674f LI	280	__putname(v9ses->aname);
a80d923e	281	kfree(v9ses->options);
9e82cf6a EVH	282	}
9e82cf6a EVH	283
322b329a EVH	284	/**
	285	* v9fs_session_cancel - mark transport as disconnected
	286	* and cancel all pending requests.
	287	*/
	288	void v9fs_session_cancel(struct v9fs_session_info *v9ses) {
bd238fb4 LI	289	P9_DPRINTK(P9_DEBUG_ERROR, "cancel session %p\n", v9ses);
bd238fb4 LI	290	p9_client_disconnect(v9ses->clnt);
322b329a EVH	291	}
322b329a EVH	292
9e82cf6a EVH	293	extern int v9fs_error_init(void);
	294
	295	/**
	296	* v9fs_init - Initialize module
	297	*
	298	*/
	299
	300	static int __init init_v9fs(void)
	301	{
f94b3470	302	printk(KERN_INFO "Installing v9fs 9p2000 file system support\n");
a80d923e	303	/* TODO: Setup list of registered trasnport modules */
bd238fb4	304	return register_filesystem(&v9fs_fs_type);
9e82cf6a EVH	305	}
	306
	307	/**
	308	* v9fs_init - shutdown module
	309	*
	310	*/
	311
	312	static void __exit exit_v9fs(void)
	313	{
	314	unregister_filesystem(&v9fs_fs_type);
	315	}
	316
	317	module_init(init_v9fs)
	318	module_exit(exit_v9fs)
	319
bd238fb4	320	MODULE_AUTHOR("Latchesar Ionkov <lucho@ionkov.net>");
9e82cf6a EVH	321	MODULE_AUTHOR("Eric Van Hensbergen <ericvh@gmail.com>");
	322	MODULE_AUTHOR("Ron Minnich <rminnich@lanl.gov>");
	323	MODULE_LICENSE("GPL");