net/9p/trans_virtio.c

   1 /*
   2  * The Virtio 9p transport driver
   3  *
   4  * This is a block based transport driver based on the lguest block driver
   5  * code.
   6  *
   7  *  Copyright (C) 2007, 2008 Eric Van Hensbergen, IBM Corporation
   8  *
   9  *  Based on virtio console driver
  10  *  Copyright (C) 2006, 2007 Rusty Russell, IBM Corporation
  11  *
  12  *  This program is free software; you can redistribute it and/or modify
  13  *  it under the terms of the GNU General Public License version 2
  14  *  as published by the Free Software Foundation.
  15  *
  16  *  This program is distributed in the hope that it will be useful,
  17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  *  GNU General Public License for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License
  22  *  along with this program; if not, write to:
  23  *  Free Software Foundation
  24  *  51 Franklin Street, Fifth Floor
  25  *  Boston, MA  02111-1301  USA
  26  *
  27  */
  28
  29 #include <linux/in.h>
  30 #include <linux/module.h>
  31 #include <linux/net.h>
  32 #include <linux/ipv6.h>
  33 #include <linux/errno.h>
  34 #include <linux/kernel.h>
  35 #include <linux/un.h>
  36 #include <linux/uaccess.h>
  37 #include <linux/inet.h>
  38 #include <linux/idr.h>
  39 #include <linux/file.h>
  40 #include <linux/slab.h>
  41 #include <net/9p/9p.h>
  42 #include <linux/parser.h>
  43 #include <net/9p/client.h>
  44 #include <net/9p/transport.h>
  45 #include <linux/scatterlist.h>
  46 #include <linux/virtio.h>
  47 #include <linux/virtio_9p.h>
  48 #include "trans_common.h"
  49
  50 #define VIRTQUEUE_NUM   128
  51
  52 /* a single mutex to manage channel initialization and attachment */
  53 static DEFINE_MUTEX(virtio_9p_lock);
  54
  55 /**
  56  * struct virtio_chan - per-instance transport information
  57  * @initialized: whether the channel is initialized
  58  * @inuse: whether the channel is in use
  59  * @lock: protects multiple elements within this structure
  60  * @client: client instance
  61  * @vdev: virtio dev associated with this channel
  62  * @vq: virtio queue associated with this channel
  63  * @sg: scatter gather list which is used to pack a request (protected?)
  64  *
  65  * We keep all per-channel information in a structure.
  66  * This structure is allocated within the devices dev->mem space.
  67  * A pointer to the structure will get put in the transport private.
  68  *
  69  */
  70
  71 struct virtio_chan {
  72         bool inuse;
  73
  74         spinlock_t lock;
  75
  76         struct p9_client *client;
  77         struct virtio_device *vdev;
  78         struct virtqueue *vq;
  79         int ring_bufs_avail;
  80         wait_queue_head_t *vc_wq;
  81
  82         /* Scatterlist: can be too big for stack. */
  83         struct scatterlist sg[VIRTQUEUE_NUM];
  84
  85         int tag_len;
  86         /*
  87          * tag name to identify a mount Non-null terminated
  88          */
  89         char *tag;
  90
  91         struct list_head chan_list;
  92 };
  93
  94 static struct list_head virtio_chan_list;
  95
  96 /* How many bytes left in this page. */
  97 static unsigned int rest_of_page(void *data)
  98 {
  99         return PAGE_SIZE - ((unsigned long)data % PAGE_SIZE);
 100 }
 101
 102 /**
 103  * p9_virtio_close - reclaim resources of a channel
 104  * @client: client instance
 105  *
 106  * This reclaims a channel by freeing its resources and
 107  * reseting its inuse flag.
 108  *
 109  */
 110
 111 static void p9_virtio_close(struct p9_client *client)
 112 {
 113         struct virtio_chan *chan = client->trans;
 114
 115         mutex_lock(&virtio_9p_lock);
 116         if (chan)
 117                 chan->inuse = false;
 118         mutex_unlock(&virtio_9p_lock);
 119 }
 120
 121 /**
 122  * req_done - callback which signals activity from the server
 123  * @vq: virtio queue activity was received on
 124  *
 125  * This notifies us that the server has triggered some activity
 126  * on the virtio channel - most likely a response to request we
 127  * sent.  Figure out which requests now have responses and wake up
 128  * those threads.
 129  *
 130  * Bugs: could do with some additional sanity checking, but appears to work.
 131  *
 132  */
 133
 134 static void req_done(struct virtqueue *vq)
 135 {
 136         struct virtio_chan *chan = vq->vdev->priv;
 137         struct p9_fcall *rc;
 138         unsigned int len;
 139         struct p9_req_t *req;
 140         unsigned long flags;
 141
 142         P9_DPRINTK(P9_DEBUG_TRANS, ": request done\n");
 143
 144         do {
 145                 spin_lock_irqsave(&chan->lock, flags);
 146                 rc = virtqueue_get_buf(chan->vq, &len);
 147
 148                 if (rc != NULL) {
 149                         if (!chan->ring_bufs_avail) {
 150                                 chan->ring_bufs_avail = 1;
 151                                 wake_up(chan->vc_wq);
 152                         }
 153                         spin_unlock_irqrestore(&chan->lock, flags);
 154                         P9_DPRINTK(P9_DEBUG_TRANS, ": rc %p\n", rc);
 155                         P9_DPRINTK(P9_DEBUG_TRANS, ": lookup tag %d\n",
 156                                         rc->tag);
 157                         req = p9_tag_lookup(chan->client, rc->tag);
 158                         req->status = REQ_STATUS_RCVD;
 159                         if (req->tc->private) {
 160                                 struct trans_rpage_info *rp = req->tc->private;
 161                                 /*Release pages */
 162                                 p9_release_req_pages(rp);
 163                                 if (rp->rp_alloc)
 164                                         kfree(rp);
 165                                 req->tc->private = NULL;
 166                         }
 167                         p9_client_cb(chan->client, req);
 168                 } else {
 169                         spin_unlock_irqrestore(&chan->lock, flags);
 170                 }
 171         } while (rc != NULL);
 172 }
 173
 174 /**
 175  * pack_sg_list - pack a scatter gather list from a linear buffer
 176  * @sg: scatter/gather list to pack into
 177  * @start: which segment of the sg_list to start at
 178  * @limit: maximum segment to pack data to
 179  * @data: data to pack into scatter/gather list
 180  * @count: amount of data to pack into the scatter/gather list
 181  *
 182  * sg_lists have multiple segments of various sizes.  This will pack
 183  * arbitrary data into an existing scatter gather list, segmenting the
 184  * data as necessary within constraints.
 185  *
 186  */
 187
 188 static int
 189 pack_sg_list(struct scatterlist *sg, int start, int limit, char *data,
 190                                                                 int count)
 191 {
 192         int s;
 193         int index = start;
 194
 195         while (count) {
 196                 s = rest_of_page(data);
 197                 if (s > count)
 198                         s = count;
 199                 sg_set_buf(&sg[index++], data, s);
 200                 count -= s;
 201                 data += s;
 202                 BUG_ON(index > limit);
 203         }
 204
 205         return index-start;
 206 }
 207
 208 /* We don't currently allow canceling of virtio requests */
 209 static int p9_virtio_cancel(struct p9_client *client, struct p9_req_t *req)
 210 {
 211         return 1;
 212 }
 213
 214 /**
 215  * pack_sg_list_p - Just like pack_sg_list. Instead of taking a buffer,
 216  * this takes a list of pages.
 217  * @sg: scatter/gather list to pack into
 218  * @start: which segment of the sg_list to start at
 219  * @pdata_off: Offset into the first page
 220  * @**pdata: a list of pages to add into sg.
 221  * @count: amount of data to pack into the scatter/gather list
 222  */
 223 static int
 224 pack_sg_list_p(struct scatterlist *sg, int start, int limit, size_t pdata_off,
 225                 struct page **pdata, int count)
 226 {
 227         int s;
 228         int i = 0;
 229         int index = start;
 230
 231         if (pdata_off) {
 232                 s = min((int)(PAGE_SIZE - pdata_off), count);
 233                 sg_set_page(&sg[index++], pdata[i++], s, pdata_off);
 234                 count -= s;
 235         }
 236
 237         while (count) {
 238                 BUG_ON(index > limit);
 239                 s = min((int)PAGE_SIZE, count);
 240                 sg_set_page(&sg[index++], pdata[i++], s, 0);
 241                 count -= s;
 242         }
 243         return index-start;
 244 }
 245
 246 /**
 247  * p9_virtio_request - issue a request
 248  * @client: client instance issuing the request
 249  * @req: request to be issued
 250  *
 251  */
 252
 253 static int
 254 p9_virtio_request(struct p9_client *client, struct p9_req_t *req)
 255 {
 256         int in, out, inp, outp;
 257         struct virtio_chan *chan = client->trans;
 258         char *rdata = (char *)req->rc+sizeof(struct p9_fcall);
 259         unsigned long flags;
 260         size_t pdata_off = 0;
 261         struct trans_rpage_info *rpinfo = NULL;
 262         int err, pdata_len = 0;
 263
 264         P9_DPRINTK(P9_DEBUG_TRANS, "9p debug: virtio request\n");
 265
 266 req_retry:
 267         req->status = REQ_STATUS_SENT;
 268
 269         if (req->tc->pbuf_size && (req->tc->pubuf && P9_IS_USER_CONTEXT)) {
 270                 int nr_pages = p9_nr_pages(req);
 271                 int rpinfo_size = sizeof(struct trans_rpage_info) +
 272                         sizeof(struct page *) * nr_pages;
 273
 274                 if (rpinfo_size <= (req->tc->capacity - req->tc->size)) {
 275                         /* We can use sdata */
 276                         req->tc->private = req->tc->sdata + req->tc->size;
 277                         rpinfo = (struct trans_rpage_info *)req->tc->private;
 278                         rpinfo->rp_alloc = 0;
 279                 } else {
 280                         req->tc->private = kmalloc(rpinfo_size, GFP_NOFS);
 281                         if (!req->tc->private) {
 282                                 P9_DPRINTK(P9_DEBUG_TRANS, "9p debug: "
 283                                         "private kmalloc returned NULL");
 284                                 return -ENOMEM;
 285                         }
 286                         rpinfo = (struct trans_rpage_info *)req->tc->private;
 287                         rpinfo->rp_alloc = 1;
 288                 }
 289
 290                 err = p9_payload_gup(req, &pdata_off, &pdata_len, nr_pages,
 291                                 req->tc->id == P9_TREAD ? 1 : 0);
 292                 if (err < 0) {
 293                         if (rpinfo->rp_alloc)
 294                                 kfree(rpinfo);
 295                         return err;
 296                 }
 297         }
 298
 299         spin_lock_irqsave(&chan->lock, flags);
 300
 301         /* Handle out VirtIO ring buffers */
 302         out = pack_sg_list(chan->sg, 0, VIRTQUEUE_NUM, req->tc->sdata,
 303                         req->tc->size);
 304
 305         if (req->tc->pbuf_size && (req->tc->id == P9_TWRITE)) {
 306                 /* We have additional write payload buffer to take care */
 307                 if (req->tc->pubuf && P9_IS_USER_CONTEXT) {
 308                         outp = pack_sg_list_p(chan->sg, out, VIRTQUEUE_NUM,
 309                                         pdata_off, rpinfo->rp_data, pdata_len);
 310                 } else {
 311                         char *pbuf = req->tc->pubuf ? req->tc->pubuf :
 312                                                                 req->tc->pkbuf;
 313                         outp = pack_sg_list(chan->sg, out, VIRTQUEUE_NUM, pbuf,
 314                                         req->tc->pbuf_size);
 315                 }
 316                 out += outp;
 317         }
 318
 319         /* Handle in VirtIO ring buffers */
 320         if (req->tc->pbuf_size &&
 321                 ((req->tc->id == P9_TREAD) || (req->tc->id == P9_TREADDIR))) {
 322                 /*
 323                  * Take care of additional Read payload.
 324                  * 11 is the read/write header = PDU Header(7) + IO Size (4).
 325                  * Arrange in such a way that server places header in the
 326                  * alloced memory and payload onto the user buffer.
 327                  */
 328                 inp = pack_sg_list(chan->sg, out, VIRTQUEUE_NUM, rdata, 11);
 329                 /*
 330                  * Running executables in the filesystem may result in
 331                  * a read request with kernel buffer as opposed to user buffer.
 332                  */
 333                 if (req->tc->pubuf && P9_IS_USER_CONTEXT) {
 334                         in = pack_sg_list_p(chan->sg, out+inp, VIRTQUEUE_NUM,
 335                                         pdata_off, rpinfo->rp_data, pdata_len);
 336                 } else {
 337                         char *pbuf = req->tc->pubuf ? req->tc->pubuf :
 338                                                                 req->tc->pkbuf;
 339                         in = pack_sg_list(chan->sg, out+inp, VIRTQUEUE_NUM,
 340                                         pbuf, req->tc->pbuf_size);
 341                 }
 342                 in += inp;
 343         } else {
 344                 in = pack_sg_list(chan->sg, out, VIRTQUEUE_NUM, rdata,
 345                                 client->msize);
 346         }
 347
 348         err = virtqueue_add_buf(chan->vq, chan->sg, out, in, req->tc);
 349         if (err < 0) {
 350                 if (err == -ENOSPC) {
 351                         chan->ring_bufs_avail = 0;
 352                         spin_unlock_irqrestore(&chan->lock, flags);
 353                         err = wait_event_interruptible(*chan->vc_wq,
 354                                                         chan->ring_bufs_avail);
 355                         if (err  == -ERESTARTSYS)
 356                                 return err;
 357
 358                         P9_DPRINTK(P9_DEBUG_TRANS, "9p:Retry virtio request\n");
 359                         goto req_retry;
 360                 } else {
 361                         spin_unlock_irqrestore(&chan->lock, flags);
 362                         P9_DPRINTK(P9_DEBUG_TRANS,
 363                                         "9p debug: "
 364                                         "virtio rpc add_buf returned failure");
 365                         if (rpinfo && rpinfo->rp_alloc)
 366                                 kfree(rpinfo);
 367                         return -EIO;
 368                 }
 369         }
 370
 371         virtqueue_kick(chan->vq);
 372         spin_unlock_irqrestore(&chan->lock, flags);
 373
 374         P9_DPRINTK(P9_DEBUG_TRANS, "9p debug: virtio request kicked\n");
 375         return 0;
 376 }
 377
 378 static ssize_t p9_mount_tag_show(struct device *dev,
 379                                 struct device_attribute *attr, char *buf)
 380 {
 381         struct virtio_chan *chan;
 382         struct virtio_device *vdev;
 383
 384         vdev = dev_to_virtio(dev);
 385         chan = vdev->priv;
 386
 387         return snprintf(buf, chan->tag_len + 1, "%s", chan->tag);
 388 }
 389
 390 static DEVICE_ATTR(mount_tag, 0444, p9_mount_tag_show, NULL);
 391
 392 /**
 393  * p9_virtio_probe - probe for existence of 9P virtio channels
 394  * @vdev: virtio device to probe
 395  *
 396  * This probes for existing virtio channels.
 397  *
 398  */
 399
 400 static int p9_virtio_probe(struct virtio_device *vdev)
 401 {
 402         __u16 tag_len;
 403         char *tag;
 404         int err;
 405         struct virtio_chan *chan;
 406
 407         chan = kmalloc(sizeof(struct virtio_chan), GFP_KERNEL);
 408         if (!chan) {
 409                 printk(KERN_ERR "9p: Failed to allocate virtio 9P channel\n");
 410                 err = -ENOMEM;
 411                 goto fail;
 412         }
 413
 414         chan->vdev = vdev;
 415
 416         /* We expect one virtqueue, for requests. */
 417         chan->vq = virtio_find_single_vq(vdev, req_done, "requests");
 418         if (IS_ERR(chan->vq)) {
 419                 err = PTR_ERR(chan->vq);
 420                 goto out_free_vq;
 421         }
 422         chan->vq->vdev->priv = chan;
 423         spin_lock_init(&chan->lock);
 424
 425         sg_init_table(chan->sg, VIRTQUEUE_NUM);
 426
 427         chan->inuse = false;
 428         if (virtio_has_feature(vdev, VIRTIO_9P_MOUNT_TAG)) {
 429                 vdev->config->get(vdev,
 430                                 offsetof(struct virtio_9p_config, tag_len),
 431                                 &tag_len, sizeof(tag_len));
 432         } else {
 433                 err = -EINVAL;
 434                 goto out_free_vq;
 435         }
 436         tag = kmalloc(tag_len, GFP_KERNEL);
 437         if (!tag) {
 438                 err = -ENOMEM;
 439                 goto out_free_vq;
 440         }
 441         vdev->config->get(vdev, offsetof(struct virtio_9p_config, tag),
 442                         tag, tag_len);
 443         chan->tag = tag;
 444         chan->tag_len = tag_len;
 445         err = sysfs_create_file(&(vdev->dev.kobj), &dev_attr_mount_tag.attr);
 446         if (err) {
 447                 goto out_free_tag;
 448         }
 449         chan->vc_wq = kmalloc(sizeof(wait_queue_head_t), GFP_KERNEL);
 450         if (!chan->vc_wq) {
 451                 err = -ENOMEM;
 452                 goto out_free_tag;
 453         }
 454         init_waitqueue_head(chan->vc_wq);
 455         chan->ring_bufs_avail = 1;
 456
 457         mutex_lock(&virtio_9p_lock);
 458         list_add_tail(&chan->chan_list, &virtio_chan_list);
 459         mutex_unlock(&virtio_9p_lock);
 460         return 0;
 461
 462 out_free_tag:
 463         kfree(tag);
 464 out_free_vq:
 465         vdev->config->del_vqs(vdev);
 466         kfree(chan);
 467 fail:
 468         return err;
 469 }
 470
 471
 472 /**
 473  * p9_virtio_create - allocate a new virtio channel
 474  * @client: client instance invoking this transport
 475  * @devname: string identifying the channel to connect to (unused)
 476  * @args: args passed from sys_mount() for per-transport options (unused)
 477  *
 478  * This sets up a transport channel for 9p communication.  Right now
 479  * we only match the first available channel, but eventually we couldlook up
 480  * alternate channels by matching devname versus a virtio_config entry.
 481  * We use a simple reference count mechanism to ensure that only a single
 482  * mount has a channel open at a time.
 483  *
 484  */
 485
 486 static int
 487 p9_virtio_create(struct p9_client *client, const char *devname, char *args)
 488 {
 489         struct virtio_chan *chan;
 490         int ret = -ENOENT;
 491         int found = 0;
 492
 493         mutex_lock(&virtio_9p_lock);
 494         list_for_each_entry(chan, &virtio_chan_list, chan_list) {
 495                 if (!strncmp(devname, chan->tag, chan->tag_len) &&
 496                     strlen(devname) == chan->tag_len) {
 497                         if (!chan->inuse) {
 498                                 chan->inuse = true;
 499                                 found = 1;
 500                                 break;
 501                         }
 502                         ret = -EBUSY;
 503                 }
 504         }
 505         mutex_unlock(&virtio_9p_lock);
 506
 507         if (!found) {
 508                 printk(KERN_ERR "9p: no channels available\n");
 509                 return ret;
 510         }
 511
 512         client->trans = (void *)chan;
 513         client->status = Connected;
 514         chan->client = client;
 515
 516         return 0;
 517 }
 518
 519 /**
 520  * p9_virtio_remove - clean up resources associated with a virtio device
 521  * @vdev: virtio device to remove
 522  *
 523  */
 524
 525 static void p9_virtio_remove(struct virtio_device *vdev)
 526 {
 527         struct virtio_chan *chan = vdev->priv;
 528
 529         BUG_ON(chan->inuse);
 530         vdev->config->del_vqs(vdev);
 531
 532         mutex_lock(&virtio_9p_lock);
 533         list_del(&chan->chan_list);
 534         mutex_unlock(&virtio_9p_lock);
 535         sysfs_remove_file(&(vdev->dev.kobj), &dev_attr_mount_tag.attr);
 536         kfree(chan->tag);
 537         kfree(chan->vc_wq);
 538         kfree(chan);
 539
 540 }
 541
 542 static struct virtio_device_id id_table[] = {
 543         { VIRTIO_ID_9P, VIRTIO_DEV_ANY_ID },
 544         { 0 },
 545 };
 546
 547 static unsigned int features[] = {
 548         VIRTIO_9P_MOUNT_TAG,
 549 };
 550
 551 /* The standard "struct lguest_driver": */
 552 static struct virtio_driver p9_virtio_drv = {
 553         .feature_table  = features,
 554         .feature_table_size = ARRAY_SIZE(features),
 555         .driver.name    = KBUILD_MODNAME,
 556         .driver.owner   = THIS_MODULE,
 557         .id_table       = id_table,
 558         .probe          = p9_virtio_probe,
 559         .remove         = p9_virtio_remove,
 560 };
 561
 562 static struct p9_trans_module p9_virtio_trans = {
 563         .name = "virtio",
 564         .create = p9_virtio_create,
 565         .close = p9_virtio_close,
 566         .request = p9_virtio_request,
 567         .cancel = p9_virtio_cancel,
 568         .maxsize = PAGE_SIZE*16,
 569         .pref = P9_TRANS_PREF_PAYLOAD_SEP,
 570         .def = 0,
 571         .owner = THIS_MODULE,
 572 };
 573
 574 /* The standard init function */
 575 static int __init p9_virtio_init(void)
 576 {
 577         INIT_LIST_HEAD(&virtio_chan_list);
 578
 579         v9fs_register_trans(&p9_virtio_trans);
 580         return register_virtio_driver(&p9_virtio_drv);
 581 }
 582
 583 static void __exit p9_virtio_cleanup(void)
 584 {
 585         unregister_virtio_driver(&p9_virtio_drv);
 586         v9fs_unregister_trans(&p9_virtio_trans);
 587 }
 588
 589 module_init(p9_virtio_init);
 590 module_exit(p9_virtio_cleanup);
 591
 592 MODULE_DEVICE_TABLE(virtio, id_table);
 593 MODULE_AUTHOR("Eric Van Hensbergen <ericvh@gmail.com>");
 594 MODULE_DESCRIPTION("Virtio 9p Transport");
 595 MODULE_LICENSE("GPL");