spice-qemu-char: spice char-dev backend

6 files changed, 236 insertions, 2 deletions

diff --git a/Makefile.objs b/Makefile.objs
index dbb8805be..543062962 100644
--- a/Makefile.objs
+++ b/Makefile.objs
@@ -89,7 +89,7 @@ common-obj-y += pflib.o
 common-obj-$(CONFIG_BRLAPI) += baum.o
 common-obj-$(CONFIG_POSIX) += migration-exec.o migration-unix.o migration-fd.o
 
-common-obj-$(CONFIG_SPICE) += spice.o spice-input.o spice-display.o
+common-obj-$(CONFIG_SPICE) += spice.o spice-input.o spice-display.o spice-qemu-char.o
 
 audio-obj-y = audio.o noaudio.o wavaudio.o mixeng.o
 audio-obj-$(CONFIG_SDL) += sdlaudio.o
diff --git a/qemu-char.c b/qemu-char.c
index 9b69d928e..482765a22 100644
--- a/qemu-char.c
+++ b/qemu-char.c
@@ -98,6 +98,10 @@
 
 #include "qemu_socket.h"
 
+#ifdef CONFIG_SPICE
+#include "spice-qemu-char.h"
+#endif
+
 #define READ_BUF_LEN 4096
 
 /***********************************************************/
@@ -2428,6 +2432,9 @@ static const struct {
     || defined(__FreeBSD_kernel__)
     { .name = "parport",   .open = qemu_chr_open_pp },
 #endif
+#ifdef CONFIG_SPICE
+    { .name = "spicevmc",     .open = qemu_chr_open_spice },
+#endif
 };
 
 CharDriverState *qemu_chr_open_opts(QemuOpts *opts,
diff --git a/qemu-config.c b/qemu-config.c
index adec1d9a8..77e4ac6e0 100644
--- a/qemu-config.c
+++ b/qemu-config.c
@@ -151,6 +151,15 @@ QemuOptsList qemu_chardev_opts = {
             .name = "signal",
             .type = QEMU_OPT_BOOL,
         },
+#ifdef CONFIG_SPICE
+        {
+            .name = "name",
+            .type = QEMU_OPT_STRING,
+        },{
+            .name = "debug",
+            .type = QEMU_OPT_NUMBER,
+        },
+#endif
         { /* end if list */ }
     },
 };
diff --git a/qemu-options.hx b/qemu-options.hx
index 85551ccce..1245046f9 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -1300,6 +1300,9 @@ DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
     "-chardev parport,id=id,path=path[,mux=on|off]\n"
 #endif
+#if defined(CONFIG_SPICE)
+    "-chardev spicevmc,id=id,debug=debug,name=name\n"
+#endif
     , QEMU_ARCH_ALL
 )
 
@@ -1324,7 +1327,11 @@ Backend is one of:
 @option{stdio},
 @option{braille},
 @option{tty},
-@option{parport}.
+@option{parport}
+#if defined(CONFIG_SPICE)
+@option{spicevmc}
+#endif
+.
 The specific backend will determine the applicable options.
 
 All devices must have an id, which can be any string up to 127 characters long.
@@ -1500,6 +1507,16 @@ Connect to a local parallel port.
 @option{path} specifies the path to the parallel port device. @option{path} is
 required.
 
+#if defined(CONFIG_SPICE)
+@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
+
+@option{debug} debug level for spicevmc
+
+@option{name} name of spice channel to connect to
+
+Connect to a spice virtual machine channel, such as vdiport.
+#endif
+
 @end table
 ETEXI
 
