4 * This file contains functions assisting in mapping VFS to 9P2000
6 * Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com>
7 * Copyright (C) 2002 by Ron Minnich <rminnich@lanl.gov>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2
11 * as published by the Free Software Foundation.
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.
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
26 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
28 #include <linux/module.h>
29 #include <linux/errno.h>
31 #include <linux/sched.h>
32 #include <linux/cred.h>
33 #include <linux/parser.h>
34 #include <linux/idr.h>
35 #include <linux/slab.h>
36 #include <linux/seq_file.h>
37 #include <net/9p/9p.h>
38 #include <net/9p/client.h>
39 #include <net/9p/transport.h>
44 static DEFINE_SPINLOCK(v9fs_sessionlist_lock
);
45 static LIST_HEAD(v9fs_sessionlist
);
46 struct kmem_cache
*v9fs_inode_cache
;
49 * Option Parsing (code inspired by NFS code)
50 * NOTE: each transport will parse its own options
54 /* Options that take integer arguments */
55 Opt_debug
, Opt_dfltuid
, Opt_dfltgid
, Opt_afid
,
57 Opt_uname
, Opt_remotename
, Opt_cache
, Opt_cachetag
,
58 /* Options that take no arguments */
61 Opt_cache_loose
, Opt_fscache
, Opt_mmap
,
63 Opt_access
, Opt_posixacl
,
64 /* Lock timeout option */
70 static const match_table_t tokens
= {
71 {Opt_debug
, "debug=%x"},
72 {Opt_dfltuid
, "dfltuid=%u"},
73 {Opt_dfltgid
, "dfltgid=%u"},
74 {Opt_afid
, "afid=%u"},
75 {Opt_uname
, "uname=%s"},
76 {Opt_remotename
, "aname=%s"},
77 {Opt_nodevmap
, "nodevmap"},
78 {Opt_cache
, "cache=%s"},
79 {Opt_cache_loose
, "loose"},
80 {Opt_fscache
, "fscache"},
82 {Opt_cachetag
, "cachetag=%s"},
83 {Opt_access
, "access=%s"},
84 {Opt_posixacl
, "posixacl"},
85 {Opt_locktimeout
, "locktimeout=%u"},
89 static const char *const v9fs_cache_modes
[nr__p9_cache_modes
] = {
90 [CACHE_NONE
] = "none",
91 [CACHE_MMAP
] = "mmap",
92 [CACHE_LOOSE
] = "loose",
93 [CACHE_FSCACHE
] = "fscache",
96 /* Interpret mount options for cache mode */
97 static int get_cache_mode(char *s
)
99 int version
= -EINVAL
;
101 if (!strcmp(s
, "loose")) {
102 version
= CACHE_LOOSE
;
103 p9_debug(P9_DEBUG_9P
, "Cache mode: loose\n");
104 } else if (!strcmp(s
, "fscache")) {
105 version
= CACHE_FSCACHE
;
106 p9_debug(P9_DEBUG_9P
, "Cache mode: fscache\n");
107 } else if (!strcmp(s
, "mmap")) {
108 version
= CACHE_MMAP
;
109 p9_debug(P9_DEBUG_9P
, "Cache mode: mmap\n");
110 } else if (!strcmp(s
, "none")) {
111 version
= CACHE_NONE
;
112 p9_debug(P9_DEBUG_9P
, "Cache mode: none\n");
114 pr_info("Unknown Cache mode %s\n", s
);
119 * Display the mount options in /proc/mounts.
121 int v9fs_show_options(struct seq_file
*m
, struct dentry
*root
)
123 struct v9fs_session_info
*v9ses
= root
->d_sb
->s_fs_info
;
126 seq_printf(m
, ",debug=%x", v9ses
->debug
);
127 if (!uid_eq(v9ses
->dfltuid
, V9FS_DEFUID
))
128 seq_printf(m
, ",dfltuid=%u",
129 from_kuid_munged(&init_user_ns
, v9ses
->dfltuid
));
130 if (!gid_eq(v9ses
->dfltgid
, V9FS_DEFGID
))
131 seq_printf(m
, ",dfltgid=%u",
132 from_kgid_munged(&init_user_ns
, v9ses
->dfltgid
));
133 if (v9ses
->afid
!= ~0)
134 seq_printf(m
, ",afid=%u", v9ses
->afid
);
135 if (strcmp(v9ses
->uname
, V9FS_DEFUSER
) != 0)
136 seq_printf(m
, ",uname=%s", v9ses
->uname
);
137 if (strcmp(v9ses
->aname
, V9FS_DEFANAME
) != 0)
138 seq_printf(m
, ",aname=%s", v9ses
->aname
);
140 seq_puts(m
, ",nodevmap");
142 seq_printf(m
, ",%s", v9fs_cache_modes
[v9ses
->cache
]);
143 #ifdef CONFIG_9P_FSCACHE
144 if (v9ses
->cachetag
&& v9ses
->cache
== CACHE_FSCACHE
)
145 seq_printf(m
, ",cachetag=%s", v9ses
->cachetag
);
148 switch (v9ses
->flags
& V9FS_ACCESS_MASK
) {
149 case V9FS_ACCESS_USER
:
150 seq_puts(m
, ",access=user");
152 case V9FS_ACCESS_ANY
:
153 seq_puts(m
, ",access=any");
155 case V9FS_ACCESS_CLIENT
:
156 seq_puts(m
, ",access=client");
158 case V9FS_ACCESS_SINGLE
:
159 seq_printf(m
, ",access=%u",
160 from_kuid_munged(&init_user_ns
, v9ses
->uid
));
164 if (v9ses
->flags
& V9FS_POSIX_ACL
)
165 seq_puts(m
, ",posixacl");
167 return p9_show_client_options(m
, v9ses
->clnt
);
171 * v9fs_parse_options - parse mount options into session structure
172 * @v9ses: existing v9fs session information
174 * Return 0 upon success, -ERRNO upon failure.
177 static int v9fs_parse_options(struct v9fs_session_info
*v9ses
, char *opts
)
179 char *options
, *tmp_options
;
180 substring_t args
[MAX_OPT_ARGS
];
189 v9ses
->cache
= CACHE_NONE
;
190 #ifdef CONFIG_9P_FSCACHE
191 v9ses
->cachetag
= NULL
;
193 v9ses
->session_lock_timeout
= P9_LOCK_TIMEOUT
;
198 tmp_options
= kstrdup(opts
, GFP_KERNEL
);
201 goto fail_option_alloc
;
203 options
= tmp_options
;
205 while ((p
= strsep(&options
, ",")) != NULL
) {
209 token
= match_token(p
, tokens
, args
);
212 r
= match_int(&args
[0], &option
);
214 p9_debug(P9_DEBUG_ERROR
,
215 "integer field, but no integer?\n");
219 v9ses
->debug
= option
;
220 #ifdef CONFIG_NET_9P_DEBUG
221 p9_debug_level
= option
;
226 r
= match_int(&args
[0], &option
);
228 p9_debug(P9_DEBUG_ERROR
,
229 "integer field, but no integer?\n");
233 v9ses
->dfltuid
= make_kuid(current_user_ns(), option
);
234 if (!uid_valid(v9ses
->dfltuid
)) {
235 p9_debug(P9_DEBUG_ERROR
,
236 "uid field, but not a uid?\n");
242 r
= match_int(&args
[0], &option
);
244 p9_debug(P9_DEBUG_ERROR
,
245 "integer field, but no integer?\n");
249 v9ses
->dfltgid
= make_kgid(current_user_ns(), option
);
250 if (!gid_valid(v9ses
->dfltgid
)) {
251 p9_debug(P9_DEBUG_ERROR
,
252 "gid field, but not a gid?\n");
258 r
= match_int(&args
[0], &option
);
260 p9_debug(P9_DEBUG_ERROR
,
261 "integer field, but no integer?\n");
265 v9ses
->afid
= option
;
269 v9ses
->uname
= match_strdup(&args
[0]);
272 goto free_and_return
;
277 v9ses
->aname
= match_strdup(&args
[0]);
280 goto free_and_return
;
286 case Opt_cache_loose
:
287 v9ses
->cache
= CACHE_LOOSE
;
290 v9ses
->cache
= CACHE_FSCACHE
;
293 v9ses
->cache
= CACHE_MMAP
;
296 #ifdef CONFIG_9P_FSCACHE
297 kfree(v9ses
->cachetag
);
298 v9ses
->cachetag
= match_strdup(&args
[0]);
302 s
= match_strdup(&args
[0]);
305 p9_debug(P9_DEBUG_ERROR
,
306 "problem allocating copy of cache arg\n");
307 goto free_and_return
;
309 ret
= get_cache_mode(s
);
310 if (ret
== -EINVAL
) {
312 goto free_and_return
;
320 s
= match_strdup(&args
[0]);
323 p9_debug(P9_DEBUG_ERROR
,
324 "problem allocating copy of access arg\n");
325 goto free_and_return
;
328 v9ses
->flags
&= ~V9FS_ACCESS_MASK
;
329 if (strcmp(s
, "user") == 0)
330 v9ses
->flags
|= V9FS_ACCESS_USER
;
331 else if (strcmp(s
, "any") == 0)
332 v9ses
->flags
|= V9FS_ACCESS_ANY
;
333 else if (strcmp(s
, "client") == 0) {
334 v9ses
->flags
|= V9FS_ACCESS_CLIENT
;
337 v9ses
->flags
|= V9FS_ACCESS_SINGLE
;
338 uid
= simple_strtoul(s
, &e
, 10);
341 pr_info("Unknown access argument %s\n",
344 goto free_and_return
;
346 v9ses
->uid
= make_kuid(current_user_ns(), uid
);
347 if (!uid_valid(v9ses
->uid
)) {
349 pr_info("Uknown uid %s\n", s
);
351 goto free_and_return
;
359 #ifdef CONFIG_9P_FS_POSIX_ACL
360 v9ses
->flags
|= V9FS_POSIX_ACL
;
362 p9_debug(P9_DEBUG_ERROR
,
363 "Not defined CONFIG_9P_FS_POSIX_ACL. Ignoring posixacl option\n");
367 case Opt_locktimeout
:
368 r
= match_int(&args
[0], &option
);
370 p9_debug(P9_DEBUG_ERROR
,
371 "integer field, but no integer?\n");
376 p9_debug(P9_DEBUG_ERROR
,
377 "locktimeout must be a greater than zero integer.\n");
381 v9ses
->session_lock_timeout
= (long)option
* HZ
;
396 * v9fs_session_init - initialize session
397 * @v9ses: session information structure
398 * @dev_name: device being mounted
403 struct p9_fid
*v9fs_session_init(struct v9fs_session_info
*v9ses
,
404 const char *dev_name
, char *data
)
409 v9ses
->uname
= kstrdup(V9FS_DEFUSER
, GFP_KERNEL
);
413 v9ses
->aname
= kstrdup(V9FS_DEFANAME
, GFP_KERNEL
);
416 init_rwsem(&v9ses
->rename_sem
);
418 v9ses
->uid
= INVALID_UID
;
419 v9ses
->dfltuid
= V9FS_DEFUID
;
420 v9ses
->dfltgid
= V9FS_DEFGID
;
422 v9ses
->clnt
= p9_client_create(dev_name
, data
);
423 if (IS_ERR(v9ses
->clnt
)) {
424 rc
= PTR_ERR(v9ses
->clnt
);
425 p9_debug(P9_DEBUG_ERROR
, "problem initializing 9p client\n");
429 v9ses
->flags
= V9FS_ACCESS_USER
;
431 if (p9_is_proto_dotl(v9ses
->clnt
)) {
432 v9ses
->flags
= V9FS_ACCESS_CLIENT
;
433 v9ses
->flags
|= V9FS_PROTO_2000L
;
434 } else if (p9_is_proto_dotu(v9ses
->clnt
)) {
435 v9ses
->flags
|= V9FS_PROTO_2000U
;
438 rc
= v9fs_parse_options(v9ses
, data
);
442 v9ses
->maxdata
= v9ses
->clnt
->msize
- P9_IOHDRSZ
;
444 if (!v9fs_proto_dotl(v9ses
) &&
445 ((v9ses
->flags
& V9FS_ACCESS_MASK
) == V9FS_ACCESS_CLIENT
)) {
447 * We support ACCESS_CLIENT only for dotl.
448 * Fall back to ACCESS_USER
450 v9ses
->flags
&= ~V9FS_ACCESS_MASK
;
451 v9ses
->flags
|= V9FS_ACCESS_USER
;
454 /* for legacy mode, fall back to V9FS_ACCESS_ANY */
455 if (!(v9fs_proto_dotu(v9ses
) || v9fs_proto_dotl(v9ses
)) &&
456 ((v9ses
->flags
&V9FS_ACCESS_MASK
) == V9FS_ACCESS_USER
)) {
458 v9ses
->flags
&= ~V9FS_ACCESS_MASK
;
459 v9ses
->flags
|= V9FS_ACCESS_ANY
;
460 v9ses
->uid
= INVALID_UID
;
462 if (!v9fs_proto_dotl(v9ses
) ||
463 !((v9ses
->flags
& V9FS_ACCESS_MASK
) == V9FS_ACCESS_CLIENT
)) {
465 * We support ACL checks on clinet only if the protocol is
466 * 9P2000.L and access is V9FS_ACCESS_CLIENT.
468 v9ses
->flags
&= ~V9FS_ACL_MASK
;
471 fid
= p9_client_attach(v9ses
->clnt
, NULL
, v9ses
->uname
, INVALID_UID
,
475 p9_debug(P9_DEBUG_ERROR
, "cannot attach\n");
479 if ((v9ses
->flags
& V9FS_ACCESS_MASK
) == V9FS_ACCESS_SINGLE
)
480 fid
->uid
= v9ses
->uid
;
482 fid
->uid
= INVALID_UID
;
484 #ifdef CONFIG_9P_FSCACHE
485 /* register the session for caching */
486 v9fs_cache_session_get_cookie(v9ses
);
488 spin_lock(&v9fs_sessionlist_lock
);
489 list_add(&v9ses
->slist
, &v9fs_sessionlist
);
490 spin_unlock(&v9fs_sessionlist_lock
);
495 p9_client_destroy(v9ses
->clnt
);
503 * v9fs_session_close - shutdown a session
504 * @v9ses: session information structure
508 void v9fs_session_close(struct v9fs_session_info
*v9ses
)
511 p9_client_destroy(v9ses
->clnt
);
515 #ifdef CONFIG_9P_FSCACHE
517 v9fs_cache_session_put_cookie(v9ses
);
518 kfree(v9ses
->cachetag
);
523 spin_lock(&v9fs_sessionlist_lock
);
524 list_del(&v9ses
->slist
);
525 spin_unlock(&v9fs_sessionlist_lock
);
529 * v9fs_session_cancel - terminate a session
530 * @v9ses: session to terminate
532 * mark transport as disconnected and cancel all pending requests.
535 void v9fs_session_cancel(struct v9fs_session_info
*v9ses
) {
536 p9_debug(P9_DEBUG_ERROR
, "cancel session %p\n", v9ses
);
537 p9_client_disconnect(v9ses
->clnt
);
541 * v9fs_session_begin_cancel - Begin terminate of a session
542 * @v9ses: session to terminate
544 * After this call we don't allow any request other than clunk.
547 void v9fs_session_begin_cancel(struct v9fs_session_info
*v9ses
)
549 p9_debug(P9_DEBUG_ERROR
, "begin cancel session %p\n", v9ses
);
550 p9_client_begin_disconnect(v9ses
->clnt
);
553 extern int v9fs_error_init(void);
555 static struct kobject
*v9fs_kobj
;
557 #ifdef CONFIG_9P_FSCACHE
559 * caches_show - list caches associated with a session
561 * Returns the size of buffer written.
564 static ssize_t
caches_show(struct kobject
*kobj
,
565 struct kobj_attribute
*attr
,
568 ssize_t n
= 0, count
= 0, limit
= PAGE_SIZE
;
569 struct v9fs_session_info
*v9ses
;
571 spin_lock(&v9fs_sessionlist_lock
);
572 list_for_each_entry(v9ses
, &v9fs_sessionlist
, slist
) {
573 if (v9ses
->cachetag
) {
574 n
= snprintf(buf
, limit
, "%s\n", v9ses
->cachetag
);
585 spin_unlock(&v9fs_sessionlist_lock
);
589 static struct kobj_attribute v9fs_attr_cache
= __ATTR_RO(caches
);
590 #endif /* CONFIG_9P_FSCACHE */
592 static struct attribute
*v9fs_attrs
[] = {
593 #ifdef CONFIG_9P_FSCACHE
594 &v9fs_attr_cache
.attr
,
599 static struct attribute_group v9fs_attr_group
= {
604 * v9fs_sysfs_init - Initialize the v9fs sysfs interface
608 static int __init
v9fs_sysfs_init(void)
610 v9fs_kobj
= kobject_create_and_add("9p", fs_kobj
);
614 if (sysfs_create_group(v9fs_kobj
, &v9fs_attr_group
)) {
615 kobject_put(v9fs_kobj
);
623 * v9fs_sysfs_cleanup - Unregister the v9fs sysfs interface
627 static void v9fs_sysfs_cleanup(void)
629 sysfs_remove_group(v9fs_kobj
, &v9fs_attr_group
);
630 kobject_put(v9fs_kobj
);
633 static void v9fs_inode_init_once(void *foo
)
635 struct v9fs_inode
*v9inode
= (struct v9fs_inode
*)foo
;
636 #ifdef CONFIG_9P_FSCACHE
637 v9inode
->fscache
= NULL
;
639 memset(&v9inode
->qid
, 0, sizeof(v9inode
->qid
));
640 inode_init_once(&v9inode
->vfs_inode
);
644 * v9fs_init_inode_cache - initialize a cache for 9P
645 * Returns 0 on success.
647 static int v9fs_init_inode_cache(void)
649 v9fs_inode_cache
= kmem_cache_create("v9fs_inode_cache",
650 sizeof(struct v9fs_inode
),
651 0, (SLAB_RECLAIM_ACCOUNT
|
652 SLAB_MEM_SPREAD
|SLAB_ACCOUNT
),
653 v9fs_inode_init_once
);
654 if (!v9fs_inode_cache
)
661 * v9fs_destroy_inode_cache - destroy the cache of 9P inode
664 static void v9fs_destroy_inode_cache(void)
667 * Make sure all delayed rcu free inodes are flushed before we
671 kmem_cache_destroy(v9fs_inode_cache
);
674 static int v9fs_cache_register(void)
677 ret
= v9fs_init_inode_cache();
680 #ifdef CONFIG_9P_FSCACHE
681 ret
= fscache_register_netfs(&v9fs_cache_netfs
);
683 v9fs_destroy_inode_cache();
688 static void v9fs_cache_unregister(void)
690 v9fs_destroy_inode_cache();
691 #ifdef CONFIG_9P_FSCACHE
692 fscache_unregister_netfs(&v9fs_cache_netfs
);
697 * init_v9fs - Initialize module
701 static int __init
init_v9fs(void)
704 pr_info("Installing v9fs 9p2000 file system support\n");
705 /* TODO: Setup list of registered trasnport modules */
707 err
= v9fs_cache_register();
709 pr_err("Failed to register v9fs for caching\n");
713 err
= v9fs_sysfs_init();
715 pr_err("Failed to register with sysfs\n");
718 err
= register_filesystem(&v9fs_fs_type
);
720 pr_err("Failed to register filesystem\n");
721 goto out_sysfs_cleanup
;
727 v9fs_sysfs_cleanup();
730 v9fs_cache_unregister();
736 * exit_v9fs - shutdown module
740 static void __exit
exit_v9fs(void)
742 v9fs_sysfs_cleanup();
743 v9fs_cache_unregister();
744 unregister_filesystem(&v9fs_fs_type
);
747 module_init(init_v9fs
)
748 module_exit(exit_v9fs
)
750 MODULE_AUTHOR("Latchesar Ionkov <lucho@ionkov.net>");
751 MODULE_AUTHOR("Eric Van Hensbergen <ericvh@gmail.com>");
752 MODULE_AUTHOR("Ron Minnich <rminnich@lanl.gov>");
753 MODULE_LICENSE("GPL");