blob: 756f7e9beb2e0a12cc1ad527992ca9fe6537c966 [file] [log] [blame]
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -07001/*
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
Eric Van Hensbergen42e8c502006-03-25 03:07:28 -080010 * it under the terms of the GNU General Public License version 2
11 * as published by the Free Software Foundation.
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070012 *
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
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070026#include <linux/module.h>
27#include <linux/errno.h>
28#include <linux/fs.h>
Al Viro914e2632006-10-18 13:55:46 -040029#include <linux/sched.h>
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070030#include <linux/parser.h>
31#include <linux/idr.h>
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -050032#include <net/9p/9p.h>
33#include <net/9p/transport.h>
34#include <net/9p/conn.h>
35#include <net/9p/client.h>
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070036#include "v9fs.h"
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070037#include "v9fs_vfs.h"
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070038
39/*
40 * Option Parsing (code inspired by NFS code)
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050041 * NOTE: each transport will parse its own options
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070042 */
43
44enum {
45 /* Options that take integer arguments */
Latchesar Ionkovbd32b822007-10-17 14:31:07 -050046 Opt_debug, Opt_msize, Opt_dfltuid, Opt_dfltgid, Opt_afid,
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070047 /* String options */
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050048 Opt_uname, Opt_remotename, Opt_trans,
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070049 /* Options that take no arguments */
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050050 Opt_legacy, Opt_nodevmap,
Eric Van Hensbergene03abc02007-02-11 13:21:39 -060051 /* Cache options */
52 Opt_cache_loose,
Latchesar Ionkovba176742007-10-17 14:31:07 -050053 /* Access options */
54 Opt_access,
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070055 /* Error token */
56 Opt_err
57};
58
59static match_table_t tokens = {
Eric Van Hensbergen9e2f6682007-07-13 13:05:21 -050060 {Opt_debug, "debug=%x"},
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070061 {Opt_msize, "msize=%u"},
Latchesar Ionkovbd32b822007-10-17 14:31:07 -050062 {Opt_dfltuid, "dfltuid=%u"},
63 {Opt_dfltgid, "dfltgid=%u"},
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070064 {Opt_afid, "afid=%u"},
Eric Van Hensbergen67543e52006-03-25 03:07:29 -080065 {Opt_uname, "uname=%s"},
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070066 {Opt_remotename, "aname=%s"},
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050067 {Opt_trans, "trans=%s"},
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070068 {Opt_legacy, "noextend"},
69 {Opt_nodevmap, "nodevmap"},
Eric Van Hensbergene03abc02007-02-11 13:21:39 -060070 {Opt_cache_loose, "cache=loose"},
71 {Opt_cache_loose, "loose"},
Latchesar Ionkovba176742007-10-17 14:31:07 -050072 {Opt_access, "access=%s"},
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070073 {Opt_err, NULL}
74};
75
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070076/**
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
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050083static void v9fs_parse_options(struct v9fs_session_info *v9ses)
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070084{
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050085 char *options = v9ses->options;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070086 substring_t args[MAX_OPT_ARGS];
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050087 char *p;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070088 int option;
89 int ret;
Latchesar Ionkovba176742007-10-17 14:31:07 -050090 char *s, *e;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070091
92 /* setup defaults */
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050093 v9ses->maxdata = 8192;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070094 v9ses->afid = ~0;
95 v9ses->debug = 0;
Eric Van Hensbergene03abc02007-02-11 13:21:39 -060096 v9ses->cache = 0;
Eric Van Hensbergenfb0466c2007-10-17 14:31:07 -050097 v9ses->trans = v9fs_default_trans();
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070098
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);
Eric Van Hensbergen67543e52006-03-25 03:07:29 -0800107 if (token < Opt_uname) {
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700108 if ((ret = match_int(&args[0], &option)) < 0) {
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500109 P9_DPRINTK(P9_DEBUG_ERROR,
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700110 "integer field, but no integer?\n");
111 continue;
112 }
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700113 }
114 switch (token) {
Eric Van Hensbergen9e2f6682007-07-13 13:05:21 -0500115 case Opt_debug:
116 v9ses->debug = option;
Eric Van Hensbergen10fa16e2007-07-16 16:02:49 -0500117#ifdef CONFIG_NET_9P_DEBUG
Eric Van Hensbergen9e2f6682007-07-13 13:05:21 -0500118 p9_debug_level = option;
Eric Van Hensbergen10fa16e2007-07-16 16:02:49 -0500119#endif
Eric Van Hensbergen9e2f6682007-07-13 13:05:21 -0500120 break;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700121 case Opt_msize:
122 v9ses->maxdata = option;
123 break;
Latchesar Ionkovbd32b822007-10-17 14:31:07 -0500124 case Opt_dfltuid:
125 v9ses->dfltuid = option;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700126 break;
Latchesar Ionkovbd32b822007-10-17 14:31:07 -0500127 case Opt_dfltgid:
128 v9ses->dfltgid = option;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700129 break;
130 case Opt_afid:
131 v9ses->afid = option;
132 break;
Eric Van Hensbergena80d9232007-10-17 14:31:07 -0500133 case Opt_trans:
134 v9ses->trans = v9fs_match_trans(&args[0]);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700135 break;
Eric Van Hensbergen67543e52006-03-25 03:07:29 -0800136 case Opt_uname:
Latchesar Ionkovba176742007-10-17 14:31:07 -0500137 match_strcpy(v9ses->uname, &args[0]);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700138 break;
139 case Opt_remotename:
Latchesar Ionkovba176742007-10-17 14:31:07 -0500140 match_strcpy(v9ses->aname, &args[0]);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700141 break;
142 case Opt_legacy:
Latchesar Ionkov24056692007-10-17 14:31:07 -0500143 v9ses->flags &= ~V9FS_EXTENDED;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700144 break;
145 case Opt_nodevmap:
146 v9ses->nodev = 1;
147 break;
Eric Van Hensbergene03abc02007-02-11 13:21:39 -0600148 case Opt_cache_loose:
149 v9ses->cache = CACHE_LOOSE;
150 break;
Latchesar Ionkovba176742007-10-17 14:31:07 -0500151
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 }
Adrian Bunk0a976292007-10-23 13:48:50 -0500165 kfree(s);
Latchesar Ionkovba176742007-10-17 14:31:07 -0500166 break;
167
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700168 default:
169 continue;
170 }
171 }
172}
173
174/**
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700175 * v9fs_session_init - initialize session
176 * @v9ses: session information structure
177 * @dev_name: device being mounted
178 * @data: options
179 *
180 */
181
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500182struct p9_fid *v9fs_session_init(struct v9fs_session_info *v9ses,
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700183 const char *dev_name, char *data)
184{
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700185 int retval = -EINVAL;
Eric Van Hensbergena80d9232007-10-17 14:31:07 -0500186 struct p9_trans *trans = NULL;
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500187 struct p9_fid *fid;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700188
Latchesar Ionkovba176742007-10-17 14:31:07 -0500189 v9ses->uname = __getname();
190 if (!v9ses->uname)
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500191 return ERR_PTR(-ENOMEM);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700192
Latchesar Ionkovba176742007-10-17 14:31:07 -0500193 v9ses->aname = __getname();
194 if (!v9ses->aname) {
195 __putname(v9ses->uname);
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500196 return ERR_PTR(-ENOMEM);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700197 }
198
Latchesar Ionkovba176742007-10-17 14:31:07 -0500199 v9ses->flags = V9FS_EXTENDED | V9FS_ACCESS_USER;
200 strcpy(v9ses->uname, V9FS_DEFUSER);
201 strcpy(v9ses->aname, V9FS_DEFANAME);
202 v9ses->uid = ~0;
Latchesar Ionkovbd32b822007-10-17 14:31:07 -0500203 v9ses->dfltuid = V9FS_DEFUID;
204 v9ses->dfltgid = V9FS_DEFGID;
Eric Van Hensbergena80d9232007-10-17 14:31:07 -0500205 v9ses->options = kstrdup(data, GFP_KERNEL);
206 v9fs_parse_options(v9ses);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700207
Eric Van Hensbergena80d9232007-10-17 14:31:07 -0500208 if (v9ses->trans == NULL) {
209 retval = -EPROTONOSUPPORT;
210 P9_DPRINTK(P9_DEBUG_ERROR,
211 "No transport defined or default transport\n");
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500212 goto error;
Eric Van Hensbergena80d9232007-10-17 14:31:07 -0500213 }
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700214
Eric Van Hensbergena80d9232007-10-17 14:31:07 -0500215 trans = v9ses->trans->create(dev_name, v9ses->options);
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500216 if (IS_ERR(trans)) {
217 retval = PTR_ERR(trans);
218 trans = NULL;
219 goto error;
Latchesar Ionkova8e63bf2005-09-22 21:43:51 -0700220 }
Eric Van Hensbergena80d9232007-10-17 14:31:07 -0500221 if ((v9ses->maxdata+P9_IOHDRSZ) > v9ses->trans->maxsize)
222 v9ses->maxdata = v9ses->trans->maxsize-P9_IOHDRSZ;
Latchesar Ionkova8e63bf2005-09-22 21:43:51 -0700223
Eric Van Hensbergena80d9232007-10-17 14:31:07 -0500224 v9ses->clnt = p9_client_create(trans, v9ses->maxdata+P9_IOHDRSZ,
Latchesar Ionkov24056692007-10-17 14:31:07 -0500225 v9fs_extended(v9ses));
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700226
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500227 if (IS_ERR(v9ses->clnt)) {
228 retval = PTR_ERR(v9ses->clnt);
229 v9ses->clnt = NULL;
230 P9_DPRINTK(P9_DEBUG_ERROR, "problem initializing 9p client\n");
231 goto error;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700232 }
233
Latchesar Ionkovba176742007-10-17 14:31:07 -0500234 if (!v9ses->clnt->dotu)
235 v9ses->flags &= ~V9FS_EXTENDED;
236
237 /* for legacy mode, fall back to V9FS_ACCESS_ANY */
238 if (!v9fs_extended(v9ses) &&
239 ((v9ses->flags&V9FS_ACCESS_MASK) == V9FS_ACCESS_USER)) {
240
241 v9ses->flags &= ~V9FS_ACCESS_MASK;
242 v9ses->flags |= V9FS_ACCESS_ANY;
243 v9ses->uid = ~0;
244 }
245
246 fid = p9_client_attach(v9ses->clnt, NULL, v9ses->uname, ~0,
247 v9ses->aname);
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500248 if (IS_ERR(fid)) {
249 retval = PTR_ERR(fid);
250 fid = NULL;
251 P9_DPRINTK(P9_DEBUG_ERROR, "cannot attach\n");
252 goto error;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700253 }
254
Latchesar Ionkovba176742007-10-17 14:31:07 -0500255 if ((v9ses->flags & V9FS_ACCESS_MASK) == V9FS_ACCESS_SINGLE)
256 fid->uid = v9ses->uid;
257 else
258 fid->uid = ~0;
259
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500260 return fid;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700261
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500262error:
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700263 v9fs_session_close(v9ses);
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500264 return ERR_PTR(retval);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700265}
266
267/**
268 * v9fs_session_close - shutdown a session
269 * @v9ses: session information structure
270 *
271 */
272
273void v9fs_session_close(struct v9fs_session_info *v9ses)
274{
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500275 if (v9ses->clnt) {
276 p9_client_destroy(v9ses->clnt);
277 v9ses->clnt = NULL;
Latchesar Ionkov3cf64292006-01-08 01:04:58 -0800278 }
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700279
Latchesar Ionkovba176742007-10-17 14:31:07 -0500280 __putname(v9ses->uname);
281 __putname(v9ses->aname);
Eric Van Hensbergena80d9232007-10-17 14:31:07 -0500282 kfree(v9ses->options);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700283}
284
Eric Van Hensbergen322b3292005-09-09 13:04:23 -0700285/**
286 * v9fs_session_cancel - mark transport as disconnected
287 * and cancel all pending requests.
288 */
289void v9fs_session_cancel(struct v9fs_session_info *v9ses) {
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500290 P9_DPRINTK(P9_DEBUG_ERROR, "cancel session %p\n", v9ses);
291 p9_client_disconnect(v9ses->clnt);
Eric Van Hensbergen322b3292005-09-09 13:04:23 -0700292}
293
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700294extern int v9fs_error_init(void);
295
296/**
297 * v9fs_init - Initialize module
298 *
299 */
300
301static int __init init_v9fs(void)
302{
Eric Van Hensbergenf94b3472007-01-26 00:57:04 -0800303 printk(KERN_INFO "Installing v9fs 9p2000 file system support\n");
Eric Van Hensbergena80d9232007-10-17 14:31:07 -0500304 /* TODO: Setup list of registered trasnport modules */
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500305 return register_filesystem(&v9fs_fs_type);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700306}
307
308/**
309 * v9fs_init - shutdown module
310 *
311 */
312
313static void __exit exit_v9fs(void)
314{
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700315 unregister_filesystem(&v9fs_fs_type);
316}
317
318module_init(init_v9fs)
319module_exit(exit_v9fs)
320
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500321MODULE_AUTHOR("Latchesar Ionkov <lucho@ionkov.net>");
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700322MODULE_AUTHOR("Eric Van Hensbergen <ericvh@gmail.com>");
323MODULE_AUTHOR("Ron Minnich <rminnich@lanl.gov>");
324MODULE_LICENSE("GPL");