2 * The Virtio 9p transport driver
4 * This is a block based transport driver based on the lguest block driver
7 * Copyright (C) 2007, 2008 Eric Van Hensbergen, IBM Corporation
9 * Based on virtio console driver
10 * Copyright (C) 2006, 2007 Rusty Russell, IBM Corporation
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.
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.
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
29 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
32 #include <linux/module.h>
33 #include <linux/net.h>
34 #include <linux/ipv6.h>
35 #include <linux/errno.h>
36 #include <linux/kernel.h>
38 #include <linux/uaccess.h>
39 #include <linux/inet.h>
40 #include <linux/idr.h>
41 #include <linux/file.h>
42 #include <linux/highmem.h>
43 #include <linux/slab.h>
44 #include <net/9p/9p.h>
45 #include <linux/parser.h>
46 #include <net/9p/client.h>
47 #include <net/9p/transport.h>
48 #include <linux/scatterlist.h>
49 #include <linux/swap.h>
50 #include <linux/virtio.h>
51 #include <linux/virtio_9p.h>
52 #include "trans_common.h"
54 #define VIRTQUEUE_NUM 128
56 /* a single mutex to manage channel initialization and attachment */
57 static DEFINE_MUTEX(virtio_9p_lock);
58 static DECLARE_WAIT_QUEUE_HEAD(vp_wq);
59 static atomic_t vp_pinned = ATOMIC_INIT(0);
62 * struct virtio_chan - per-instance transport information
63 * @inuse: whether the channel is in use
64 * @lock: protects multiple elements within this structure
65 * @client: client instance
66 * @vdev: virtio dev associated with this channel
67 * @vq: virtio queue associated with this channel
68 * @sg: scatter gather list which is used to pack a request (protected?)
70 * We keep all per-channel information in a structure.
71 * This structure is allocated within the devices dev->mem space.
72 * A pointer to the structure will get put in the transport private.
81 struct p9_client *client;
82 struct virtio_device *vdev;
85 wait_queue_head_t *vc_wq;
86 /* This is global limit. Since we don't have a global structure,
87 * will be placing it in each channel.
89 unsigned long p9_max_pages;
90 /* Scatterlist: can be too big for stack. */
91 struct scatterlist sg[VIRTQUEUE_NUM];
93 * tag name to identify a mount null terminated
97 struct list_head chan_list;
100 static struct list_head virtio_chan_list;
102 /* How many bytes left in this page. */
103 static unsigned int rest_of_page(void *data)
105 return PAGE_SIZE - offset_in_page(data);
109 * p9_virtio_close - reclaim resources of a channel
110 * @client: client instance
112 * This reclaims a channel by freeing its resources and
113 * reseting its inuse flag.
117 static void p9_virtio_close(struct p9_client *client)
119 struct virtio_chan *chan = client->trans;
121 mutex_lock(&virtio_9p_lock);
124 mutex_unlock(&virtio_9p_lock);
128 * req_done - callback which signals activity from the server
129 * @vq: virtio queue activity was received on
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
136 * Bugs: could do with some additional sanity checking, but appears to work.
140 static void req_done(struct virtqueue *vq)
142 struct virtio_chan *chan = vq->vdev->priv;
144 struct p9_req_t *req;
145 bool need_wakeup = false;
148 p9_debug(P9_DEBUG_TRANS, ": request done\n");
150 spin_lock_irqsave(&chan->lock, flags);
151 while ((req = virtqueue_get_buf(chan->vq, &len)) != NULL) {
152 if (!chan->ring_bufs_avail) {
153 chan->ring_bufs_avail = 1;
159 p9_client_cb(chan->client, req, REQ_STATUS_RCVD);
162 spin_unlock_irqrestore(&chan->lock, flags);
163 /* Wakeup if anyone waiting for VirtIO ring space. */
165 wake_up(chan->vc_wq);
169 * pack_sg_list - pack a scatter gather list from a linear buffer
170 * @sg: scatter/gather list to pack into
171 * @start: which segment of the sg_list to start at
172 * @limit: maximum segment to pack data to
173 * @data: data to pack into scatter/gather list
174 * @count: amount of data to pack into the scatter/gather list
176 * sg_lists have multiple segments of various sizes. This will pack
177 * arbitrary data into an existing scatter gather list, segmenting the
178 * data as necessary within constraints.
182 static int pack_sg_list(struct scatterlist *sg, int start,
183 int limit, char *data, int count)
189 s = rest_of_page(data);
192 BUG_ON(index >= limit);
193 /* Make sure we don't terminate early. */
194 sg_unmark_end(&sg[index]);
195 sg_set_buf(&sg[index++], data, s);
200 sg_mark_end(&sg[index - 1]);
204 /* We don't currently allow canceling of virtio requests */
205 static int p9_virtio_cancel(struct p9_client *client, struct p9_req_t *req)
211 * pack_sg_list_p - Just like pack_sg_list. Instead of taking a buffer,
212 * this takes a list of pages.
213 * @sg: scatter/gather list to pack into
214 * @start: which segment of the sg_list to start at
215 * @pdata: a list of pages to add into sg.
216 * @nr_pages: number of pages to pack into the scatter/gather list
217 * @offs: amount of data in the beginning of first page _not_ to pack
218 * @count: amount of data to pack into the scatter/gather list
221 pack_sg_list_p(struct scatterlist *sg, int start, int limit,
222 struct page **pdata, int nr_pages, size_t offs, int count)
228 BUG_ON(nr_pages > (limit - start));
230 * if the first page doesn't start at
231 * page boundary find the offset
234 s = PAGE_SIZE - data_off;
237 BUG_ON(index >= limit);
238 /* Make sure we don't terminate early. */
239 sg_unmark_end(&sg[index]);
240 sg_set_page(&sg[index++], pdata[i++], s, data_off);
247 sg_mark_end(&sg[index - 1]);
248 return index - start;
252 * p9_virtio_request - issue a request
253 * @client: client instance issuing the request
254 * @req: request to be issued
259 p9_virtio_request(struct p9_client *client, struct p9_req_t *req)
262 int in, out, out_sgs, in_sgs;
264 struct virtio_chan *chan = client->trans;
265 struct scatterlist *sgs[2];
267 p9_debug(P9_DEBUG_TRANS, "9p debug: virtio request\n");
269 req->status = REQ_STATUS_SENT;
271 spin_lock_irqsave(&chan->lock, flags);
273 out_sgs = in_sgs = 0;
274 /* Handle out VirtIO ring buffers */
275 out = pack_sg_list(chan->sg, 0,
276 VIRTQUEUE_NUM, req->tc->sdata, req->tc->size);
278 sgs[out_sgs++] = chan->sg;
280 in = pack_sg_list(chan->sg, out,
281 VIRTQUEUE_NUM, req->rc->sdata, req->rc->capacity);
283 sgs[out_sgs + in_sgs++] = chan->sg + out;
285 err = virtqueue_add_sgs(chan->vq, sgs, out_sgs, in_sgs, req,
288 if (err == -ENOSPC) {
289 chan->ring_bufs_avail = 0;
290 spin_unlock_irqrestore(&chan->lock, flags);
291 err = wait_event_killable(*chan->vc_wq,
292 chan->ring_bufs_avail);
293 if (err == -ERESTARTSYS)
296 p9_debug(P9_DEBUG_TRANS, "Retry virtio request\n");
299 spin_unlock_irqrestore(&chan->lock, flags);
300 p9_debug(P9_DEBUG_TRANS,
301 "virtio rpc add_sgs returned failure\n");
305 virtqueue_kick(chan->vq);
306 spin_unlock_irqrestore(&chan->lock, flags);
308 p9_debug(P9_DEBUG_TRANS, "virtio request kicked\n");
312 static int p9_get_mapped_pages(struct virtio_chan *chan,
313 struct page ***pages,
314 struct iov_iter *data,
322 if (!iov_iter_count(data))
325 if (!(data->type & ITER_KVEC)) {
328 * We allow only p9_max_pages pinned. We wait for the
329 * Other zc request to finish here
331 if (atomic_read(&vp_pinned) >= chan->p9_max_pages) {
332 err = wait_event_killable(vp_wq,
333 (atomic_read(&vp_pinned) < chan->p9_max_pages));
334 if (err == -ERESTARTSYS)
337 n = iov_iter_get_pages_alloc(data, pages, count, offs);
341 nr_pages = DIV_ROUND_UP(n + *offs, PAGE_SIZE);
342 atomic_add(nr_pages, &vp_pinned);
345 /* kernel buffer, no need to pin pages */
350 /* we'd already checked that it's non-empty */
352 len = iov_iter_single_seg_count(data);
354 p = data->kvec->iov_base + data->iov_offset;
357 iov_iter_advance(data, 0);
362 nr_pages = DIV_ROUND_UP((unsigned long)p + len, PAGE_SIZE) -
363 (unsigned long)p / PAGE_SIZE;
365 *pages = kmalloc_array(nr_pages, sizeof(struct page *),
371 p -= (*offs = offset_in_page(p));
372 for (index = 0; index < nr_pages; index++) {
373 if (is_vmalloc_addr(p))
374 (*pages)[index] = vmalloc_to_page(p);
376 (*pages)[index] = kmap_to_page(p);
384 * p9_virtio_zc_request - issue a zero copy request
385 * @client: client instance issuing the request
386 * @req: request to be issued
387 * @uidata: user buffer that should be used for zero copy read
388 * @uodata: user buffer that should be used for zero copy write
389 * @inlen: read buffer size
390 * @outlen: write buffer size
391 * @in_hdr_len: reader header size, This is the size of response protocol data
395 p9_virtio_zc_request(struct p9_client *client, struct p9_req_t *req,
396 struct iov_iter *uidata, struct iov_iter *uodata,
397 int inlen, int outlen, int in_hdr_len)
399 int in, out, err, out_sgs, in_sgs;
401 int in_nr_pages = 0, out_nr_pages = 0;
402 struct page **in_pages = NULL, **out_pages = NULL;
403 struct virtio_chan *chan = client->trans;
404 struct scatterlist *sgs[4];
408 p9_debug(P9_DEBUG_TRANS, "virtio request\n");
412 int n = p9_get_mapped_pages(chan, &out_pages, uodata,
413 outlen, &offs, &need_drop);
416 out_nr_pages = DIV_ROUND_UP(n + offs, PAGE_SIZE);
418 __le32 v = cpu_to_le32(n);
419 memcpy(&req->tc->sdata[req->tc->size - 4], &v, 4);
422 /* The size field of the message must include the length of the
423 * header and the length of the data. We didn't actually know
424 * the length of the data until this point so add it in now.
426 sz = cpu_to_le32(req->tc->size + outlen);
427 memcpy(&req->tc->sdata[0], &sz, sizeof(sz));
429 int n = p9_get_mapped_pages(chan, &in_pages, uidata,
430 inlen, &offs, &need_drop);
433 in_nr_pages = DIV_ROUND_UP(n + offs, PAGE_SIZE);
435 __le32 v = cpu_to_le32(n);
436 memcpy(&req->tc->sdata[req->tc->size - 4], &v, 4);
440 req->status = REQ_STATUS_SENT;
442 spin_lock_irqsave(&chan->lock, flags);
444 out_sgs = in_sgs = 0;
447 out = pack_sg_list(chan->sg, 0,
448 VIRTQUEUE_NUM, req->tc->sdata, req->tc->size);
451 sgs[out_sgs++] = chan->sg;
454 sgs[out_sgs++] = chan->sg + out;
455 out += pack_sg_list_p(chan->sg, out, VIRTQUEUE_NUM,
456 out_pages, out_nr_pages, offs, outlen);
460 * Take care of in data
461 * For example TREAD have 11.
462 * 11 is the read/write header = PDU Header(7) + IO Size (4).
463 * Arrange in such a way that server places header in the
464 * alloced memory and payload onto the user buffer.
466 in = pack_sg_list(chan->sg, out,
467 VIRTQUEUE_NUM, req->rc->sdata, in_hdr_len);
469 sgs[out_sgs + in_sgs++] = chan->sg + out;
472 sgs[out_sgs + in_sgs++] = chan->sg + out + in;
473 in += pack_sg_list_p(chan->sg, out + in, VIRTQUEUE_NUM,
474 in_pages, in_nr_pages, offs, inlen);
477 BUG_ON(out_sgs + in_sgs > ARRAY_SIZE(sgs));
478 err = virtqueue_add_sgs(chan->vq, sgs, out_sgs, in_sgs, req,
481 if (err == -ENOSPC) {
482 chan->ring_bufs_avail = 0;
483 spin_unlock_irqrestore(&chan->lock, flags);
484 err = wait_event_killable(*chan->vc_wq,
485 chan->ring_bufs_avail);
486 if (err == -ERESTARTSYS)
489 p9_debug(P9_DEBUG_TRANS, "Retry virtio request\n");
490 goto req_retry_pinned;
492 spin_unlock_irqrestore(&chan->lock, flags);
493 p9_debug(P9_DEBUG_TRANS,
494 "virtio rpc add_sgs returned failure\n");
499 virtqueue_kick(chan->vq);
500 spin_unlock_irqrestore(&chan->lock, flags);
501 p9_debug(P9_DEBUG_TRANS, "virtio request kicked\n");
502 err = wait_event_killable(req->wq, req->status >= REQ_STATUS_RCVD);
504 * Non kernel buffers are pinned, unpin them
509 p9_release_pages(in_pages, in_nr_pages);
510 atomic_sub(in_nr_pages, &vp_pinned);
513 p9_release_pages(out_pages, out_nr_pages);
514 atomic_sub(out_nr_pages, &vp_pinned);
516 /* wakeup anybody waiting for slots to pin pages */
524 static ssize_t p9_mount_tag_show(struct device *dev,
525 struct device_attribute *attr, char *buf)
527 struct virtio_chan *chan;
528 struct virtio_device *vdev;
531 vdev = dev_to_virtio(dev);
533 tag_len = strlen(chan->tag);
535 memcpy(buf, chan->tag, tag_len + 1);
540 static DEVICE_ATTR(mount_tag, 0444, p9_mount_tag_show, NULL);
543 * p9_virtio_probe - probe for existence of 9P virtio channels
544 * @vdev: virtio device to probe
546 * This probes for existing virtio channels.
550 static int p9_virtio_probe(struct virtio_device *vdev)
555 struct virtio_chan *chan;
557 if (!vdev->config->get) {
558 dev_err(&vdev->dev, "%s failure: config access disabled\n",
563 chan = kmalloc(sizeof(struct virtio_chan), GFP_KERNEL);
565 pr_err("Failed to allocate virtio 9P channel\n");
572 /* We expect one virtqueue, for requests. */
573 chan->vq = virtio_find_single_vq(vdev, req_done, "requests");
574 if (IS_ERR(chan->vq)) {
575 err = PTR_ERR(chan->vq);
578 chan->vq->vdev->priv = chan;
579 spin_lock_init(&chan->lock);
581 sg_init_table(chan->sg, VIRTQUEUE_NUM);
584 if (virtio_has_feature(vdev, VIRTIO_9P_MOUNT_TAG)) {
585 virtio_cread(vdev, struct virtio_9p_config, tag_len, &tag_len);
590 tag = kzalloc(tag_len + 1, GFP_KERNEL);
596 virtio_cread_bytes(vdev, offsetof(struct virtio_9p_config, tag),
599 err = sysfs_create_file(&(vdev->dev.kobj), &dev_attr_mount_tag.attr);
603 chan->vc_wq = kmalloc(sizeof(wait_queue_head_t), GFP_KERNEL);
608 init_waitqueue_head(chan->vc_wq);
609 chan->ring_bufs_avail = 1;
610 /* Ceiling limit to avoid denial of service attacks */
611 chan->p9_max_pages = nr_free_buffer_pages()/4;
613 virtio_device_ready(vdev);
615 mutex_lock(&virtio_9p_lock);
616 list_add_tail(&chan->chan_list, &virtio_chan_list);
617 mutex_unlock(&virtio_9p_lock);
619 /* Let udev rules use the new mount_tag attribute. */
620 kobject_uevent(&(vdev->dev.kobj), KOBJ_CHANGE);
627 vdev->config->del_vqs(vdev);
636 * p9_virtio_create - allocate a new virtio channel
637 * @client: client instance invoking this transport
638 * @devname: string identifying the channel to connect to (unused)
639 * @args: args passed from sys_mount() for per-transport options (unused)
641 * This sets up a transport channel for 9p communication. Right now
642 * we only match the first available channel, but eventually we couldlook up
643 * alternate channels by matching devname versus a virtio_config entry.
644 * We use a simple reference count mechanism to ensure that only a single
645 * mount has a channel open at a time.
650 p9_virtio_create(struct p9_client *client, const char *devname, char *args)
652 struct virtio_chan *chan;
659 mutex_lock(&virtio_9p_lock);
660 list_for_each_entry(chan, &virtio_chan_list, chan_list) {
661 if (!strcmp(devname, chan->tag)) {
670 mutex_unlock(&virtio_9p_lock);
673 pr_err("no channels available for device %s\n", devname);
677 client->trans = (void *)chan;
678 client->status = Connected;
679 chan->client = client;
685 * p9_virtio_remove - clean up resources associated with a virtio device
686 * @vdev: virtio device to remove
690 static void p9_virtio_remove(struct virtio_device *vdev)
692 struct virtio_chan *chan = vdev->priv;
693 unsigned long warning_time;
695 mutex_lock(&virtio_9p_lock);
697 /* Remove self from list so we don't get new users. */
698 list_del(&chan->chan_list);
699 warning_time = jiffies;
701 /* Wait for existing users to close. */
702 while (chan->inuse) {
703 mutex_unlock(&virtio_9p_lock);
705 if (time_after(jiffies, warning_time + 10 * HZ)) {
706 dev_emerg(&vdev->dev,
707 "p9_virtio_remove: waiting for device in use.\n");
708 warning_time = jiffies;
710 mutex_lock(&virtio_9p_lock);
713 mutex_unlock(&virtio_9p_lock);
715 vdev->config->reset(vdev);
716 vdev->config->del_vqs(vdev);
718 sysfs_remove_file(&(vdev->dev.kobj), &dev_attr_mount_tag.attr);
719 kobject_uevent(&(vdev->dev.kobj), KOBJ_CHANGE);
726 static struct virtio_device_id id_table[] = {
727 { VIRTIO_ID_9P, VIRTIO_DEV_ANY_ID },
731 static unsigned int features[] = {
735 /* The standard "struct lguest_driver": */
736 static struct virtio_driver p9_virtio_drv = {
737 .feature_table = features,
738 .feature_table_size = ARRAY_SIZE(features),
739 .driver.name = KBUILD_MODNAME,
740 .driver.owner = THIS_MODULE,
741 .id_table = id_table,
742 .probe = p9_virtio_probe,
743 .remove = p9_virtio_remove,
746 static struct p9_trans_module p9_virtio_trans = {
748 .create = p9_virtio_create,
749 .close = p9_virtio_close,
750 .request = p9_virtio_request,
751 .zc_request = p9_virtio_zc_request,
752 .cancel = p9_virtio_cancel,
754 * We leave one entry for input and one entry for response
755 * headers. We also skip one more entry to accomodate, address
756 * that are not at page boundary, that can result in an extra
759 .maxsize = PAGE_SIZE * (VIRTQUEUE_NUM - 3),
761 .owner = THIS_MODULE,
764 /* The standard init function */
765 static int __init p9_virtio_init(void)
767 INIT_LIST_HEAD(&virtio_chan_list);
769 v9fs_register_trans(&p9_virtio_trans);
770 return register_virtio_driver(&p9_virtio_drv);
773 static void __exit p9_virtio_cleanup(void)
775 unregister_virtio_driver(&p9_virtio_drv);
776 v9fs_unregister_trans(&p9_virtio_trans);
779 module_init(p9_virtio_init);
780 module_exit(p9_virtio_cleanup);
782 MODULE_DEVICE_TABLE(virtio, id_table);
783 MODULE_AUTHOR("Eric Van Hensbergen <ericvh@gmail.com>");
784 MODULE_DESCRIPTION("Virtio 9p Transport");
785 MODULE_LICENSE("GPL");