diff --git a/spice-qemu-char.c b/spice-qemu-char.c
new file mode 100644
index 000000000..4c93d150c
--- /dev/null
+++ b/spice-qemu-char.c
@@ -0,0 +1,192 @@
+#include "config-host.h"
+#include "qemu-spice.h"
+#include <spice.h>
+#include <spice-experimental.h>
+
+#include "osdep.h"
+
+#include "spice-qemu-char.h"
+
+#define dprintf(_scd, _level, _fmt, ...)                                \
+    do {                                                                \
+        static unsigned __dprintf_counter = 0;                          \
+        if (_scd->debug >= _level) {                                    \
+            fprintf(stderr, "scd: %3d: " _fmt, ++__dprintf_counter, ## __VA_ARGS__);\
+        }                                                               \
+    } while (0)
+
+#define VMC_MAX_HOST_WRITE    2048
+
+typedef struct SpiceCharDriver {
+    CharDriverState*      chr;
+    SpiceVDIPortInstance  sin;
+    bool                  active;
+    uint8_t               *buffer;
+    uint8_t               *datapos;
+    ssize_t               bufsize, datalen;
+    uint32_t              debug;
+} SpiceCharDriver;
+
+
+static int vmc_write(SpiceVDIPortInstance *sin, const uint8_t *buf, int len)
+{
+    SpiceCharDriver *scd = container_of(sin, SpiceCharDriver, sin);
+    ssize_t out = 0;
+    ssize_t last_out;
+    uint8_t* p = (uint8_t*)buf;
+
+    while (len > 0) {
+        last_out = MIN(len, VMC_MAX_HOST_WRITE);
+        qemu_chr_read(scd->chr, p, last_out);
+        if (last_out > 0) {
+            out += last_out;
+            len -= last_out;
+            p += last_out;
+        } else {
+            break;
+        }
+    }
+
+    dprintf(scd, 3, "%s: %lu/%zd\n", __func__, out, len + out);
+    return out;
+}
+
+static int vmc_read(SpiceVDIPortInstance *sin, uint8_t *buf, int len)
+{
+    SpiceCharDriver *scd = container_of(sin, SpiceCharDriver, sin);
+    int bytes = MIN(len, scd->datalen);
+
+    dprintf(scd, 2, "%s: %p %d/%d/%zd\n", __func__, scd->datapos, len, bytes, scd->datalen);
+    if (bytes > 0) {
+        memcpy(buf, scd->datapos, bytes);
+        scd->datapos += bytes;
+        scd->datalen -= bytes;
+        assert(scd->datalen >= 0);
+        if (scd->datalen == 0) {
+            scd->datapos = 0;
+            //virtio_serial_throttle_port(&scd->port, false);
+            // ^^^ !!! may call vmc_have_data, so don't touch scd 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(SpiceCharDriver *scd)
+{
+    if (scd->active) {
+        return;
+    }
+    dprintf(scd, 1, "%s\n", __func__);
+    scd->sin.base.sif = &vmc_interface.base;
+    spice_server_add_interface(spice_server, &scd->sin.base);
+    scd->active = true;
+}
+
+static void vmc_unregister_interface(SpiceCharDriver *scd)
+{
+    if (!scd->active) {
+        return;
+    }
+    dprintf(scd, 1, "%s\n", __func__);
+    spice_server_remove_interface(&scd->sin.base);
+    scd->active = false;
+}
+
+
+static int spice_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
+{
+    SpiceCharDriver *s = chr->opaque;
+
+    vmc_register_interface(s); // TODO: a guest_open API for qemu_chr?
+
+    dprintf(s, 2, "%s: %d\n", __func__, len);
+    assert(s->datalen == 0);
+    if (s->bufsize < len) {
+        s->bufsize = len;
+        s->buffer = qemu_realloc(s->buffer, s->bufsize);
+    }
+    memcpy(s->buffer, buf, len);
+    s->datapos = s->buffer;
+    s->datalen = len;
+    //virtio_serial_throttle_port(&s->port, true);
+    spice_server_vdi_port_wakeup(&s->sin);
+    // no way to tell how much data was actually consumed - but basically
+    // since our assert is ok that means we consumed it all
+    return len;
+}
+
+static void spice_chr_close(struct CharDriverState *chr)
+{
+    SpiceCharDriver *s = chr->opaque;
+
+    printf("%s\n", __func__);
+    vmc_unregister_interface(s);
+    qemu_free(s);
+    //qemu_chr_event(chr, CHR_EVENT_CLOSED); // TODO: export qemu_chr_event from qemu-char.h
+}
+
+static int spice_chr_ioctl(CharDriverState *chr, int cmd, void *arg)
+{
+    SpiceCharDriver *s = chr->opaque;
+
+    switch (cmd) {
+        case CHR_IOCTL_VIRT_SERIAL_OPEN:
+            dprintf(s, 2, "%s: open ioctl\n", __func__);
+            vmc_register_interface(s);
+            break;
+        case CHR_IOCTL_VIRT_SERIAL_CLOSE:
+            dprintf(s, 2, "%s: close ioctl\n", __func__);
+            vmc_unregister_interface(s);
+            break;
+        case CHR_IOCTL_VIRT_SERIAL_READY:
+            dprintf(s, 2, "%s: ready ioctl\n", __func__);
+            if (s->active)
+                spice_server_vdi_port_wakeup(&s->sin);
+            break;
+        default:
+            dprintf(s, 2, "%s: unsupported IOCTL %d\n", __func__, cmd);
+            return -ENOTSUP;
+    }
+    return 0;
+}
+
+
+CharDriverState *qemu_chr_open_spice(QemuOpts *opts)
+{
+    CharDriverState *chr;
+    SpiceCharDriver *s;
+    // TODO: use path to determine which virtual channel to connect
+    // to. Right now it's hard coded to the VDI_PORT (for vdagent)
+    const char* name = qemu_opt_get(opts, "name");
+    uint32_t debug = qemu_opt_get_number(opts, "debug", 0);
+
+    if (strcmp(name, "vdiport") != 0) {
+        fprintf(stderr, "spicevmc: only vdiport is supported for name\n");
+        return NULL;
+    }
+
+    chr = qemu_mallocz(sizeof(CharDriverState));
+    s = qemu_mallocz(sizeof(SpiceCharDriver));
+    s->chr = chr;
+    s->debug = debug;
+    s->active = false;
+    chr->opaque = s;
+    chr->chr_write = spice_chr_write;
+    chr->chr_close = spice_chr_close;
+    chr->chr_ioctl = spice_chr_ioctl;
+
+    qemu_chr_generic_open(chr);
+
+    return chr;
+}
+
diff --git a/spice-qemu-char.h b/spice-qemu-char.h
new file mode 100644
index 000000000..32d5009a0
--- /dev/null
+++ b/spice-qemu-char.h
@@ -0,0 +1,9 @@
+#ifndef __SPICE_QEMU_CHAR_H__
+#define __SPICE_QEMU_CHAR_H__
+
+#include "qemu-char.h"
+
+CharDriverState *qemu_chr_open_spice(QemuOpts *opts);
+
+#endif // __SPICE_QEMU_CHAR_H__
+