]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - fs/9p/v9fs.c
Merge branch 'omap-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/tmlind...
[mirror_ubuntu-bionic-kernel.git] / fs / 9p / v9fs.c
CommitLineData
9e82cf6a
EVH
1/*
2 * linux/fs/9p/v9fs.c
3 *
4 * This file contains functions assisting in mapping VFS to 9P2000
5 *
8a0dc95f 6 * Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com>
9e82cf6a
EVH
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
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>
31#include <linux/idr.h>
5a0e3ad6 32#include <linux/slab.h>
bd238fb4 33#include <net/9p/9p.h>
bd238fb4 34#include <net/9p/client.h>
8b81ef58 35#include <net/9p/transport.h>
9e82cf6a 36#include "v9fs.h"
9e82cf6a 37#include "v9fs_vfs.h"
60e78d2c
AK
38#include "cache.h"
39
40static DEFINE_SPINLOCK(v9fs_sessionlist_lock);
41static LIST_HEAD(v9fs_sessionlist);
a78ce05d 42struct kmem_cache *v9fs_inode_cache;
9e82cf6a
EVH
43
44/*
60e78d2c
AK
45 * Option Parsing (code inspired by NFS code)
46 * NOTE: each transport will parse its own options
47 */
9e82cf6a
EVH
48
49enum {
50 /* Options that take integer arguments */
8a0dc95f 51 Opt_debug, Opt_dfltuid, Opt_dfltgid, Opt_afid,
9e82cf6a 52 /* String options */
60e78d2c 53 Opt_uname, Opt_remotename, Opt_trans, Opt_cache, Opt_cachetag,
9e82cf6a 54 /* Options that take no arguments */
8a0dc95f 55 Opt_nodevmap,
e03abc0c 56 /* Cache options */
60e78d2c 57 Opt_cache_loose, Opt_fscache,
ba17674f 58 /* Access options */
e782ef71 59 Opt_access, Opt_posixacl,
9e82cf6a
EVH
60 /* Error token */
61 Opt_err
62};
63
a447c093 64static const match_table_t tokens = {
9e2f6688 65 {Opt_debug, "debug=%x"},
bd32b82d
LI
66 {Opt_dfltuid, "dfltuid=%u"},
67 {Opt_dfltgid, "dfltgid=%u"},
9e82cf6a 68 {Opt_afid, "afid=%u"},
67543e50 69 {Opt_uname, "uname=%s"},
9e82cf6a 70 {Opt_remotename, "aname=%s"},
9e82cf6a 71 {Opt_nodevmap, "nodevmap"},
60e78d2c 72 {Opt_cache, "cache=%s"},
e03abc0c 73 {Opt_cache_loose, "loose"},
60e78d2c
AK
74 {Opt_fscache, "fscache"},
75 {Opt_cachetag, "cachetag=%s"},
ba17674f 76 {Opt_access, "access=%s"},
e782ef71 77 {Opt_posixacl, "posixacl"},
9e82cf6a
EVH
78 {Opt_err, NULL}
79};
80
9e82cf6a
EVH
81/**
82 * v9fs_parse_options - parse mount options into session structure
9e82cf6a
EVH
83 * @v9ses: existing v9fs session information
84 *
ab31267d 85 * Return 0 upon success, -ERRNO upon failure.
9e82cf6a
EVH
86 */
87
4b53e4b5 88static int v9fs_parse_options(struct v9fs_session_info *v9ses, char *opts)
9e82cf6a 89{
d8c8a9e3 90 char *options, *tmp_options;
9e82cf6a 91 substring_t args[MAX_OPT_ARGS];
a80d923e 92 char *p;
8a0dc95f 93 int option = 0;
ba17674f 94 char *s, *e;
ab31267d 95 int ret = 0;
9e82cf6a
EVH
96
97 /* setup defaults */
9e82cf6a
EVH
98 v9ses->afid = ~0;
99 v9ses->debug = 0;
e03abc0c 100 v9ses->cache = 0;
60e78d2c
AK
101#ifdef CONFIG_9P_FSCACHE
102 v9ses->cachetag = NULL;
103#endif
9e82cf6a 104
4b53e4b5 105 if (!opts)
ab31267d 106 return 0;
9e82cf6a 107
d8c8a9e3 108 tmp_options = kstrdup(opts, GFP_KERNEL);
bf2d29c6
EVH
109 if (!tmp_options) {
110 ret = -ENOMEM;
60e78d2c 111 goto fail_option_alloc;
bf2d29c6 112 }
d8c8a9e3 113 options = tmp_options;
ab31267d 114
9e82cf6a
EVH
115 while ((p = strsep(&options, ",")) != NULL) {
116 int token;
117 if (!*p)
118 continue;
119 token = match_token(p, tokens, args);
67543e50 120 if (token < Opt_uname) {
ab31267d
JM
121 int r = match_int(&args[0], &option);
122 if (r < 0) {
bd238fb4 123 P9_DPRINTK(P9_DEBUG_ERROR,
9e82cf6a 124 "integer field, but no integer?\n");
ab31267d 125 ret = r;
9e82cf6a
EVH
126 continue;
127 }
9e82cf6a
EVH
128 }
129 switch (token) {
9e2f6688
EVH
130 case Opt_debug:
131 v9ses->debug = option;
10fa16e7 132#ifdef CONFIG_NET_9P_DEBUG
9e2f6688 133 p9_debug_level = option;
10fa16e7 134#endif
9e2f6688 135 break;
8a0dc95f 136
bd32b82d
LI
137 case Opt_dfltuid:
138 v9ses->dfltuid = option;
9e82cf6a 139 break;
bd32b82d
LI
140 case Opt_dfltgid:
141 v9ses->dfltgid = option;
9e82cf6a
EVH
142 break;
143 case Opt_afid:
144 v9ses->afid = option;
145 break;
67543e50 146 case Opt_uname:
b32a09db 147 match_strlcpy(v9ses->uname, &args[0], PATH_MAX);
9e82cf6a
EVH
148 break;
149 case Opt_remotename:
b32a09db 150 match_strlcpy(v9ses->aname, &args[0], PATH_MAX);
9e82cf6a 151 break;
9e82cf6a
EVH
152 case Opt_nodevmap:
153 v9ses->nodev = 1;
154 break;
e03abc0c
EVH
155 case Opt_cache_loose:
156 v9ses->cache = CACHE_LOOSE;
157 break;
60e78d2c
AK
158 case Opt_fscache:
159 v9ses->cache = CACHE_FSCACHE;
160 break;
161 case Opt_cachetag:
162#ifdef CONFIG_9P_FSCACHE
163 v9ses->cachetag = match_strdup(&args[0]);
164#endif
165 break;
166 case Opt_cache:
167 s = match_strdup(&args[0]);
bf2d29c6
EVH
168 if (!s) {
169 ret = -ENOMEM;
170 P9_DPRINTK(P9_DEBUG_ERROR,
171 "problem allocating copy of cache arg\n");
172 goto free_and_return;
173 }
60e78d2c
AK
174
175 if (strcmp(s, "loose") == 0)
176 v9ses->cache = CACHE_LOOSE;
177 else if (strcmp(s, "fscache") == 0)
178 v9ses->cache = CACHE_FSCACHE;
179 else
180 v9ses->cache = CACHE_NONE;
181 kfree(s);
182 break;
ba17674f
LI
183
184 case Opt_access:
185 s = match_strdup(&args[0]);
bf2d29c6
EVH
186 if (!s) {
187 ret = -ENOMEM;
188 P9_DPRINTK(P9_DEBUG_ERROR,
189 "problem allocating copy of access arg\n");
190 goto free_and_return;
191 }
60e78d2c 192
ba17674f
LI
193 v9ses->flags &= ~V9FS_ACCESS_MASK;
194 if (strcmp(s, "user") == 0)
195 v9ses->flags |= V9FS_ACCESS_USER;
196 else if (strcmp(s, "any") == 0)
197 v9ses->flags |= V9FS_ACCESS_ANY;
76381a42 198 else if (strcmp(s, "client") == 0) {
76381a42 199 v9ses->flags |= V9FS_ACCESS_CLIENT;
76381a42 200 } else {
ba17674f 201 v9ses->flags |= V9FS_ACCESS_SINGLE;
f1d9e458 202 v9ses->uid = simple_strtoul(s, &e, 10);
ba17674f
LI
203 if (*e != '\0')
204 v9ses->uid = ~0;
205 }
0a976297 206 kfree(s);
ba17674f
LI
207 break;
208
e782ef71
VJJ
209 case Opt_posixacl:
210#ifdef CONFIG_9P_FS_POSIX_ACL
211 v9ses->flags |= V9FS_POSIX_ACL;
212#else
213 P9_DPRINTK(P9_DEBUG_ERROR,
214 "Not defined CONFIG_9P_FS_POSIX_ACL. "
215 "Ignoring posixacl option\n");
216#endif
217 break;
218
9e82cf6a
EVH
219 default:
220 continue;
221 }
222 }
d8c8a9e3 223
bf2d29c6 224free_and_return:
d8c8a9e3 225 kfree(tmp_options);
60e78d2c 226fail_option_alloc:
bf2d29c6 227 return ret;
9e82cf6a
EVH
228}
229
9e82cf6a
EVH
230/**
231 * v9fs_session_init - initialize session
232 * @v9ses: session information structure
233 * @dev_name: device being mounted
234 * @data: options
235 *
236 */
237
bd238fb4 238struct p9_fid *v9fs_session_init(struct v9fs_session_info *v9ses,
9e82cf6a
EVH
239 const char *dev_name, char *data)
240{
9e82cf6a 241 int retval = -EINVAL;
bd238fb4 242 struct p9_fid *fid;
ab31267d 243 int rc;
9e82cf6a 244
ba17674f
LI
245 v9ses->uname = __getname();
246 if (!v9ses->uname)
bd238fb4 247 return ERR_PTR(-ENOMEM);
9e82cf6a 248
ba17674f
LI
249 v9ses->aname = __getname();
250 if (!v9ses->aname) {
251 __putname(v9ses->uname);
bd238fb4 252 return ERR_PTR(-ENOMEM);
9e82cf6a 253 }
a534c8d1 254 init_rwsem(&v9ses->rename_sem);
9e82cf6a 255
0ed07ddb
JA
256 rc = bdi_setup_and_register(&v9ses->bdi, "9p", BDI_CAP_MAP_COPY);
257 if (rc) {
258 __putname(v9ses->aname);
259 __putname(v9ses->uname);
260 return ERR_PTR(rc);
261 }
262
60e78d2c
AK
263 spin_lock(&v9fs_sessionlist_lock);
264 list_add(&v9ses->slist, &v9fs_sessionlist);
265 spin_unlock(&v9fs_sessionlist_lock);
266
ba17674f
LI
267 strcpy(v9ses->uname, V9FS_DEFUSER);
268 strcpy(v9ses->aname, V9FS_DEFANAME);
269 v9ses->uid = ~0;
bd32b82d
LI
270 v9ses->dfltuid = V9FS_DEFUID;
271 v9ses->dfltgid = V9FS_DEFGID;
ab31267d 272
4b53e4b5 273 v9ses->clnt = p9_client_create(dev_name, data);
bd238fb4
LI
274 if (IS_ERR(v9ses->clnt)) {
275 retval = PTR_ERR(v9ses->clnt);
276 v9ses->clnt = NULL;
277 P9_DPRINTK(P9_DEBUG_ERROR, "problem initializing 9p client\n");
278 goto error;
9e82cf6a
EVH
279 }
280
6752a1eb
VJJ
281 v9ses->flags = V9FS_ACCESS_USER;
282
283 if (p9_is_proto_dotl(v9ses->clnt)) {
284 v9ses->flags = V9FS_ACCESS_CLIENT;
476ada04 285 v9ses->flags |= V9FS_PROTO_2000L;
6752a1eb 286 } else if (p9_is_proto_dotu(v9ses->clnt)) {
476ada04 287 v9ses->flags |= V9FS_PROTO_2000U;
6752a1eb
VJJ
288 }
289
290 rc = v9fs_parse_options(v9ses, data);
291 if (rc < 0) {
292 retval = rc;
293 goto error;
294 }
ba17674f 295
fbedadc1 296 v9ses->maxdata = v9ses->clnt->msize - P9_IOHDRSZ;
8a0dc95f 297
76381a42
AK
298 if (!v9fs_proto_dotl(v9ses) &&
299 ((v9ses->flags & V9FS_ACCESS_MASK) == V9FS_ACCESS_CLIENT)) {
300 /*
301 * We support ACCESS_CLIENT only for dotl.
302 * Fall back to ACCESS_USER
303 */
304 v9ses->flags &= ~V9FS_ACCESS_MASK;
305 v9ses->flags |= V9FS_ACCESS_USER;
306 }
307 /*FIXME !! */
ba17674f 308 /* for legacy mode, fall back to V9FS_ACCESS_ANY */
9ffaf63e 309 if (!(v9fs_proto_dotu(v9ses) || v9fs_proto_dotl(v9ses)) &&
ba17674f
LI
310 ((v9ses->flags&V9FS_ACCESS_MASK) == V9FS_ACCESS_USER)) {
311
312 v9ses->flags &= ~V9FS_ACCESS_MASK;
313 v9ses->flags |= V9FS_ACCESS_ANY;
314 v9ses->uid = ~0;
315 }
e782ef71
VJJ
316 if (!v9fs_proto_dotl(v9ses) ||
317 !((v9ses->flags & V9FS_ACCESS_MASK) == V9FS_ACCESS_CLIENT)) {
318 /*
319 * We support ACL checks on clinet only if the protocol is
320 * 9P2000.L and access is V9FS_ACCESS_CLIENT.
321 */
322 v9ses->flags &= ~V9FS_ACL_MASK;
323 }
ba17674f
LI
324
325 fid = p9_client_attach(v9ses->clnt, NULL, v9ses->uname, ~0,
326 v9ses->aname);
bd238fb4
LI
327 if (IS_ERR(fid)) {
328 retval = PTR_ERR(fid);
329 fid = NULL;
330 P9_DPRINTK(P9_DEBUG_ERROR, "cannot attach\n");
331 goto error;
9e82cf6a
EVH
332 }
333
ba17674f
LI
334 if ((v9ses->flags & V9FS_ACCESS_MASK) == V9FS_ACCESS_SINGLE)
335 fid->uid = v9ses->uid;
336 else
337 fid->uid = ~0;
338
60e78d2c
AK
339#ifdef CONFIG_9P_FSCACHE
340 /* register the session for caching */
341 v9fs_cache_session_get_cookie(v9ses);
342#endif
343
bd238fb4 344 return fid;
9e82cf6a 345
bd238fb4 346error:
0ed07ddb 347 bdi_destroy(&v9ses->bdi);
bd238fb4 348 return ERR_PTR(retval);
9e82cf6a
EVH
349}
350
351/**
352 * v9fs_session_close - shutdown a session
353 * @v9ses: session information structure
354 *
355 */
356
357void v9fs_session_close(struct v9fs_session_info *v9ses)
358{
bd238fb4
LI
359 if (v9ses->clnt) {
360 p9_client_destroy(v9ses->clnt);
361 v9ses->clnt = NULL;
3cf6429a 362 }
9e82cf6a 363
60e78d2c
AK
364#ifdef CONFIG_9P_FSCACHE
365 if (v9ses->fscache) {
366 v9fs_cache_session_put_cookie(v9ses);
367 kfree(v9ses->cachetag);
368 }
369#endif
ba17674f
LI
370 __putname(v9ses->uname);
371 __putname(v9ses->aname);
60e78d2c 372
0ed07ddb
JA
373 bdi_destroy(&v9ses->bdi);
374
60e78d2c
AK
375 spin_lock(&v9fs_sessionlist_lock);
376 list_del(&v9ses->slist);
377 spin_unlock(&v9fs_sessionlist_lock);
9e82cf6a
EVH
378}
379
322b329a 380/**
ee443996
EVH
381 * v9fs_session_cancel - terminate a session
382 * @v9ses: session to terminate
383 *
384 * mark transport as disconnected and cancel all pending requests.
322b329a 385 */
ee443996 386
322b329a 387void v9fs_session_cancel(struct v9fs_session_info *v9ses) {
bd238fb4
LI
388 P9_DPRINTK(P9_DEBUG_ERROR, "cancel session %p\n", v9ses);
389 p9_client_disconnect(v9ses->clnt);
322b329a
EVH
390}
391
6d96d3ab
AK
392/**
393 * v9fs_session_begin_cancel - Begin terminate of a session
394 * @v9ses: session to terminate
395 *
396 * After this call we don't allow any request other than clunk.
397 */
398
399void v9fs_session_begin_cancel(struct v9fs_session_info *v9ses)
400{
401 P9_DPRINTK(P9_DEBUG_ERROR, "begin cancel session %p\n", v9ses);
402 p9_client_begin_disconnect(v9ses->clnt);
403}
404
9e82cf6a
EVH
405extern int v9fs_error_init(void);
406
60e78d2c
AK
407static struct kobject *v9fs_kobj;
408
409#ifdef CONFIG_9P_FSCACHE
9e82cf6a 410/**
60e78d2c
AK
411 * caches_show - list caches associated with a session
412 *
413 * Returns the size of buffer written.
414 */
415
416static ssize_t caches_show(struct kobject *kobj,
417 struct kobj_attribute *attr,
418 char *buf)
419{
420 ssize_t n = 0, count = 0, limit = PAGE_SIZE;
421 struct v9fs_session_info *v9ses;
422
423 spin_lock(&v9fs_sessionlist_lock);
424 list_for_each_entry(v9ses, &v9fs_sessionlist, slist) {
425 if (v9ses->cachetag) {
426 n = snprintf(buf, limit, "%s\n", v9ses->cachetag);
427 if (n < 0) {
428 count = n;
429 break;
430 }
431
432 count += n;
433 limit -= n;
434 }
435 }
436
437 spin_unlock(&v9fs_sessionlist_lock);
438 return count;
439}
440
441static struct kobj_attribute v9fs_attr_cache = __ATTR_RO(caches);
442#endif /* CONFIG_9P_FSCACHE */
443
444static struct attribute *v9fs_attrs[] = {
445#ifdef CONFIG_9P_FSCACHE
446 &v9fs_attr_cache.attr,
447#endif
448 NULL,
449};
450
451static struct attribute_group v9fs_attr_group = {
452 .attrs = v9fs_attrs,
453};
454
455/**
456 * v9fs_sysfs_init - Initialize the v9fs sysfs interface
457 *
458 */
459
460static int v9fs_sysfs_init(void)
461{
462 v9fs_kobj = kobject_create_and_add("9p", fs_kobj);
463 if (!v9fs_kobj)
464 return -ENOMEM;
465
466 if (sysfs_create_group(v9fs_kobj, &v9fs_attr_group)) {
467 kobject_put(v9fs_kobj);
468 return -ENOMEM;
469 }
470
471 return 0;
472}
473
474/**
475 * v9fs_sysfs_cleanup - Unregister the v9fs sysfs interface
476 *
477 */
478
479static void v9fs_sysfs_cleanup(void)
480{
481 sysfs_remove_group(v9fs_kobj, &v9fs_attr_group);
482 kobject_put(v9fs_kobj);
483}
484
a78ce05d
AK
485static void v9fs_inode_init_once(void *foo)
486{
487 struct v9fs_inode *v9inode = (struct v9fs_inode *)foo;
488#ifdef CONFIG_9P_FSCACHE
489 v9inode->fscache = NULL;
490 v9inode->fscache_key = NULL;
491#endif
492 inode_init_once(&v9inode->vfs_inode);
493}
494
495/**
496 * v9fs_init_inode_cache - initialize a cache for 9P
497 * Returns 0 on success.
498 */
499static int v9fs_init_inode_cache(void)
500{
501 v9fs_inode_cache = kmem_cache_create("v9fs_inode_cache",
502 sizeof(struct v9fs_inode),
503 0, (SLAB_RECLAIM_ACCOUNT|
504 SLAB_MEM_SPREAD),
505 v9fs_inode_init_once);
506 if (!v9fs_inode_cache)
507 return -ENOMEM;
508
509 return 0;
510}
511
512/**
513 * v9fs_destroy_inode_cache - destroy the cache of 9P inode
514 *
515 */
516static void v9fs_destroy_inode_cache(void)
517{
518 kmem_cache_destroy(v9fs_inode_cache);
519}
520
521static int v9fs_cache_register(void)
522{
523 int ret;
524 ret = v9fs_init_inode_cache();
525 if (ret < 0)
526 return ret;
527#ifdef CONFIG_9P_FSCACHE
528 return fscache_register_netfs(&v9fs_cache_netfs);
529#else
530 return ret;
531#endif
532}
533
534static void v9fs_cache_unregister(void)
535{
536 v9fs_destroy_inode_cache();
537#ifdef CONFIG_9P_FSCACHE
538 fscache_unregister_netfs(&v9fs_cache_netfs);
539#endif
540}
541
60e78d2c
AK
542/**
543 * init_v9fs - Initialize module
9e82cf6a
EVH
544 *
545 */
546
547static int __init init_v9fs(void)
548{
60e78d2c 549 int err;
f94b3470 550 printk(KERN_INFO "Installing v9fs 9p2000 file system support\n");
a80d923e 551 /* TODO: Setup list of registered trasnport modules */
60e78d2c
AK
552 err = register_filesystem(&v9fs_fs_type);
553 if (err < 0) {
554 printk(KERN_ERR "Failed to register filesystem\n");
555 return err;
556 }
557
558 err = v9fs_cache_register();
559 if (err < 0) {
560 printk(KERN_ERR "Failed to register v9fs for caching\n");
561 goto out_fs_unreg;
562 }
563
564 err = v9fs_sysfs_init();
565 if (err < 0) {
566 printk(KERN_ERR "Failed to register with sysfs\n");
567 goto out_sysfs_cleanup;
568 }
569
570 return 0;
571
572out_sysfs_cleanup:
573 v9fs_sysfs_cleanup();
574
575out_fs_unreg:
576 unregister_filesystem(&v9fs_fs_type);
577
578 return err;
9e82cf6a
EVH
579}
580
581/**
60e78d2c 582 * exit_v9fs - shutdown module
9e82cf6a
EVH
583 *
584 */
585
586static void __exit exit_v9fs(void)
587{
60e78d2c
AK
588 v9fs_sysfs_cleanup();
589 v9fs_cache_unregister();
9e82cf6a
EVH
590 unregister_filesystem(&v9fs_fs_type);
591}
592
593module_init(init_v9fs)
594module_exit(exit_v9fs)
595
bd238fb4 596MODULE_AUTHOR("Latchesar Ionkov <lucho@ionkov.net>");
9e82cf6a
EVH
597MODULE_AUTHOR("Eric Van Hensbergen <ericvh@gmail.com>");
598MODULE_AUTHOR("Ron Minnich <rminnich@lanl.gov>");
599MODULE_LICENSE("GPL");