Patchwork [1/1] spice: add chardev

login
register
mail settings
Submitter Alon Levy
Date Dec. 16, 2010, 11:29 a.m.
Message ID <1292498949-16933-1-git-send-email-alevy@redhat.com>
Download mbox | patch
Permalink /patch/75744/
State New
Headers show

Comments

Alon Levy - Dec. 16, 2010, 11:29 a.m.
Adding a chardev backend for spice, for usage by spice vdagent in
conjunction with a properly named virtio-serial device.
---
 Makefile.objs     |    2 +-
 qemu-char.c       |    7 ++
 qemu-config.c     |    9 ++
 qemu-options.hx   |   18 ++++-
 spice-qemu-char.c |  222 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 spice-qemu-char.h |    9 ++
 6 files changed, 265 insertions(+), 2 deletions(-)
 create mode 100644 spice-qemu-char.c
 create mode 100644 spice-qemu-char.h
Gerd Hoffmann - Dec. 16, 2010, 1:21 p.m.
On 12/16/10 12:29, Alon Levy wrote:
> Adding a chardev backend for spice, for usage by spice vdagent in
> conjunction with a properly named virtio-serial device.

Usage example would be nice here.

> +#ifdef CONFIG_SPICE
> +#include "spice-qemu-char.h"
> +#endif

#ifdef can be dropped.

> +#ifdef CONFIG_SPICE
> +        {
> +            .name = "name",
> +            .type = QEMU_OPT_STRING,
> +        },{
> +            .name = "debug",
> +            .type = QEMU_OPT_NUMBER,
> +        },
> +#endif

This too.

> @@ -1381,7 +1384,10 @@ Backend is one of:
>   @option{stdio},
>   @option{braille},
>   @option{tty},
> -@option{parport}.
> +@option{parport}
> +#if defined(CONFIG_SPICE)
> +@option{spicevmc}.
> +#endif

This too, documentation should be there unconditionally.

> +//#define SPICE_QEMU_CHAR_USE_IOCTL

Why is this disabled?
Does it depend on the chardev patches from Amit?

> diff --git a/spice-qemu-char.h b/spice-qemu-char.h
> new file mode 100644
> index 0000000..32d5009
> --- /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__
> +

Hmm, maybe add this to ui/qemu-spice.h instead, so we don't clutter the 
tree with lots of tiny includes?

cheers,
   Gerd
Alon Levy - Dec. 16, 2010, 4:48 p.m.
On Thu, Dec 16, 2010 at 02:21:16PM +0100, Gerd Hoffmann wrote:
> On 12/16/10 12:29, Alon Levy wrote:
> >Adding a chardev backend for spice, for usage by spice vdagent in
> >conjunction with a properly named virtio-serial device.
> 
> Usage example would be nice here.
> 
> >+#ifdef CONFIG_SPICE
> >+#include "spice-qemu-char.h"
> >+#endif
> 
> #ifdef can be dropped.
> 
ok.

> >+#ifdef CONFIG_SPICE
> >+        {
> >+            .name = "name",
> >+            .type = QEMU_OPT_STRING,
> >+        },{
> >+            .name = "debug",
> >+            .type = QEMU_OPT_NUMBER,
> >+        },
> >+#endif
> 
> This too.

ok.

> 
> >@@ -1381,7 +1384,10 @@ Backend is one of:
> >  @option{stdio},
> >  @option{braille},
> >  @option{tty},
> >-@option{parport}.
> >+@option{parport}
> >+#if defined(CONFIG_SPICE)
> >+@option{spicevmc}.
> >+#endif
> 
> This too, documentation should be there unconditionally.
> 
ok.

> >+//#define SPICE_QEMU_CHAR_USE_IOCTL
> 
> Why is this disabled?
> Does it depend on the chardev patches from Amit?
> 

There was a long discussion that concluded we don't want IOCTL's at all,
and that there should be some other mechanism for connection state
communication between the two sides. Meanwhile I found out I don't need
these (I don't remember exactly what I used instead, but basically just
the regular results of write/read).

> >diff --git a/spice-qemu-char.h b/spice-qemu-char.h
> >new file mode 100644
> >index 0000000..32d5009
> >--- /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__
> >+
> 
> Hmm, maybe add this to ui/qemu-spice.h instead, so we don't clutter
> the tree with lots of tiny includes?

ok.

> 
> cheers,
>   Gerd
Gerd Hoffmann - Dec. 16, 2010, 4:53 p.m.
Hi,

>>> +//#define SPICE_QEMU_CHAR_USE_IOCTL
>>
>> Why is this disabled?
>> Does it depend on the chardev patches from Amit?
>>
>
> There was a long discussion that concluded we don't want IOCTL's at all,
> and that there should be some other mechanism for connection state
> communication between the two sides. Meanwhile I found out I don't need
> these (I don't remember exactly what I used instead, but basically just
> the regular results of write/read).

Ok, so when it is obsolete now it can be dropped altogether I guess?

cheers,
   Gerd
Alon Levy - Dec. 17, 2010, 12:54 p.m.
On Thu, Dec 16, 2010 at 05:53:10PM +0100, Gerd Hoffmann wrote:
>   Hi,
> 
> >>>+//#define SPICE_QEMU_CHAR_USE_IOCTL
> >>
> >>Why is this disabled?
> >>Does it depend on the chardev patches from Amit?
> >>
> >
> >There was a long discussion that concluded we don't want IOCTL's at all,
> >and that there should be some other mechanism for connection state
> >communication between the two sides. Meanwhile I found out I don't need
> >these (I don't remember exactly what I used instead, but basically just
> >the regular results of write/read).
> 
> Ok, so when it is obsolete now it can be dropped altogether I guess?

