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/slab.h>
18 #include <linux/seq_file.h>
19 #include <net/9p/9p.h>
20 #include <net/9p/client.h>
21 #include <net/9p/transport.h>
26 static DEFINE_SPINLOCK(v9fs_sessionlist_lock);
27 static LIST_HEAD(v9fs_sessionlist);
28 struct kmem_cache *v9fs_inode_cache;
31 * Option Parsing (code inspired by NFS code)
32 * NOTE: each transport will parse its own options
36 /* Options that take integer arguments */
37 Opt_debug, Opt_dfltuid, Opt_dfltgid, Opt_afid,
39 Opt_uname, Opt_remotename, Opt_cache, Opt_cachetag,
40 /* Options that take no arguments */
41 Opt_nodevmap, Opt_noxattr, Opt_directio, Opt_ignoreqv,
43 Opt_access, Opt_posixacl,
44 /* Lock timeout option */
50 static const match_table_t tokens = {
51 {Opt_debug, "debug=%x"},
52 {Opt_dfltuid, "dfltuid=%u"},
53 {Opt_dfltgid, "dfltgid=%u"},
54 {Opt_afid, "afid=%u"},
55 {Opt_uname, "uname=%s"},
56 {Opt_remotename, "aname=%s"},
57 {Opt_nodevmap, "nodevmap"},
58 {Opt_noxattr, "noxattr"},
59 {Opt_directio, "directio"},
60 {Opt_ignoreqv, "ignoreqv"},
61 {Opt_cache, "cache=%s"},
62 {Opt_cachetag, "cachetag=%s"},
63 {Opt_access, "access=%s"},
64 {Opt_posixacl, "posixacl"},
65 {Opt_locktimeout, "locktimeout=%u"},
69 static const char *const v9fs_cache_modes[nr__p9_cache_modes] = {
70 [CACHE_NONE] = "none",
71 [CACHE_READAHEAD] = "readahead",
72 [CACHE_WRITEBACK] = "writeback",
73 [CACHE_MMAP] = "mmap",
74 [CACHE_LOOSE] = "loose",
75 [CACHE_FSCACHE] = "fscache",
78 /* Interpret mount options for cache mode */
79 static int get_cache_mode(char *s)
81 int version = -EINVAL;
83 if (!strcmp(s, "loose")) {
84 version = CACHE_LOOSE;
85 p9_debug(P9_DEBUG_9P, "Cache mode: loose\n");
86 } else if (!strcmp(s, "fscache")) {
87 version = CACHE_FSCACHE;
88 p9_debug(P9_DEBUG_9P, "Cache mode: fscache\n");
89 } else if (!strcmp(s, "mmap")) {
91 p9_debug(P9_DEBUG_9P, "Cache mode: mmap\n");
92 } else if (!strcmp(s, "writeback")) {
93 version = CACHE_WRITEBACK;
94 p9_debug(P9_DEBUG_9P, "Cache mode: writeback\n");
95 } else if (!strcmp(s, "readahead")) {
96 version = CACHE_READAHEAD;
97 p9_debug(P9_DEBUG_9P, "Cache mode: readahead\n");
98 } else if (!strcmp(s, "none")) {
100 p9_debug(P9_DEBUG_9P, "Cache mode: none\n");
102 pr_info("Unknown Cache mode %s\n", s);
107 * Display the mount options in /proc/mounts.
109 int v9fs_show_options(struct seq_file *m, struct dentry *root)
111 struct v9fs_session_info *v9ses = root->d_sb->s_fs_info;
114 seq_printf(m, ",debug=%x", v9ses->debug);
115 if (!uid_eq(v9ses->dfltuid, V9FS_DEFUID))
116 seq_printf(m, ",dfltuid=%u",
117 from_kuid_munged(&init_user_ns, v9ses->dfltuid));
118 if (!gid_eq(v9ses->dfltgid, V9FS_DEFGID))
119 seq_printf(m, ",dfltgid=%u",
120 from_kgid_munged(&init_user_ns, v9ses->dfltgid));
121 if (v9ses->afid != ~0)
122 seq_printf(m, ",afid=%u", v9ses->afid);
123 if (strcmp(v9ses->uname, V9FS_DEFUSER) != 0)
124 seq_printf(m, ",uname=%s", v9ses->uname);
125 if (strcmp(v9ses->aname, V9FS_DEFANAME) != 0)
126 seq_printf(m, ",aname=%s", v9ses->aname);
128 seq_puts(m, ",nodevmap");
130 seq_printf(m, ",cache=%s", v9fs_cache_modes[v9ses->cache]);
131 #ifdef CONFIG_9P_FSCACHE
132 if (v9ses->cachetag && v9ses->cache == CACHE_FSCACHE)
133 seq_printf(m, ",cachetag=%s", v9ses->cachetag);
136 switch (v9ses->flags & V9FS_ACCESS_MASK) {
137 case V9FS_ACCESS_USER:
138 seq_puts(m, ",access=user");
140 case V9FS_ACCESS_ANY:
141 seq_puts(m, ",access=any");
143 case V9FS_ACCESS_CLIENT:
144 seq_puts(m, ",access=client");
146 case V9FS_ACCESS_SINGLE:
147 seq_printf(m, ",access=%u",
148 from_kuid_munged(&init_user_ns, v9ses->uid));
152 if (v9ses->flags & V9FS_IGNORE_QV)
153 seq_puts(m, ",ignoreqv");
154 if (v9ses->flags & V9FS_DIRECT_IO)
155 seq_puts(m, ",directio");
156 if (v9ses->flags & V9FS_POSIX_ACL)
157 seq_puts(m, ",posixacl");
159 if (v9ses->flags & V9FS_NO_XATTR)
160 seq_puts(m, ",noxattr");
162 return p9_show_client_options(m, v9ses->clnt);
166 * v9fs_parse_options - parse mount options into session structure
167 * @v9ses: existing v9fs session information
168 * @opts: The mount option string
170 * Return 0 upon success, -ERRNO upon failure.
173 static int v9fs_parse_options(struct v9fs_session_info *v9ses, char *opts)
175 char *options, *tmp_options;
176 substring_t args[MAX_OPT_ARGS];
185 v9ses->cache = CACHE_NONE;
186 #ifdef CONFIG_9P_FSCACHE
187 v9ses->cachetag = NULL;
189 v9ses->session_lock_timeout = P9_LOCK_TIMEOUT;
194 tmp_options = kstrdup(opts, GFP_KERNEL);
197 goto fail_option_alloc;
199 options = tmp_options;
201 while ((p = strsep(&options, ",")) != NULL) {
207 token = match_token(p, tokens, args);
210 r = match_int(&args[0], &option);
212 p9_debug(P9_DEBUG_ERROR,
213 "integer field, but no integer?\n");
216 v9ses->debug = option;
217 #ifdef CONFIG_NET_9P_DEBUG
218 p9_debug_level = option;
224 r = match_int(&args[0], &option);
226 p9_debug(P9_DEBUG_ERROR,
227 "integer field, but no integer?\n");
231 v9ses->dfltuid = make_kuid(current_user_ns(), option);
232 if (!uid_valid(v9ses->dfltuid)) {
233 p9_debug(P9_DEBUG_ERROR,
234 "uid field, but not a uid?\n");
239 r = match_int(&args[0], &option);
241 p9_debug(P9_DEBUG_ERROR,
242 "integer field, but no integer?\n");
246 v9ses->dfltgid = make_kgid(current_user_ns(), option);
247 if (!gid_valid(v9ses->dfltgid)) {
248 p9_debug(P9_DEBUG_ERROR,
249 "gid field, but not a gid?\n");
254 r = match_int(&args[0], &option);
256 p9_debug(P9_DEBUG_ERROR,
257 "integer field, but no integer?\n");
260 v9ses->afid = option;
265 v9ses->uname = match_strdup(&args[0]);
268 goto free_and_return;
273 v9ses->aname = match_strdup(&args[0]);
276 goto free_and_return;
283 v9ses->flags |= V9FS_NO_XATTR;
286 v9ses->flags |= V9FS_DIRECT_IO;
289 v9ses->flags |= V9FS_IGNORE_QV;
292 #ifdef CONFIG_9P_FSCACHE
293 kfree(v9ses->cachetag);
294 v9ses->cachetag = match_strdup(&args[0]);
295 if (!v9ses->cachetag) {
297 goto free_and_return;
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 r = get_cache_mode(s);
319 s = match_strdup(&args[0]);
322 p9_debug(P9_DEBUG_ERROR,
323 "problem allocating copy of access arg\n");
324 goto free_and_return;
327 v9ses->flags &= ~V9FS_ACCESS_MASK;
328 if (strcmp(s, "user") == 0)
329 v9ses->flags |= V9FS_ACCESS_USER;
330 else if (strcmp(s, "any") == 0)
331 v9ses->flags |= V9FS_ACCESS_ANY;
332 else if (strcmp(s, "client") == 0) {
333 v9ses->flags |= V9FS_ACCESS_CLIENT;
337 v9ses->flags |= V9FS_ACCESS_SINGLE;
338 r = kstrtouint(s, 10, &uid);
341 pr_info("Unknown access argument %s: %d\n",
346 v9ses->uid = make_kuid(current_user_ns(), uid);
347 if (!uid_valid(v9ses->uid)) {
349 pr_info("Unknown uid %s\n", s);
357 #ifdef CONFIG_9P_FS_POSIX_ACL
358 v9ses->flags |= V9FS_POSIX_ACL;
360 p9_debug(P9_DEBUG_ERROR,
361 "Not defined CONFIG_9P_FS_POSIX_ACL. Ignoring posixacl option\n");
365 case Opt_locktimeout:
366 r = match_int(&args[0], &option);
368 p9_debug(P9_DEBUG_ERROR,
369 "integer field, but no integer?\n");
374 p9_debug(P9_DEBUG_ERROR,
375 "locktimeout must be a greater than zero integer.\n");
379 v9ses->session_lock_timeout = (long)option * HZ;
394 * v9fs_session_init - initialize session
395 * @v9ses: session information structure
396 * @dev_name: device being mounted
401 struct p9_fid *v9fs_session_init(struct v9fs_session_info *v9ses,
402 const char *dev_name, char *data)
407 v9ses->uname = kstrdup(V9FS_DEFUSER, GFP_KERNEL);
411 v9ses->aname = kstrdup(V9FS_DEFANAME, GFP_KERNEL);
414 init_rwsem(&v9ses->rename_sem);
416 v9ses->uid = INVALID_UID;
417 v9ses->dfltuid = V9FS_DEFUID;
418 v9ses->dfltgid = V9FS_DEFGID;
420 v9ses->clnt = p9_client_create(dev_name, data);
421 if (IS_ERR(v9ses->clnt)) {
422 rc = PTR_ERR(v9ses->clnt);
423 p9_debug(P9_DEBUG_ERROR, "problem initializing 9p client\n");
427 v9ses->flags = V9FS_ACCESS_USER;
429 if (p9_is_proto_dotl(v9ses->clnt)) {
430 v9ses->flags = V9FS_ACCESS_CLIENT;
431 v9ses->flags |= V9FS_PROTO_2000L;
432 } else if (p9_is_proto_dotu(v9ses->clnt)) {
433 v9ses->flags |= V9FS_PROTO_2000U;
436 rc = v9fs_parse_options(v9ses, data);
440 v9ses->maxdata = v9ses->clnt->msize - P9_IOHDRSZ;
442 if (!v9fs_proto_dotl(v9ses) &&
443 ((v9ses->flags & V9FS_ACCESS_MASK) == V9FS_ACCESS_CLIENT)) {
445 * We support ACCESS_CLIENT only for dotl.
446 * Fall back to ACCESS_USER
448 v9ses->flags &= ~V9FS_ACCESS_MASK;
449 v9ses->flags |= V9FS_ACCESS_USER;
452 /* for legacy mode, fall back to V9FS_ACCESS_ANY */
453 if (!(v9fs_proto_dotu(v9ses) || v9fs_proto_dotl(v9ses)) &&
454 ((v9ses->flags&V9FS_ACCESS_MASK) == V9FS_ACCESS_USER)) {
456 v9ses->flags &= ~V9FS_ACCESS_MASK;
457 v9ses->flags |= V9FS_ACCESS_ANY;
458 v9ses->uid = INVALID_UID;
460 if (!v9fs_proto_dotl(v9ses) ||
461 !((v9ses->flags & V9FS_ACCESS_MASK) == V9FS_ACCESS_CLIENT)) {
463 * We support ACL checks on clinet only if the protocol is
464 * 9P2000.L and access is V9FS_ACCESS_CLIENT.
466 v9ses->flags &= ~V9FS_ACL_MASK;
469 fid = p9_client_attach(v9ses->clnt, NULL, v9ses->uname, INVALID_UID,
473 p9_debug(P9_DEBUG_ERROR, "cannot attach\n");
477 if ((v9ses->flags & V9FS_ACCESS_MASK) == V9FS_ACCESS_SINGLE)
478 fid->uid = v9ses->uid;
480 fid->uid = INVALID_UID;
482 #ifdef CONFIG_9P_FSCACHE
483 /* register the session for caching */
484 if (v9ses->cache == CACHE_FSCACHE) {
485 rc = v9fs_cache_session_get_cookie(v9ses, dev_name);
490 spin_lock(&v9fs_sessionlist_lock);
491 list_add(&v9ses->slist, &v9fs_sessionlist);
492 spin_unlock(&v9fs_sessionlist_lock);
497 #ifdef CONFIG_9P_FSCACHE
498 kfree(v9ses->cachetag);
500 p9_client_destroy(v9ses->clnt);
508 * v9fs_session_close - shutdown a session
509 * @v9ses: session information structure
513 void v9fs_session_close(struct v9fs_session_info *v9ses)
516 p9_client_destroy(v9ses->clnt);
520 #ifdef CONFIG_9P_FSCACHE
521 fscache_relinquish_volume(v9fs_session_cache(v9ses), NULL, false);
522 kfree(v9ses->cachetag);
527 spin_lock(&v9fs_sessionlist_lock);
528 list_del(&v9ses->slist);
529 spin_unlock(&v9fs_sessionlist_lock);
533 * v9fs_session_cancel - terminate a session
534 * @v9ses: session to terminate
536 * mark transport as disconnected and cancel all pending requests.
539 void v9fs_session_cancel(struct v9fs_session_info *v9ses)
541 p9_debug(P9_DEBUG_ERROR, "cancel session %p\n", v9ses);
542 p9_client_disconnect(v9ses->clnt);
546 * v9fs_session_begin_cancel - Begin terminate of a session
547 * @v9ses: session to terminate
549 * After this call we don't allow any request other than clunk.
552 void v9fs_session_begin_cancel(struct v9fs_session_info *v9ses)
554 p9_debug(P9_DEBUG_ERROR, "begin cancel session %p\n", v9ses);
555 p9_client_begin_disconnect(v9ses->clnt);
558 extern int v9fs_error_init(void);
560 static struct kobject *v9fs_kobj;
562 #ifdef CONFIG_9P_FSCACHE
564 * List caches associated with a session
566 static ssize_t caches_show(struct kobject *kobj,
567 struct kobj_attribute *attr,
570 ssize_t n = 0, count = 0, limit = PAGE_SIZE;
571 struct v9fs_session_info *v9ses;
573 spin_lock(&v9fs_sessionlist_lock);
574 list_for_each_entry(v9ses, &v9fs_sessionlist, slist) {
575 if (v9ses->cachetag) {
576 n = snprintf(buf, limit, "%s\n", v9ses->cachetag);
587 spin_unlock(&v9fs_sessionlist_lock);
591 static struct kobj_attribute v9fs_attr_cache = __ATTR_RO(caches);
592 #endif /* CONFIG_9P_FSCACHE */
594 static struct attribute *v9fs_attrs[] = {
595 #ifdef CONFIG_9P_FSCACHE
596 &v9fs_attr_cache.attr,
601 static const struct attribute_group v9fs_attr_group = {
606 * v9fs_sysfs_init - Initialize the v9fs sysfs interface
610 static int __init v9fs_sysfs_init(void)
612 v9fs_kobj = kobject_create_and_add("9p", fs_kobj);
616 if (sysfs_create_group(v9fs_kobj, &v9fs_attr_group)) {
617 kobject_put(v9fs_kobj);
625 * v9fs_sysfs_cleanup - Unregister the v9fs sysfs interface
629 static void v9fs_sysfs_cleanup(void)
631 sysfs_remove_group(v9fs_kobj, &v9fs_attr_group);
632 kobject_put(v9fs_kobj);
635 static void v9fs_inode_init_once(void *foo)
637 struct v9fs_inode *v9inode = (struct v9fs_inode *)foo;
639 memset(&v9inode->qid, 0, sizeof(v9inode->qid));
640 inode_init_once(&v9inode->netfs.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)
678 ret = v9fs_init_inode_cache();
684 static void v9fs_cache_unregister(void)
686 v9fs_destroy_inode_cache();
690 * init_v9fs - Initialize module
694 static int __init init_v9fs(void)
698 pr_info("Installing v9fs 9p2000 file system support\n");
699 /* TODO: Setup list of registered trasnport modules */
701 err = v9fs_cache_register();
703 pr_err("Failed to register v9fs for caching\n");
707 err = v9fs_sysfs_init();
709 pr_err("Failed to register with sysfs\n");
712 err = register_filesystem(&v9fs_fs_type);
714 pr_err("Failed to register filesystem\n");
715 goto out_sysfs_cleanup;
721 v9fs_sysfs_cleanup();
724 v9fs_cache_unregister();
730 * exit_v9fs - shutdown module
734 static void __exit exit_v9fs(void)
736 v9fs_sysfs_cleanup();
737 v9fs_cache_unregister();
738 unregister_filesystem(&v9fs_fs_type);
741 module_init(init_v9fs)
742 module_exit(exit_v9fs)
744 MODULE_AUTHOR("Latchesar Ionkov <lucho@ionkov.net>");
745 MODULE_AUTHOR("Eric Van Hensbergen <ericvh@gmail.com>");
746 MODULE_AUTHOR("Ron Minnich <rminnich@lanl.gov>");
747 MODULE_LICENSE("GPL");