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