ok, I'll remove it from the patch.

> 
> cheers,
>   Gerd
> 
>

Patch

diff --git a/Makefile.objs b/Makefile.objs
index cebb945..320b2a9 100644
--- a/Makefile.objs
+++ b/Makefile.objs
@@ -102,7 +102,7 @@  common-obj-$(CONFIG_BRLAPI) += baum.o
 common-obj-$(CONFIG_POSIX) += migration-exec.o migration-unix.o migration-fd.o
 common-obj-$(CONFIG_WIN32) += version.o
 
-common-obj-$(CONFIG_SPICE) += ui/spice-core.o ui/spice-input.o ui/spice-display.o
+common-obj-$(CONFIG_SPICE) += ui/spice-core.o ui/spice-input.o ui/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 edc9ad6..82789ba 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
 
 /***********************************************************/
@@ -2495,6 +2499,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 965fa46..42cd977 100644
--- a/qemu-config.c
+++ b/qemu-config.c
@@ -147,6 +147,15 @@  static 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 of list */ }
     },
 };
diff --git a/qemu-options.hx b/qemu-options.hx
index 4d99a58..d8ad070 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -1357,6 +1357,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
 )
 
@@ -1381,7 +1384,10 @@  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.
@@ -1557,6 +1563,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 0000000..a080796
--- /dev/null
+++ b/spice-qemu-char.c
@@ -0,0 +1,222 @@ 
+#include "config-host.h"
+#include "ui/qemu-spice.h"
+#include <spice.h>
+#include <spice-experimental.h>
+
+#include "osdep.h"
+
+#include "spice-qemu-char.h"
+
+//#define SPICE_QEMU_CHAR_USE_IOCTL
+
+#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;
+    SpiceCharDeviceInstance     sin;
+    char                  *subtype;
+    bool                  active;
+    uint8_t               *buffer;
+    uint8_t               *datapos;
+    ssize_t               bufsize, datalen;
+    uint32_t              debug;
+} SpiceCharDriver;
+
+
+static int vmc_write(SpiceCharDeviceInstance *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(SpiceCharDeviceInstance *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;
+        }
+    }
+    return bytes;
+}
+
+static SpiceCharDeviceInterface vmc_interface = {
+    .base.type          = SPICE_INTERFACE_CHAR_DEVICE,
+    .base.description   = "spice virtual channel char device",
+    .base.major_version = SPICE_INTERFACE_CHAR_DEVICE_MAJOR,
+    .base.minor_version = SPICE_INTERFACE_CHAR_DEVICE_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;
+    qemu_spice_add_interface(&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;
+
+    dprintf(s, 2, "%s: %d\n", __func__, len);
+    vmc_register_interface(s);
+    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;
+    spice_server_char_device_wakeup(&s->sin);
+    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
+}
+
+#ifdef SPICE_QEMU_CHAR_USE_IOCTL
+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_char_device_wakeup(&s->sin);
+            break;
+        default:
+            dprintf(s, 2, "%s: unsupported IOCTL %d\n", __func__, cmd);
+            return -ENOTSUP;
+    }
+    return 0;
+}
+#endif // SPICE_QEMU_CHAR_USE_IOCTL
+
+static void print_allowed_subtypes(void)
+{
+    const char** psubtype;
+    int i;
+
+    fprintf(stderr, "allowed names: ");
+    for(i=0, psubtype = spice_server_char_device_recognized_subtypes();
+        *psubtype != NULL; ++psubtype, ++i) {
+        if (i == 0) {
+            fprintf(stderr, "%s", *psubtype);
+        } else {
+            fprintf(stderr, ", %s", *psubtype);
+        }
+    }
+    fprintf(stderr, "\n");
+}
+
+CharDriverState *qemu_chr_open_spice(QemuOpts *opts)
+{
+    CharDriverState *chr;
+    SpiceCharDriver *s;
+    const char* name = qemu_opt_get(opts, "name");
+    uint32_t debug = qemu_opt_get_number(opts, "debug", 0);
+    const char** psubtype = spice_server_char_device_recognized_subtypes();
+    const char *subtype = NULL;
+
+    if (name == NULL) {
+        fprintf(stderr, "spice-qemu-char: missing name parameter\n");
+        print_allowed_subtypes();
+        return NULL;
+    }
+    for(;*psubtype != NULL; ++psubtype) {
+        if (strcmp(name, *psubtype) == 0) {
+            subtype = *psubtype;
+            break;
+        }
+    }
+    if (subtype == NULL) {
+        fprintf(stderr, "spice-qemu-char: unsupported name\n");
+        print_allowed_subtypes();
+        return NULL;
+    }
+
+    chr = qemu_mallocz(sizeof(CharDriverState));
+    s = qemu_mallocz(sizeof(SpiceCharDriver));
+    s->chr = chr;
+    s->debug = debug;
+    s->active = false;
+    s->sin.subtype = subtype;
+    chr->opaque = s;
+    chr->chr_write = spice_chr_write;
+    chr->chr_close = spice_chr_close;
+#ifdef SPICE_QEMU_CHAR_USE_IOCTL
+    chr->chr_ioctl = spice_chr_ioctl;
+#endif
+
+    qemu_chr_generic_open(chr);
+
+    return chr;
+}
+
diff --git a/spice-qemu-char.h b/spice-qemu-char.h
new file mode 100644
index 0000000..32d5009
--- /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__
+