blob: 24eb01087b6d63313404dff82b4f192177189342 [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 *
Eric Van Hensbergen8a0dc952008-02-06 19:25:03 -06006 * Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com>
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -07007 * 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>
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -050033#include <net/9p/client.h>
Eric Van Hensbergen8b81ef52008-10-13 18:45:25 -050034#include <net/9p/transport.h>
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070035#include "v9fs.h"
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070036#include "v9fs_vfs.h"
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070037
38/*
39 * Option Parsing (code inspired by NFS code)
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050040 * NOTE: each transport will parse its own options
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070041 */
42
43enum {
44 /* Options that take integer arguments */
Eric Van Hensbergen8a0dc952008-02-06 19:25:03 -060045 Opt_debug, Opt_dfltuid, Opt_dfltgid, Opt_afid,
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070046 /* String options */
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050047 Opt_uname, Opt_remotename, Opt_trans,
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070048 /* Options that take no arguments */
Eric Van Hensbergen8a0dc952008-02-06 19:25:03 -060049 Opt_nodevmap,
Eric Van Hensbergene03abc02007-02-11 13:21:39 -060050 /* Cache options */
51 Opt_cache_loose,
Latchesar Ionkovba176742007-10-17 14:31:07 -050052 /* Access options */
53 Opt_access,
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070054 /* Error token */
55 Opt_err
56};
57
Steven Whitehousea447c092008-10-13 10:46:57 +010058static const match_table_t tokens = {
Eric Van Hensbergen9e2f6682007-07-13 13:05:21 -050059 {Opt_debug, "debug=%x"},
Latchesar Ionkovbd32b822007-10-17 14:31:07 -050060 {Opt_dfltuid, "dfltuid=%u"},
61 {Opt_dfltgid, "dfltgid=%u"},
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070062 {Opt_afid, "afid=%u"},
Eric Van Hensbergen67543e52006-03-25 03:07:29 -080063 {Opt_uname, "uname=%s"},
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070064 {Opt_remotename, "aname=%s"},
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070065 {Opt_nodevmap, "nodevmap"},
Eric Van Hensbergene03abc02007-02-11 13:21:39 -060066 {Opt_cache_loose, "cache=loose"},
67 {Opt_cache_loose, "loose"},
Latchesar Ionkovba176742007-10-17 14:31:07 -050068 {Opt_access, "access=%s"},
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070069 {Opt_err, NULL}
70};
71
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070072/**
73 * v9fs_parse_options - parse mount options into session structure
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070074 * @v9ses: existing v9fs session information
75 *
Jim Meyeringab312672008-03-06 17:10:28 -060076 * Return 0 upon success, -ERRNO upon failure.
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070077 */
78
Jim Meyeringab312672008-03-06 17:10:28 -060079static int v9fs_parse_options(struct v9fs_session_info *v9ses)
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070080{
Latchesar Ionkov8999e042007-11-06 08:02:53 -060081 char *options;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070082 substring_t args[MAX_OPT_ARGS];
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050083 char *p;
Eric Van Hensbergen8a0dc952008-02-06 19:25:03 -060084 int option = 0;
Latchesar Ionkovba176742007-10-17 14:31:07 -050085 char *s, *e;
Jim Meyeringab312672008-03-06 17:10:28 -060086 int ret = 0;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070087
88 /* setup defaults */
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070089 v9ses->afid = ~0;
90 v9ses->debug = 0;
Eric Van Hensbergene03abc02007-02-11 13:21:39 -060091 v9ses->cache = 0;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070092
Latchesar Ionkov8999e042007-11-06 08:02:53 -060093 if (!v9ses->options)
Jim Meyeringab312672008-03-06 17:10:28 -060094 return 0;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070095
Latchesar Ionkov8999e042007-11-06 08:02:53 -060096 options = kstrdup(v9ses->options, GFP_KERNEL);
Jim Meyeringab312672008-03-06 17:10:28 -060097 if (!options) {
98 P9_DPRINTK(P9_DEBUG_ERROR,
99 "failed to allocate copy of option string\n");
100 return -ENOMEM;
101 }
102
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700103 while ((p = strsep(&options, ",")) != NULL) {
104 int token;
105 if (!*p)
106 continue;
107 token = match_token(p, tokens, args);
Eric Van Hensbergen67543e52006-03-25 03:07:29 -0800108 if (token < Opt_uname) {
Jim Meyeringab312672008-03-06 17:10:28 -0600109 int r = match_int(&args[0], &option);
110 if (r < 0) {
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500111 P9_DPRINTK(P9_DEBUG_ERROR,
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700112 "integer field, but no integer?\n");
Jim Meyeringab312672008-03-06 17:10:28 -0600113 ret = r;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700114 continue;
115 }
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700116 }
117 switch (token) {
Eric Van Hensbergen9e2f6682007-07-13 13:05:21 -0500118 case Opt_debug:
119 v9ses->debug = option;
Eric Van Hensbergen10fa16e2007-07-16 16:02:49 -0500120#ifdef CONFIG_NET_9P_DEBUG
Eric Van Hensbergen9e2f6682007-07-13 13:05:21 -0500121 p9_debug_level = option;
Eric Van Hensbergen10fa16e2007-07-16 16:02:49 -0500122#endif
Eric Van Hensbergen9e2f6682007-07-13 13:05:21 -0500123 break;
Eric Van Hensbergen8a0dc952008-02-06 19:25:03 -0600124
Latchesar Ionkovbd32b822007-10-17 14:31:07 -0500125 case Opt_dfltuid:
126 v9ses->dfltuid = option;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700127 break;
Latchesar Ionkovbd32b822007-10-17 14:31:07 -0500128 case Opt_dfltgid:
129 v9ses->dfltgid = option;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700130 break;
131 case Opt_afid:
132 v9ses->afid = option;
133 break;
Eric Van Hensbergen67543e52006-03-25 03:07:29 -0800134 case Opt_uname:
Markus Armbrusterb32a09d2008-02-26 09:57:11 -0600135 match_strlcpy(v9ses->uname, &args[0], PATH_MAX);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700136 break;
137 case Opt_remotename:
Markus Armbrusterb32a09d2008-02-26 09:57:11 -0600138 match_strlcpy(v9ses->aname, &args[0], PATH_MAX);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700139 break;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700140 case Opt_nodevmap:
141 v9ses->nodev = 1;
142 break;
Eric Van Hensbergene03abc02007-02-11 13:21:39 -0600143 case Opt_cache_loose:
144 v9ses->cache = CACHE_LOOSE;
145 break;
Latchesar Ionkovba176742007-10-17 14:31:07 -0500146
147 case Opt_access:
148 s = match_strdup(&args[0]);
Jim Meyeringab312672008-03-06 17:10:28 -0600149 if (!s) {
150 P9_DPRINTK(P9_DEBUG_ERROR,
151 "failed to allocate copy"
152 " of option argument\n");
153 ret = -ENOMEM;
154 break;
155 }
Latchesar Ionkovba176742007-10-17 14:31:07 -0500156 v9ses->flags &= ~V9FS_ACCESS_MASK;
157 if (strcmp(s, "user") == 0)
158 v9ses->flags |= V9FS_ACCESS_USER;
159 else if (strcmp(s, "any") == 0)
160 v9ses->flags |= V9FS_ACCESS_ANY;
161 else {
162 v9ses->flags |= V9FS_ACCESS_SINGLE;
163 v9ses->uid = simple_strtol(s, &e, 10);
164 if (*e != '\0')
165 v9ses->uid = ~0;
166 }
Adrian Bunk0a976292007-10-23 13:48:50 -0500167 kfree(s);
Latchesar Ionkovba176742007-10-17 14:31:07 -0500168 break;
169
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700170 default:
171 continue;
172 }
173 }
Latchesar Ionkov8999e042007-11-06 08:02:53 -0600174 kfree(options);
Jim Meyeringab312672008-03-06 17:10:28 -0600175 return ret;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700176}
177
178/**
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700179 * v9fs_session_init - initialize session
180 * @v9ses: session information structure
181 * @dev_name: device being mounted
182 * @data: options
183 *
184 */
185
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500186struct p9_fid *v9fs_session_init(struct v9fs_session_info *v9ses,
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700187 const char *dev_name, char *data)
188{
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700189 int retval = -EINVAL;
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500190 struct p9_fid *fid;
Jim Meyeringab312672008-03-06 17:10:28 -0600191 int rc;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700192
Latchesar Ionkovba176742007-10-17 14:31:07 -0500193 v9ses->uname = __getname();
194 if (!v9ses->uname)
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500195 return ERR_PTR(-ENOMEM);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700196
Latchesar Ionkovba176742007-10-17 14:31:07 -0500197 v9ses->aname = __getname();
198 if (!v9ses->aname) {
199 __putname(v9ses->uname);
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500200 return ERR_PTR(-ENOMEM);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700201 }
202
Latchesar Ionkovba176742007-10-17 14:31:07 -0500203 v9ses->flags = V9FS_EXTENDED | V9FS_ACCESS_USER;
204 strcpy(v9ses->uname, V9FS_DEFUSER);
205 strcpy(v9ses->aname, V9FS_DEFANAME);
206 v9ses->uid = ~0;
Latchesar Ionkovbd32b822007-10-17 14:31:07 -0500207 v9ses->dfltuid = V9FS_DEFUID;
208 v9ses->dfltgid = V9FS_DEFGID;
Eric Van Hensbergen887b3ec2008-05-08 20:26:37 -0500209 if (data) {
210 v9ses->options = kstrdup(data, GFP_KERNEL);
211 if (!v9ses->options) {
212 P9_DPRINTK(P9_DEBUG_ERROR,
Jim Meyeringab312672008-03-06 17:10:28 -0600213 "failed to allocate copy of option string\n");
Eric Van Hensbergen887b3ec2008-05-08 20:26:37 -0500214 retval = -ENOMEM;
215 goto error;
216 }
Jim Meyeringab312672008-03-06 17:10:28 -0600217 }
218
219 rc = v9fs_parse_options(v9ses);
220 if (rc < 0) {
221 retval = rc;
222 goto error;
223 }
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700224
Eric Van Hensbergen8a0dc952008-02-06 19:25:03 -0600225 v9ses->clnt = p9_client_create(dev_name, v9ses->options);
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
Eric Van Hensbergenfbedadc2008-10-13 20:36:16 -0500237 v9ses->maxdata = v9ses->clnt->msize - P9_IOHDRSZ;
Eric Van Hensbergen8a0dc952008-02-06 19:25:03 -0600238
Latchesar Ionkovba176742007-10-17 14:31:07 -0500239 /* for legacy mode, fall back to V9FS_ACCESS_ANY */
240 if (!v9fs_extended(v9ses) &&
241 ((v9ses->flags&V9FS_ACCESS_MASK) == V9FS_ACCESS_USER)) {
242
243 v9ses->flags &= ~V9FS_ACCESS_MASK;
244 v9ses->flags |= V9FS_ACCESS_ANY;
245 v9ses->uid = ~0;
246 }
247
248 fid = p9_client_attach(v9ses->clnt, NULL, v9ses->uname, ~0,
249 v9ses->aname);
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500250 if (IS_ERR(fid)) {
251 retval = PTR_ERR(fid);
252 fid = NULL;
253 P9_DPRINTK(P9_DEBUG_ERROR, "cannot attach\n");
254 goto error;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700255 }
256
Latchesar Ionkovba176742007-10-17 14:31:07 -0500257 if ((v9ses->flags & V9FS_ACCESS_MASK) == V9FS_ACCESS_SINGLE)
258 fid->uid = v9ses->uid;
259 else
260 fid->uid = ~0;
261
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500262 return fid;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700263
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500264error:
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500265 return ERR_PTR(retval);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700266}
267
268/**
269 * v9fs_session_close - shutdown a session
270 * @v9ses: session information structure
271 *
272 */
273
274void v9fs_session_close(struct v9fs_session_info *v9ses)
275{
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500276 if (v9ses->clnt) {
277 p9_client_destroy(v9ses->clnt);
278 v9ses->clnt = NULL;
Latchesar Ionkov3cf64292006-01-08 01:04:58 -0800279 }
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700280
Latchesar Ionkovba176742007-10-17 14:31:07 -0500281 __putname(v9ses->uname);
282 __putname(v9ses->aname);
Eric Van Hensbergena80d9232007-10-17 14:31:07 -0500283 kfree(v9ses->options);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700284}
285
Eric Van Hensbergen322b3292005-09-09 13:04:23 -0700286/**
Eric Van Hensbergenee443992008-03-05 07:08:09 -0600287 * v9fs_session_cancel - terminate a session
288 * @v9ses: session to terminate
289 *
290 * mark transport as disconnected and cancel all pending requests.
Eric Van Hensbergen322b3292005-09-09 13:04:23 -0700291 */
Eric Van Hensbergenee443992008-03-05 07:08:09 -0600292
Eric Van Hensbergen322b3292005-09-09 13:04:23 -0700293void v9fs_session_cancel(struct v9fs_session_info *v9ses) {
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500294 P9_DPRINTK(P9_DEBUG_ERROR, "cancel session %p\n", v9ses);
295 p9_client_disconnect(v9ses->clnt);
Eric Van Hensbergen322b3292005-09-09 13:04:23 -0700296}
297
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700298extern int v9fs_error_init(void);
299
300/**
301 * v9fs_init - Initialize module
302 *
303 */
304
305static int __init init_v9fs(void)
306{
Eric Van Hensbergenf94b3472007-01-26 00:57:04 -0800307 printk(KERN_INFO "Installing v9fs 9p2000 file system support\n");
Eric Van Hensbergena80d9232007-10-17 14:31:07 -0500308 /* TODO: Setup list of registered trasnport modules */
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500309 return register_filesystem(&v9fs_fs_type);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700310}
311
312/**
313 * v9fs_init - shutdown module
314 *
315 */
316
317static void __exit exit_v9fs(void)
318{
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700319 unregister_filesystem(&v9fs_fs_type);
320}
321
322module_init(init_v9fs)
323module_exit(exit_v9fs)
324
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500325MODULE_AUTHOR("Latchesar Ionkov <lucho@ionkov.net>");
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700326MODULE_AUTHOR("Eric Van Hensbergen <ericvh@gmail.com>");
327MODULE_AUTHOR("Ron Minnich <rminnich@lanl.gov>");
328MODULE_LICENSE("GPL");