2 * The Guest 9p transport driver
4 * This is a block based transport driver based on the lguest block driver
9 * Copyright (C) 2007 Eric Van Hensbergen, IBM Corporation
11 * Based on virtio console driver
12 * Copyright (C) 2006, 2007 Rusty Russell, IBM Corporation
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License version 2
16 * as published by the Free Software Foundation.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to:
25 * Free Software Foundation
26 * 51 Franklin Street, Fifth Floor
27 * Boston, MA 02111-1301 USA
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 <net/9p/9p.h>
43 #include <linux/parser.h>
44 #include <net/9p/transport.h>
45 #include <linux/scatterlist.h>
46 #include <linux/virtio.h>
47 #include <linux/virtio_9p.h>
49 #define VIRTQUEUE_NUM 128
51 /* a single mutex to manage channel initialization and attachment */
52 static DECLARE_MUTEX(virtio_9p_lock);
53 /* global which tracks highest initialized channel */
54 static int chan_index;
56 #define P9_INIT_MAXTAG 16
58 #define REQ_STATUS_IDLE 0
59 #define REQ_STATUS_SENT 1
60 #define REQ_STATUS_RCVD 2
61 #define REQ_STATUS_FLSH 3
65 wait_queue_head_t *wq;
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.
72 static struct virtio_chan {
73 bool initialized; /* channel is initialized */
74 bool inuse; /* channel is in use */
78 struct virtio_device *vdev;
81 struct p9_idpool *tagpool;
82 struct p9_req_t *reqs;
85 /* Scatterlist: can be too big for stack. */
86 struct scatterlist sg[VIRTQUEUE_NUM];
87 } channels[MAX_9P_CHAN];
89 /* Lookup requests by tag */
90 static struct p9_req_t *p9_lookup_tag(struct virtio_chan *c, u16 tag)
92 /* This looks up the original request by tag so we know which
93 * buffer to read the data into */
96 while (tag >= c->max_tag) {
97 int old_max = c->max_tag;
103 c->max_tag = P9_INIT_MAXTAG;
105 c->reqs = krealloc(c->reqs, sizeof(struct p9_req_t)*c->max_tag,
108 printk(KERN_ERR "Couldn't grow tag array\n");
111 for (count = old_max; count < c->max_tag; count++) {
112 c->reqs[count].status = REQ_STATUS_IDLE;
113 c->reqs[count].wq = kmalloc(sizeof(wait_queue_t),
115 if (!c->reqs[count].wq) {
116 printk(KERN_ERR "Couldn't grow tag array\n");
119 init_waitqueue_head(c->reqs[count].wq);
123 return &c->reqs[tag];
127 /* How many bytes left in this page. */
128 static unsigned int rest_of_page(void *data)
130 return PAGE_SIZE - ((unsigned long)data % PAGE_SIZE);
133 static void p9_virtio_close(struct p9_trans *trans)
135 struct virtio_chan *chan = trans->priv;
139 spin_lock_irqsave(&chan->lock, flags);
140 p9_idpool_destroy(chan->tagpool);
141 for (count = 0; count < chan->max_tag; count++)
142 kfree(chan->reqs[count].wq);
145 spin_unlock_irqrestore(&chan->lock, flags);
147 down(&virtio_9p_lock);
154 static void req_done(struct virtqueue *vq)
156 struct virtio_chan *chan = vq->vdev->priv;
160 struct p9_req_t *req;
162 spin_lock_irqsave(&chan->lock, flags);
163 while ((rc = chan->vq->vq_ops->get_buf(chan->vq, &len)) != NULL) {
164 req = p9_lookup_tag(chan, rc->tag);
165 req->status = REQ_STATUS_RCVD;
168 /* In case queue is stopped waiting for more buffers. */
169 spin_unlock_irqrestore(&chan->lock, flags);
173 pack_sg_list(struct scatterlist *sg, int start, int limit, char *data,
180 s = rest_of_page(data);
183 sg_set_buf(&sg[index++], data, s);
186 BUG_ON(index > limit);
193 p9_virtio_rpc(struct p9_trans *t, struct p9_fcall *tc, struct p9_fcall **rc)
197 struct virtio_chan *chan = t->priv;
199 struct p9_req_t *req;
203 *rc = kmalloc(sizeof(struct p9_fcall) + t->msize, GFP_KERNEL);
208 rdata = (char *)*rc+sizeof(struct p9_fcall);
211 if (tc->id != P9_TVERSION) {
212 n = p9_idpool_get(chan->tagpool);
217 spin_lock_irqsave(&chan->lock, flags);
218 req = p9_lookup_tag(chan, n);
219 spin_unlock_irqrestore(&chan->lock, flags);
223 P9_DPRINTK(P9_DEBUG_TRANS, "9p debug: virtio rpc tag %d\n", n);
225 out = pack_sg_list(chan->sg, 0, VIRTQUEUE_NUM, tc->sdata, tc->size);
226 in = pack_sg_list(chan->sg, out, VIRTQUEUE_NUM-out, rdata, t->msize);
228 req->status = REQ_STATUS_SENT;
230 if (chan->vq->vq_ops->add_buf(chan->vq, chan->sg, out, in, tc)) {
231 P9_DPRINTK(P9_DEBUG_TRANS,
232 "9p debug: virtio rpc add_buf returned failure");
236 chan->vq->vq_ops->kick(chan->vq);
238 wait_event(*req->wq, req->status == REQ_STATUS_RCVD);
240 size = le32_to_cpu(*(__le32 *) rdata);
242 err = p9_deserialize_fcall(rdata, size, *rc, t->extended);
244 P9_DPRINTK(P9_DEBUG_TRANS,
245 "9p debug: virtio rpc deserialize returned %d\n", err);
249 #ifdef CONFIG_NET_9P_DEBUG
250 if ((p9_debug_level&P9_DEBUG_FCALL) == P9_DEBUG_FCALL) {
253 p9_printfcall(buf, sizeof(buf), *rc, t->extended);
254 printk(KERN_NOTICE ">>> %p %s\n", t, buf);
258 if (n != P9_NOTAG && p9_idpool_check(n, chan->tagpool))
259 p9_idpool_put(n, chan->tagpool);
261 req->status = REQ_STATUS_IDLE;
266 static int p9_virtio_probe(struct virtio_device *vdev)
269 struct virtio_chan *chan;
272 down(&virtio_9p_lock);
273 index = chan_index++;
274 chan = &channels[index];
277 if (chan_index > MAX_9P_CHAN) {
278 printk(KERN_ERR "9p: virtio: Maximum channels exceeded\n");
286 /* We expect one virtqueue, for requests. */
287 chan->vq = vdev->config->find_vq(vdev, 0, req_done);
288 if (IS_ERR(chan->vq)) {
289 err = PTR_ERR(chan->vq);
292 chan->vq->vdev->priv = chan;
293 spin_lock_init(&chan->lock);
295 sg_init_table(chan->sg, VIRTQUEUE_NUM);
298 chan->initialized = true;
302 vdev->config->del_vq(chan->vq);
304 down(&virtio_9p_lock);
310 /* This sets up a transport channel for 9p communication. Right now
311 * we only match the first available channel, but eventually we couldlook up
312 * alternate channels by matching devname versus a virtio_config entry.
313 * We use a simple reference count mechanism to ensure that only a single
314 * mount has a channel open at a time. */
315 static struct p9_trans *
316 p9_virtio_create(const char *devname, char *args, int msize,
317 unsigned char extended)
319 struct p9_trans *trans;
320 struct virtio_chan *chan = channels;
323 down(&virtio_9p_lock);
324 while (index < MAX_9P_CHAN) {
325 if (chan->initialized && !chan->inuse) {
330 chan = &channels[index];
335 if (index >= MAX_9P_CHAN) {
336 printk(KERN_ERR "9p: no channels available\n");
337 return ERR_PTR(-ENODEV);
340 chan->tagpool = p9_idpool_create();
341 if (IS_ERR(chan->tagpool)) {
342 printk(KERN_ERR "9p: couldn't allocate tagpool\n");
343 return ERR_PTR(-ENOMEM);
345 p9_idpool_get(chan->tagpool); /* reserve tag 0 */
349 trans = kmalloc(sizeof(struct p9_trans), GFP_KERNEL);
351 printk(KERN_ERR "9p: couldn't allocate transport\n");
352 return ERR_PTR(-ENOMEM);
354 trans->extended = extended;
355 trans->msize = msize;
356 trans->close = p9_virtio_close;
357 trans->rpc = p9_virtio_rpc;
363 static void p9_virtio_remove(struct virtio_device *vdev)
365 struct virtio_chan *chan = vdev->priv;
369 if (chan->initialized) {
370 vdev->config->del_vq(chan->vq);
371 chan->initialized = false;
375 #define VIRTIO_ID_9P 9
377 static struct virtio_device_id id_table[] = {
378 { VIRTIO_ID_9P, VIRTIO_DEV_ANY_ID },
382 /* The standard "struct lguest_driver": */
383 static struct virtio_driver p9_virtio_drv = {
384 .driver.name = KBUILD_MODNAME,
385 .driver.owner = THIS_MODULE,
386 .id_table = id_table,
387 .probe = p9_virtio_probe,
388 .remove = p9_virtio_remove,
391 static struct p9_trans_module p9_virtio_trans = {
393 .create = p9_virtio_create,
394 .maxsize = PAGE_SIZE*16,
398 /* The standard init function */
399 static int __init p9_virtio_init(void)
403 for (count = 0; count < MAX_9P_CHAN; count++)
404 channels[count].initialized = false;
406 v9fs_register_trans(&p9_virtio_trans);
407 return register_virtio_driver(&p9_virtio_drv);
410 static void __exit p9_virtio_cleanup(void)
412 unregister_virtio_driver(&p9_virtio_drv);
415 module_init(p9_virtio_init);
416 module_exit(p9_virtio_cleanup);
418 MODULE_DEVICE_TABLE(virtio, id_table);
419 MODULE_AUTHOR("Eric Van Hensbergen <ericvh@gmail.com>");
420 MODULE_DESCRIPTION("Virtio 9p Transport");
421 MODULE_LICENSE("GPL");