1 // SPDX-License-Identifier: GPL-2.0-only
3 * This file contains functions assisting in mapping VFS to 9P2000
5 * Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com>
6 * Copyright (C) 2002 by Ron Minnich <rminnich@lanl.gov>
9 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
11 #include <linux/module.h>
12 #include <linux/errno.h>
14 #include <linux/sched.h>
15 #include <linux/cred.h>
16 #include <linux/parser.h>
17 #include <linux/idr.h>
18 #include <linux/slab.h>
19 #include <linux/seq_file.h>
20 #include <net/9p/9p.h>
21 #include <net/9p/client.h>
22 #include <net/9p/transport.h>
27 static DEFINE_SPINLOCK(v9fs_sessionlist_lock);
28 static LIST_HEAD(v9fs_sessionlist);
29 struct kmem_cache *v9fs_inode_cache;
32 * Option Parsing (code inspired by NFS code)
33 * NOTE: each transport will parse its own options
37 /* Options that take integer arguments */
38 Opt_debug, Opt_dfltuid, Opt_dfltgid, Opt_afid,
40 Opt_uname, Opt_remotename, Opt_cache, Opt_cachetag,
41 /* Options that take no arguments */
44 Opt_cache_loose, Opt_fscache, Opt_mmap,
46 Opt_access, Opt_posixacl,
47 /* Lock timeout option */
53 static const match_table_t tokens = {
54 {Opt_debug, "debug=%x"},
55 {Opt_dfltuid, "dfltuid=%u"},
56 {Opt_dfltgid, "dfltgid=%u"},
57 {Opt_afid, "afid=%u"},
58 {Opt_uname, "uname=%s"},
59 {Opt_remotename, "aname=%s"},
60 {Opt_nodevmap, "nodevmap"},
61 {Opt_cache, "cache=%s"},
62 {Opt_cache_loose, "loose"},
63 {Opt_fscache, "fscache"},
65 {Opt_cachetag, "cachetag=%s"},
66 {Opt_access, "access=%s"},
67 {Opt_posixacl, "posixacl"},
68 {Opt_locktimeout, "locktimeout=%u"},
72 static const char *const v9fs_cache_modes[nr__p9_cache_modes] = {
73 [CACHE_NONE] = "none",
74 [CACHE_MMAP] = "mmap",
75 [CACHE_LOOSE] = "loose",
76 [CACHE_FSCACHE] = "fscache",
79 /* Interpret mount options for cache mode */
80 static int get_cache_mode(char *s)
82 int version = -EINVAL;
84 if (!strcmp(s, "loose")) {
85 version = CACHE_LOOSE;
86 p9_debug(P9_DEBUG_9P, "Cache mode: loose\n");
87 } else if (!strcmp(s, "fscache")) {
88 version = CACHE_FSCACHE;
89 p9_debug(P9_DEBUG_9P, "Cache mode: fscache\n");
90 } else if (!strcmp(s, "mmap")) {
92 p9_debug(P9_DEBUG_9P, "Cache mode: mmap\n");
93 } else if (!strcmp(s, "none")) {
95 p9_debug(P9_DEBUG_9P, "Cache mode: none\n");
97 pr_info("Unknown Cache mode %s\n", s);
102 * Display the mount options in /proc/mounts.
104 int v9fs_show_options(struct seq_file *m, struct dentry *root)
106 struct v9fs_session_info *v9ses = root->d_sb->s_fs_info;
109 seq_printf(m, ",debug=%x", v9ses->debug);
110 if (!uid_eq(v9ses->dfltuid, V9FS_DEFUID))
111 seq_printf(m, ",dfltuid=%u",
112 from_kuid_munged(&init_user_ns, v9ses->dfltuid));
113 if (!gid_eq(v9ses->dfltgid, V9FS_DEFGID))
114 seq_printf(m, ",dfltgid=%u",
115 from_kgid_munged(&init_user_ns, v9ses->dfltgid));
116 if (v9ses->afid != ~0)
117 seq_printf(m, ",afid=%u", v9ses->afid);
118 if (strcmp(v9ses->uname, V9FS_DEFUSER) != 0)
119 seq_printf(m, ",uname=%s", v9ses->uname);
120 if (strcmp(v9ses->aname, V9FS_DEFANAME) != 0)
121 seq_printf(m, ",aname=%s", v9ses->aname);
123 seq_puts(m, ",nodevmap");
125 seq_printf(m, ",%s", v9fs_cache_modes[v9ses->cache]);
126 #ifdef CONFIG_9P_FSCACHE
127 if (v9ses->cachetag && v9ses->cache == CACHE_FSCACHE)
128 seq_printf(m, ",cachetag=%s", v9ses->cachetag);
131 switch (v9ses->flags & V9FS_ACCESS_MASK) {
132 case V9FS_ACCESS_USER:
133 seq_puts(m, ",access=user");
135 case V9FS_ACCESS_ANY:
136 seq_puts(m, ",access=any");
138 case V9FS_ACCESS_CLIENT:
139 seq_puts(m, ",access=client");
141 case V9FS_ACCESS_SINGLE:
142 seq_printf(m, ",access=%u",
143 from_kuid_munged(&init_user_ns, v9ses->uid));
147 if (v9ses->flags & V9FS_POSIX_ACL)
148 seq_puts(m, ",posixacl");
150 return p9_show_client_options(m, v9ses->clnt);
154 * v9fs_parse_options - parse mount options into session structure
155 * @v9ses: existing v9fs session information
156 * @opts: The mount option string
158 * Return 0 upon success, -ERRNO upon failure.
161 static int v9fs_parse_options(struct v9fs_session_info *v9ses, char *opts)
163 char *options, *tmp_options;
164 substring_t args[MAX_OPT_ARGS];
173 v9ses->cache = CACHE_NONE;
174 #ifdef CONFIG_9P_FSCACHE
175 v9ses->cachetag = NULL;
177 v9ses->session_lock_timeout = P9_LOCK_TIMEOUT;
182 tmp_options = kstrdup(opts, GFP_KERNEL);
185 goto fail_option_alloc;
187 options = tmp_options;
189 while ((p = strsep(&options, ",")) != NULL) {
195 token = match_token(p, tokens, args);
198 r = match_int(&args[0], &option);
200 p9_debug(P9_DEBUG_ERROR,
201 "integer field, but no integer?\n");
204 v9ses->debug = option;
205 #ifdef CONFIG_NET_9P_DEBUG
206 p9_debug_level = option;
212 r = match_int(&args[0], &option);
214 p9_debug(P9_DEBUG_ERROR,
215 "integer field, but no integer?\n");
219 v9ses->dfltuid = make_kuid(current_user_ns(), option);
220 if (!uid_valid(v9ses->dfltuid)) {
221 p9_debug(P9_DEBUG_ERROR,
222 "uid field, but not a uid?\n");
227 r = match_int(&args[0], &option);
229 p9_debug(P9_DEBUG_ERROR,
230 "integer field, but no integer?\n");
234 v9ses->dfltgid = make_kgid(current_user_ns(), option);
235 if (!gid_valid(v9ses->dfltgid)) {
236 p9_debug(P9_DEBUG_ERROR,
237 "gid field, but not a gid?\n");
242 r = match_int(&args[0], &option);
244 p9_debug(P9_DEBUG_ERROR,
245 "integer field, but no integer?\n");
248 v9ses->afid = option;
253 v9ses->uname = match_strdup(&args[0]);
256 goto free_and_return;
261 v9ses->aname = match_strdup(&args[0]);
264 goto free_and_return;
270 case Opt_cache_loose:
271 v9ses->cache = CACHE_LOOSE;
274 v9ses->cache = CACHE_FSCACHE;
277 v9ses->cache = CACHE_MMAP;
280 #ifdef CONFIG_9P_FSCACHE
281 kfree(v9ses->cachetag);
282 v9ses->cachetag = match_strdup(&args[0]);
283 if (!v9ses->cachetag) {
285 goto free_and_return;
290 s = match_strdup(&args[0]);
293 p9_debug(P9_DEBUG_ERROR,
294 "problem allocating copy of cache arg\n");
295 goto free_and_return;
297 r = get_cache_mode(s);
307 s = match_strdup(&args[0]);
310 p9_debug(P9_DEBUG_ERROR,
311 "problem allocating copy of access arg\n");
312 goto free_and_return;
315 v9ses->flags &= ~V9FS_ACCESS_MASK;
316 if (strcmp(s, "user") == 0)
317 v9ses->flags |= V9FS_ACCESS_USER;
318 else if (strcmp(s, "any") == 0)
319 v9ses->flags |= V9FS_ACCESS_ANY;
320 else if (strcmp(s, "client") == 0) {
321 v9ses->flags |= V9FS_ACCESS_CLIENT;
325 v9ses->flags |= V9FS_ACCESS_SINGLE;
326 r = kstrtouint(s, 10, &uid);
329 pr_info("Unknown access argument %s: %d\n",
334 v9ses->uid = make_kuid(current_user_ns(), uid);
335 if (!uid_valid(v9ses->uid)) {
337 pr_info("Unknown uid %s\n", s);
345 #ifdef CONFIG_9P_FS_POSIX_ACL
346 v9ses->flags |= V9FS_POSIX_ACL;
348 p9_debug(P9_DEBUG_ERROR,
349 "Not defined CONFIG_9P_FS_POSIX_ACL. Ignoring posixacl option\n");
353 case Opt_locktimeout:
354 r = match_int(&args[0], &option);
356 p9_debug(P9_DEBUG_ERROR,
357 "integer field, but no integer?\n");
362 p9_debug(P9_DEBUG_ERROR,
363 "locktimeout must be a greater than zero integer.\n");
367 v9ses->session_lock_timeout = (long)option * HZ;
382 * v9fs_session_init - initialize session
383 * @v9ses: session information structure
384 * @dev_name: device being mounted
389 struct p9_fid *v9fs_session_init(struct v9fs_session_info *v9ses,
390 const char *dev_name, char *data)
395 v9ses->uname = kstrdup(V9FS_DEFUSER, GFP_KERNEL);
399 v9ses->aname = kstrdup(V9FS_DEFANAME, GFP_KERNEL);
402 init_rwsem(&v9ses->rename_sem);
404 v9ses->uid = INVALID_UID;
405 v9ses->dfltuid = V9FS_DEFUID;
406 v9ses->dfltgid = V9FS_DEFGID;
408 v9ses->clnt = p9_client_create(dev_name, data);
409 if (IS_ERR(v9ses->clnt)) {
410 rc = PTR_ERR(v9ses->clnt);
411 p9_debug(P9_DEBUG_ERROR, "problem initializing 9p client\n");
415 v9ses->flags = V9FS_ACCESS_USER;
417 if (p9_is_proto_dotl(v9ses->clnt)) {
418 v9ses->flags = V9FS_ACCESS_CLIENT;
419 v9ses->flags |= V9FS_PROTO_2000L;
420 } else if (p9_is_proto_dotu(v9ses->clnt)) {
421 v9ses->flags |= V9FS_PROTO_2000U;
424 rc = v9fs_parse_options(v9ses, data);
428 v9ses->maxdata = v9ses->clnt->msize - P9_IOHDRSZ;
430 if (!v9fs_proto_dotl(v9ses) &&
431 ((v9ses->flags & V9FS_ACCESS_MASK) == V9FS_ACCESS_CLIENT)) {
433 * We support ACCESS_CLIENT only for dotl.
434 * Fall back to ACCESS_USER
436 v9ses->flags &= ~V9FS_ACCESS_MASK;
437 v9ses->flags |= V9FS_ACCESS_USER;
440 /* for legacy mode, fall back to V9FS_ACCESS_ANY */
441 if (!(v9fs_proto_dotu(v9ses) || v9fs_proto_dotl(v9ses)) &&
442 ((v9ses->flags&V9FS_ACCESS_MASK) == V9FS_ACCESS_USER)) {
444 v9ses->flags &= ~V9FS_ACCESS_MASK;
445 v9ses->flags |= V9FS_ACCESS_ANY;
446 v9ses->uid = INVALID_UID;
448 if (!v9fs_proto_dotl(v9ses) ||
449 !((v9ses->flags & V9FS_ACCESS_MASK) == V9FS_ACCESS_CLIENT)) {
451 * We support ACL checks on clinet only if the protocol is
452 * 9P2000.L and access is V9FS_ACCESS_CLIENT.
454 v9ses->flags &= ~V9FS_ACL_MASK;
457 fid = p9_client_attach(v9ses->clnt, NULL, v9ses->uname, INVALID_UID,
461 p9_debug(P9_DEBUG_ERROR, "cannot attach\n");
465 if ((v9ses->flags & V9FS_ACCESS_MASK) == V9FS_ACCESS_SINGLE)
466 fid->uid = v9ses->uid;
468 fid->uid = INVALID_UID;
470 #ifdef CONFIG_9P_FSCACHE
471 /* register the session for caching */
472 if (v9ses->cache == CACHE_LOOSE || v9ses->cache == CACHE_FSCACHE) {
473 rc = v9fs_cache_session_get_cookie(v9ses, dev_name);
478 spin_lock(&v9fs_sessionlist_lock);
479 list_add(&v9ses->slist, &v9fs_sessionlist);
480 spin_unlock(&v9fs_sessionlist_lock);
485 #ifdef CONFIG_9P_FSCACHE
486 kfree(v9ses->cachetag);
488 p9_client_destroy(v9ses->clnt);
496 * v9fs_session_close - shutdown a session
497 * @v9ses: session information structure
501 void v9fs_session_close(struct v9fs_session_info *v9ses)
504 p9_client_destroy(v9ses->clnt);
508 #ifdef CONFIG_9P_FSCACHE
509 fscache_relinquish_volume(v9fs_session_cache(v9ses), NULL, false);
510 kfree(v9ses->cachetag);
515 spin_lock(&v9fs_sessionlist_lock);
516 list_del(&v9ses->slist);
517 spin_unlock(&v9fs_sessionlist_lock);
521 * v9fs_session_cancel - terminate a session
522 * @v9ses: session to terminate
524 * mark transport as disconnected and cancel all pending requests.
527 void v9fs_session_cancel(struct v9fs_session_info *v9ses)
529 p9_debug(P9_DEBUG_ERROR, "cancel session %p\n", v9ses);
530 p9_client_disconnect(v9ses->clnt);
534 * v9fs_session_begin_cancel - Begin terminate of a session
535 * @v9ses: session to terminate
537 * After this call we don't allow any request other than clunk.
540 void v9fs_session_begin_cancel(struct v9fs_session_info *v9ses)
542 p9_debug(P9_DEBUG_ERROR, "begin cancel session %p\n", v9ses);
543 p9_client_begin_disconnect(v9ses->clnt);
546 extern int v9fs_error_init(void);
548 static struct kobject *v9fs_kobj;
550 #ifdef CONFIG_9P_FSCACHE
552 * List caches associated with a session
554 static ssize_t caches_show(struct kobject *kobj,
555 struct kobj_attribute *attr,
558 ssize_t n = 0, count = 0, limit = PAGE_SIZE;
559 struct v9fs_session_info *v9ses;
561 spin_lock(&v9fs_sessionlist_lock);
562 list_for_each_entry(v9ses, &v9fs_sessionlist, slist) {
563 if (v9ses->cachetag) {
564 n = snprintf(buf, limit, "%s\n", v9ses->cachetag);
575 spin_unlock(&v9fs_sessionlist_lock);
579 static struct kobj_attribute v9fs_attr_cache = __ATTR_RO(caches);
580 #endif /* CONFIG_9P_FSCACHE */
582 static struct attribute *v9fs_attrs[] = {
583 #ifdef CONFIG_9P_FSCACHE
584 &v9fs_attr_cache.attr,
589 static const struct attribute_group v9fs_attr_group = {
594 * v9fs_sysfs_init - Initialize the v9fs sysfs interface
598 static int __init v9fs_sysfs_init(void)
600 v9fs_kobj = kobject_create_and_add("9p", fs_kobj);
604 if (sysfs_create_group(v9fs_kobj, &v9fs_attr_group)) {
605 kobject_put(v9fs_kobj);
613 * v9fs_sysfs_cleanup - Unregister the v9fs sysfs interface
617 static void v9fs_sysfs_cleanup(void)
619 sysfs_remove_group(v9fs_kobj, &v9fs_attr_group);
620 kobject_put(v9fs_kobj);
623 static void v9fs_inode_init_once(void *foo)
625 struct v9fs_inode *v9inode = (struct v9fs_inode *)foo;
627 memset(&v9inode->qid, 0, sizeof(v9inode->qid));
628 inode_init_once(&v9inode->netfs.inode);
632 * v9fs_init_inode_cache - initialize a cache for 9P
633 * Returns 0 on success.
635 static int v9fs_init_inode_cache(void)
637 v9fs_inode_cache = kmem_cache_create("v9fs_inode_cache",
638 sizeof(struct v9fs_inode),
639 0, (SLAB_RECLAIM_ACCOUNT|
640 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
641 v9fs_inode_init_once);
642 if (!v9fs_inode_cache)
649 * v9fs_destroy_inode_cache - destroy the cache of 9P inode
652 static void v9fs_destroy_inode_cache(void)
655 * Make sure all delayed rcu free inodes are flushed before we
659 kmem_cache_destroy(v9fs_inode_cache);
662 static int v9fs_cache_register(void)
666 ret = v9fs_init_inode_cache();
672 static void v9fs_cache_unregister(void)
674 v9fs_destroy_inode_cache();
678 * init_v9fs - Initialize module
682 static int __init init_v9fs(void)
686 pr_info("Installing v9fs 9p2000 file system support\n");
687 /* TODO: Setup list of registered trasnport modules */
689 err = v9fs_cache_register();
691 pr_err("Failed to register v9fs for caching\n");
695 err = v9fs_sysfs_init();
697 pr_err("Failed to register with sysfs\n");
700 err = register_filesystem(&v9fs_fs_type);
702 pr_err("Failed to register filesystem\n");
703 goto out_sysfs_cleanup;
709 v9fs_sysfs_cleanup();
712 v9fs_cache_unregister();
718 * exit_v9fs - shutdown module
722 static void __exit exit_v9fs(void)
724 v9fs_sysfs_cleanup();
725 v9fs_cache_unregister();
726 unregister_filesystem(&v9fs_fs_type);
729 module_init(init_v9fs)
730 module_exit(exit_v9fs)
732 MODULE_AUTHOR("Latchesar Ionkov <lucho@ionkov.net>");
733 MODULE_AUTHOR("Eric Van Hensbergen <ericvh@gmail.com>");
734 MODULE_AUTHOR("Ron Minnich <rminnich@lanl.gov>");
735 MODULE_LICENSE("GPL");