fs/9p/v9fs.c

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