summaryrefslogtreecommitdiff
path: root/hw/spice-vmc.c
blob: 2ddecf40608d48b24a2020d41331df45738fff98 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
/*

 Spice Virtual Machine Channel (VMC).

 A virtio-serial port used for spice to guest communication, over
 which spice client and a daemon in the guest operating system
 communicate.

 Replaces the old vdi_port PCI device.

*/

#include <stdio.h>
#include <stdbool.h>
#include <spice.h>
#include <spice-experimental.h>

#include "virtio-serial.h"
#include "qemu-spice.h"

#define VMC_GUEST_DEVICE_NAME "com.redhat.spice.0"
#define VMC_DEVICE_NAME       "spicevmc"

/* windows guest driver bug workaround */
#define VMC_MAX_HOST_WRITE    2048

#define dprintf(_svc, _level, _fmt, ...)                                \
    do {                                                                \
        static unsigned __dprintf_counter = 0;                          \
        if (_svc->debug >= _level) {                                    \
            fprintf(stderr, "svc: %3d: " _fmt, ++__dprintf_counter, ## __VA_ARGS__);\
        }                                                               \
    } while (0)

typedef struct SpiceVirtualChannel {
    VirtIOSerialPort      port;
    VMChangeStateEntry    *vmstate;
    SpiceVDIPortInstance  sin;
    bool                  active;
    uint8_t               *buffer;
    uint8_t               *datapos;
    ssize_t               bufsize, datalen;
    uint32_t              debug;
} SpiceVirtualChannel;

static int vmc_write(SpiceVDIPortInstance *sin, const uint8_t *buf, int len)
{
    SpiceVirtualChannel *svc = container_of(sin, SpiceVirtualChannel, sin);
    ssize_t out = 0;
    ssize_t last_out;
    uint8_t* p = (uint8_t*)buf;

    while (len > 0) {
        last_out = virtio_serial_write(&svc->port, p,
                            MIN(len, VMC_MAX_HOST_WRITE));
        if (last_out > 0) {
            out += last_out;
            len -= last_out;
            p += last_out;
        } else {
            break;
        }
    }

    dprintf(svc, 3, "%s: %lu/%zd\n", __func__, out, len + out);
    return out;
}

static int vmc_read(SpiceVDIPortInstance *sin, uint8_t *buf, int len)
{
    SpiceVirtualChannel *svc = container_of(sin, SpiceVirtualChannel, sin);
    int bytes = MIN(len, svc->datalen);

    dprintf(svc, 2, "%s: %p %d/%d/%zd\n", __func__, svc->datapos, len, bytes, svc->datalen);
    if (bytes > 0) {
        memcpy(buf, svc->datapos, bytes);
        svc->datapos += bytes;
        svc->datalen -= bytes;
        assert(svc->datalen >= 0);
        if (svc->datalen == 0) {
            svc->datapos = 0;
            virtio_serial_throttle_port(&svc->port, false);
            // ^^^ !!! may call vmc_have_data, so don't touch svc after it!
        }
    }
    return bytes;
}

static SpiceVDIPortInterface vmc_interface = {
    .base.type          = SPICE_INTERFACE_VDI_PORT,
    .base.description   = "spice virtual channel vdi port",
    .base.major_version = SPICE_INTERFACE_VDI_PORT_MAJOR,
    .base.minor_version = SPICE_INTERFACE_VDI_PORT_MINOR,
    .write              = vmc_write,
    .read               = vmc_read,
};

static void vmc_register_interface(SpiceVirtualChannel *svc)
{
    if (svc->active) {
        return;
    }
    dprintf(svc, 1, "%s\n", __func__);
    svc->sin.base.sif = &vmc_interface.base;
    spice_server_add_interface(spice_server, &svc->sin.base);
    svc->active = true;
}

static void vmc_unregister_interface(SpiceVirtualChannel *svc)
{
    if (!svc->active) {
        return;
    }
    dprintf(svc, 1, "%s\n", __func__);
    spice_server_remove_interface(&svc->sin.base);
    svc->active = false;
}


static void vmc_change_state_handler(void *opaque, int running, int reason)
{
    SpiceVirtualChannel *svc = opaque;

    if (running && svc->active) {
        spice_server_vdi_port_wakeup(&svc->sin);
    }
}

/*
 * virtio-serial callbacks
 */

static void vmc_guest_open(VirtIOSerialPort *port)
{
    SpiceVirtualChannel *svc = DO_UPCAST(SpiceVirtualChannel, port, port);

    dprintf(svc, 1, "%s\n", __func__);
    vmc_register_interface(svc);
}

static void vmc_guest_close(VirtIOSerialPort *port)
{
    SpiceVirtualChannel *svc = DO_UPCAST(SpiceVirtualChannel, port, port);

    dprintf(svc, 1, "%s\n", __func__);
    vmc_unregister_interface(svc);
}

static void vmc_guest_ready(VirtIOSerialPort *port)
{
    SpiceVirtualChannel *svc = DO_UPCAST(SpiceVirtualChannel, port, port);

    dprintf(svc, 1, "%s\n", __func__);
    if (svc->active)
        spice_server_vdi_port_wakeup(&svc->sin);
}

static void vmc_have_data(VirtIOSerialPort *port, const uint8_t *buf, size_t len)
{
    SpiceVirtualChannel *svc = DO_UPCAST(SpiceVirtualChannel, port, port);

    dprintf(svc, 2, "%s: %zd\n", __func__, len);
    assert(svc->datalen == 0);
    if (svc->bufsize < len) {
        svc->bufsize = len;
        svc->buffer = qemu_realloc(svc->buffer, svc->bufsize);
    }
    memcpy(svc->buffer, buf, len);
    svc->datapos = svc->buffer;
    svc->datalen = len;
    virtio_serial_throttle_port(&svc->port, true);
    spice_server_vdi_port_wakeup(&svc->sin);
}

static int vmc_initfn(VirtIOSerialDevice *dev)
{
    VirtIOSerialPort *port = DO_UPCAST(VirtIOSerialPort, dev, &dev->qdev);
    SpiceVirtualChannel *svc = DO_UPCAST(SpiceVirtualChannel, port, port);

    if (!using_spice)
        return -1;

    dprintf(svc, 1, "%s\n", __func__);
    port->name = qemu_strdup(VMC_GUEST_DEVICE_NAME);
    svc->vmstate = qemu_add_vm_change_state_handler(
        vmc_change_state_handler, svc);
    virtio_serial_open(port);
    return 0;
}

static int vmc_exitfn(VirtIOSerialDevice *dev)
{
    VirtIOSerialPort *port = DO_UPCAST(VirtIOSerialPort, dev, &dev->qdev);
    SpiceVirtualChannel *svc = DO_UPCAST(SpiceVirtualChannel, port, port);

    dprintf(svc, 1, "%s\n", __func__);
    vmc_unregister_interface(svc);
    qemu_del_vm_change_state_handler(svc->vmstate);
    virtio_serial_close(port);
    return 0;
}

static VirtIOSerialPortInfo vmc_info = {
    .qdev.name     = VMC_DEVICE_NAME,
    .qdev.size     = sizeof(SpiceVirtualChannel),
    .init          = vmc_initfn,
    .exit          = vmc_exitfn,
    .guest_open    = vmc_guest_open,
    .guest_close   = vmc_guest_close,
    .guest_ready   = vmc_guest_ready,
    .have_data     = vmc_have_data,
    .qdev.props = (Property[]) {
        DEFINE_PROP_UINT32("nr", SpiceVirtualChannel, port.id, VIRTIO_CONSOLE_BAD_ID),
        DEFINE_PROP_UINT32("debug", SpiceVirtualChannel, debug, 1),
        DEFINE_PROP_END_OF_LIST(),
    }
};

static void vmc_register(void)
{
    virtio_serial_port_qdev_register(&vmc_info);
}
device_init(vmc_register)