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