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