Added logging functionality to linuxemu
[akaros.git] / user / vmm / virtio_lguest_console.c
1 /* Virtio helper functions from linux/tools/lguest/lguest.c
2  *
3  * Copyright (C) 1991-2016, the Linux Kernel authors
4  * Copyright (c) 2016 Google Inc.
5  *
6  * Author:
7  *  Rusty Russell <rusty@rustcorp.com.au>
8  *  Michael Taufen <mtaufen@gmail.com>
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License as
12  * published by the Free Software Foundation; either version 2 of
13  * the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * The code from lguest.c has been modified for Akaros.
21  *
22  * Original linux/tools/lguest/lguest.c:
23  *   https://github.com/torvalds/linux/blob/v4.5/tools/lguest/lguest.c
24  *   most recent hash on the file as of v4.5 tag:
25  *     e523caa601f4a7c2fa1ecd040db921baf7453798
26  */
27
28 #include <stdlib.h>
29 #include <err.h>
30 #include <sys/eventfd.h>
31 #include <sys/uio.h>
32 #include <vmm/virtio.h>
33 #include <vmm/virtio_mmio.h>
34 #include <parlib/stdio.h>
35
36 void *cons_receiveq_fn(void *_vq) // host -> guest
37 {
38         struct virtio_vq *vq = _vq;
39         uint32_t head;
40         uint32_t olen, ilen;
41         uint32_t i, j;
42         int num_read;
43         struct iovec *iov;
44         struct virtio_mmio_dev *dev = vq->vqdev->transport_dev;
45
46         if (!vq)
47                 errx(1,
48                         "\n  %s:%d\n"
49                         "  Virtio device: (not sure which one): Error, device behavior.\n"
50                         "  The device must provide a valid virtio_vq as an argument to %s."
51                         , __FILE__, __LINE__, __func__);
52
53         // NOTE: The virtio_next_avail_vq_desc will not write more than
54         //       vq->vring.num entries to iov, and the device implementation
55         //       (virtio_mmio.c) will not allow the driver to set vq->vring.num to a
56         //       value greater than QueueNumMax (vq->qnum_max), so you are safe as
57         //       long as your iov is at least vq->qnum_max iovecs in size.
58         iov = malloc(vq->qnum_max * sizeof(struct iovec));
59
60         if (vq->qready == 0x0)
61                 VIRTIO_DEV_ERRX(vq->vqdev,
62                         "The service function for queue '%s' was launched before the driver set QueueReady to 0x1."
63                         , vq->name);
64
65         // NOTE: This will block in 2 places:
66         //       - reading from stdin
67         //       - reading from eventfd in virtio_next_avail_vq_desc
68         while (1) {
69                 head = virtio_next_avail_vq_desc(vq, iov, &olen, &ilen);
70
71                 if (olen) {
72                         // virtio-v1.0-cs04 s5.3.6.1 Device Operation (console section)
73                         VIRTIO_DRI_ERRX(vq->vqdev,
74                                 "The driver placed a device-readable buffer in the console device's receiveq.\n"
75                                 "  See virtio-v1.0-cs04 s5.3.6.1 Device Operation");
76                 }
77
78                 // TODO: We may want to add some sort of console abort
79                 //       (e.g. type q and enter to quit)
80                 // readv from stdin as much as we can (to end of bufs or end of input)
81                 num_read = readv(0, iov, ilen);
82                 if (num_read < 0)
83                         VIRTIO_DEV_ERRX(vq->vqdev,
84                                 "Encountered an error trying to read input from stdin (fd 0).");
85
86                 if (num_read == 0) {
87                         VIRTIO_DEV_WARNX(vq->vqdev,
88                                 "Encountered EOF reading from stdin; exiting input thread.");
89                         break;
90                 }
91
92                 // You pass the number of bytes written to virtio_add_used_desc
93                 virtio_add_used_desc(vq, head, num_read);
94
95                 // Poke the guest however the mmio transport prefers
96                 // NOTE: assuming that the mmio transport was used for now.
97                 virtio_mmio_set_vring_irq(dev);
98                 if (dev->poke_guest)
99                         dev->poke_guest(dev->vec, dev->dest);
100                 else
101                         VIRTIO_DEV_ERRX(vq->vqdev,
102                                 "The host MUST provide a way for device interrupts to be sent to the guest. The 'poke_guest' function pointer on the vq->vqdev->transport_dev (assumed to be a struct virtio_mmio_dev) was not set.");
103         }
104         free(iov);
105         return 0;
106 }
107
108 void *cons_transmitq_fn(void *_vq) // guest -> host
109 {
110         struct virtio_vq *vq = _vq;
111         uint32_t head;
112         uint32_t olen, ilen;
113         uint32_t i, j;
114         struct iovec *iov;
115         struct virtio_mmio_dev *dev = vq->vqdev->transport_dev;
116
117         if (!vq)
118                 errx(1,
119                         "\n  %s:%d\n"
120                         "  Virtio device: (not sure which one): Error, device behavior.\n"
121                         "  The device must provide a valid virtio_vq as an argument to %s."
122                         , __FILE__, __LINE__, __func__);
123
124         // NOTE: The virtio_next_avail_vq_desc will not write more than
125         //       vq->vring.num entries to iov, and the device implementation
126         //       (virtio_mmio.c) will not allow the driver to set vq->vring.num to a
127         //       value greater than QueueNumMax (vq->qnum_max), so you are safe as
128         //       long as your iov is at least vq->qnum_max iovecs in size.
129         iov = malloc(vq->qnum_max * sizeof(struct iovec));
130
131         if (vq->qready == 0x0)
132                 VIRTIO_DEV_ERRX(vq->vqdev,
133                         "The service function for queue '%s' was launched before the driver set QueueReady to 0x1."
134                         , vq->name);
135
136         while (1) {
137                 // Get the buffers:
138                 head = virtio_next_avail_vq_desc(vq, iov, &olen, &ilen);
139
140                 if (ilen) {
141                         // virtio-v1.0-cs04 s5.3.6.1 Device Operation (console section)
142                         VIRTIO_DRI_ERRX(vq->vqdev,
143                                 "The driver placed a device-writeable buffer in the console device's transmitq.\n"
144                                 "  See virtio-v1.0-cs04 s5.3.6.1 Device Operation");
145                 }
146                 // Process the buffers:
147                 for (i = 0; i < olen; ++i) {
148                         for (j = 0; j < iov[i].iov_len; ++j)
149                                 printf("%c", ((char *)iov[i].iov_base)[j]);
150                 }
151                 fflush(stdout);
152
153                 // Add all the buffers to the used ring.
154                 // Pass 0 because we wrote nothing.
155                 virtio_add_used_desc(vq, head, 0);
156
157                 // Poke the guest however the mmio transport prefers
158                 // NOTE: assuming that the mmio transport was used for now
159                 virtio_mmio_set_vring_irq(dev);
160                 if (dev->poke_guest)
161                         dev->poke_guest(dev->vec, dev->dest);
162                 else
163                         VIRTIO_DEV_ERRX(vq->vqdev,
164                                 "The host MUST provide a way for device interrupts to be sent to the guest. The 'poke_guest' function pointer on the vq->vqdev->transport_dev (assumed to be a struct virtio_mmio_dev) was not set.");
165         }
166         free(iov);
167         return 0;
168 }