spice-qemu-char.c

   1 #include "config-host.h"
   2 #include "trace.h"
   3 #include "ui/qemu-spice.h"
   4 #include "sysemu/char.h"
   5 #include <spice.h>
   6 #include <spice-experimental.h>
   7 #include <spice/protocol.h>
   8
   9 #include "qemu/osdep.h"
  10
  11 typedef struct SpiceCharDriver {
  12     CharDriverState*      chr;
  13     SpiceCharDeviceInstance     sin;
  14     char                  *subtype;
  15     bool                  active;
  16     bool                  blocked;
  17     uint8_t               *buffer;
  18     uint8_t               *datapos;
  19     ssize_t               bufsize, datalen;
  20     QLIST_ENTRY(SpiceCharDriver) next;
  21 } SpiceCharDriver;
  22
  23 typedef struct SpiceCharSource {
  24     GSource               source;
  25     SpiceCharDriver       *scd;
  26 } SpiceCharSource;
  27
  28 static QLIST_HEAD(, SpiceCharDriver) spice_chars =
  29     QLIST_HEAD_INITIALIZER(spice_chars);
  30
  31 static int vmc_write(SpiceCharDeviceInstance *sin, const uint8_t *buf, int len)
  32 {
  33     SpiceCharDriver *scd = container_of(sin, SpiceCharDriver, sin);
  34     ssize_t out = 0;
  35     ssize_t last_out;
  36     uint8_t* p = (uint8_t*)buf;
  37
  38     while (len > 0) {
  39         last_out = MIN(len, qemu_chr_be_can_write(scd->chr));
  40         if (last_out <= 0) {
  41             break;
  42         }
  43         qemu_chr_be_write(scd->chr, p, last_out);
  44         out += last_out;
  45         len -= last_out;
  46         p += last_out;
  47     }
  48
  49     trace_spice_vmc_write(out, len + out);
  50     return out;
  51 }
  52
  53 static int vmc_read(SpiceCharDeviceInstance *sin, uint8_t *buf, int len)
  54 {
  55     SpiceCharDriver *scd = container_of(sin, SpiceCharDriver, sin);
  56     int bytes = MIN(len, scd->datalen);
  57
  58     if (bytes > 0) {
  59         memcpy(buf, scd->datapos, bytes);
  60         scd->datapos += bytes;
  61         scd->datalen -= bytes;
  62         assert(scd->datalen >= 0);
  63     }
  64     if (scd->datalen == 0) {
  65         scd->datapos = 0;
  66         scd->blocked = false;
  67     }
  68     trace_spice_vmc_read(bytes, len);
  69     return bytes;
  70 }
  71
  72 #if SPICE_SERVER_VERSION >= 0x000c02
  73 static void vmc_event(SpiceCharDeviceInstance *sin, uint8_t event)
  74 {
  75     SpiceCharDriver *scd = container_of(sin, SpiceCharDriver, sin);
  76     int chr_event;
  77
  78     switch (event) {
  79     case SPICE_PORT_EVENT_BREAK:
  80         chr_event = CHR_EVENT_BREAK;
  81         break;
  82     default:
  83         return;
  84     }
  85
  86     trace_spice_vmc_event(chr_event);
  87     qemu_chr_be_event(scd->chr, chr_event);
  88 }
  89 #endif
  90
  91 static void vmc_state(SpiceCharDeviceInstance *sin, int connected)
  92 {
  93     SpiceCharDriver *scd = container_of(sin, SpiceCharDriver, sin);
  94
  95     if ((scd->chr->be_open && connected) ||
  96         (!scd->chr->be_open && !connected)) {
  97         return;
  98     }
  99
 100     qemu_chr_be_event(scd->chr,
 101                       connected ? CHR_EVENT_OPENED : CHR_EVENT_CLOSED);
 102 }
 103
 104 static SpiceCharDeviceInterface vmc_interface = {
 105     .base.type          = SPICE_INTERFACE_CHAR_DEVICE,
 106     .base.description   = "spice virtual channel char device",
 107     .base.major_version = SPICE_INTERFACE_CHAR_DEVICE_MAJOR,
 108     .base.minor_version = SPICE_INTERFACE_CHAR_DEVICE_MINOR,
 109     .state              = vmc_state,
 110     .write              = vmc_write,
 111     .read               = vmc_read,
 112 #if SPICE_SERVER_VERSION >= 0x000c02
 113     .event              = vmc_event,
 114 #endif
 115 };
 116
 117
 118 static void vmc_register_interface(SpiceCharDriver *scd)
 119 {
 120     if (scd->active) {
 121         return;
 122     }
 123     scd->sin.base.sif = &vmc_interface.base;
 124     qemu_spice_add_interface(&scd->sin.base);
 125     scd->active = true;
 126     trace_spice_vmc_register_interface(scd);
 127 }
 128
 129 static void vmc_unregister_interface(SpiceCharDriver *scd)
 130 {
 131     if (!scd->active) {
 132         return;
 133     }
 134     spice_server_remove_interface(&scd->sin.base);
 135     scd->active = false;
 136     trace_spice_vmc_unregister_interface(scd);
 137 }
 138
 139 static gboolean spice_char_source_prepare(GSource *source, gint *timeout)
 140 {
 141     SpiceCharSource *src = (SpiceCharSource *)source;
 142
 143     *timeout = -1;
 144
 145     return !src->scd->blocked;
 146 }
 147
 148 static gboolean spice_char_source_check(GSource *source)
 149 {
 150     SpiceCharSource *src = (SpiceCharSource *)source;
 151
 152     return !src->scd->blocked;
 153 }
 154
 155 static gboolean spice_char_source_dispatch(GSource *source,
 156     GSourceFunc callback, gpointer user_data)
 157 {
 158     GIOFunc func = (GIOFunc)callback;
 159
 160     return func(NULL, G_IO_OUT, user_data);
 161 }
 162
 163 GSourceFuncs SpiceCharSourceFuncs = {
 164     .prepare  = spice_char_source_prepare,
 165     .check    = spice_char_source_check,
 166     .dispatch = spice_char_source_dispatch,
 167 };
 168
 169 static GSource *spice_chr_add_watch(CharDriverState *chr, GIOCondition cond)
 170 {
 171     SpiceCharDriver *scd = chr->opaque;
 172     SpiceCharSource *src;
 173
 174     assert(cond == G_IO_OUT);
 175
 176     src = (SpiceCharSource *)g_source_new(&SpiceCharSourceFuncs,
 177                                           sizeof(SpiceCharSource));
 178     src->scd = scd;
 179
 180     return (GSource *)src;
 181 }
 182
 183 static int spice_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
 184 {
 185     SpiceCharDriver *s = chr->opaque;
 186     int read_bytes;
 187
 188     assert(s->datalen == 0);
 189     if (s->bufsize < len) {
 190         s->bufsize = len;
 191         s->buffer = g_realloc(s->buffer, s->bufsize);
 192     }
 193     memcpy(s->buffer, buf, len);
 194     s->datapos = s->buffer;
 195     s->datalen = len;
 196     spice_server_char_device_wakeup(&s->sin);
 197     read_bytes = len - s->datalen;
 198     if (read_bytes != len) {
 199         /* We'll get passed in the unconsumed data with the next call */
 200         s->datalen = 0;
 201         s->datapos = NULL;
 202         s->blocked = true;
 203     }
 204     return read_bytes;
 205 }
 206
 207 static void spice_chr_close(struct CharDriverState *chr)
 208 {
 209     SpiceCharDriver *s = chr->opaque;
 210
 211     vmc_unregister_interface(s);
 212     QLIST_REMOVE(s, next);
 213
 214     g_free((char *)s->sin.subtype);
 215 #if SPICE_SERVER_VERSION >= 0x000c02
 216     g_free((char *)s->sin.portname);
 217 #endif
 218     g_free(s);
 219 }
 220
 221 static void spice_chr_set_fe_open(struct CharDriverState *chr, int fe_open)
 222 {
 223     SpiceCharDriver *s = chr->opaque;
 224     if (fe_open) {
 225         vmc_register_interface(s);
 226     } else {
 227         vmc_unregister_interface(s);
 228     }
 229 }
 230
 231 static void print_allowed_subtypes(void)
 232 {
 233     const char** psubtype;
 234     int i;
 235
 236     fprintf(stderr, "allowed names: ");
 237     for(i=0, psubtype = spice_server_char_device_recognized_subtypes();
 238         *psubtype != NULL; ++psubtype, ++i) {
 239         if (i == 0) {
 240             fprintf(stderr, "%s", *psubtype);
 241         } else {
 242             fprintf(stderr, ", %s", *psubtype);
 243         }
 244     }
 245     fprintf(stderr, "\n");
 246 }
 247
 248 static CharDriverState *chr_open(const char *subtype)
 249 {
 250     CharDriverState *chr;
 251     SpiceCharDriver *s;
 252
 253     chr = g_malloc0(sizeof(CharDriverState));
 254     s = g_malloc0(sizeof(SpiceCharDriver));
 255     s->chr = chr;
 256     s->active = false;
 257     s->sin.subtype = g_strdup(subtype);
 258     chr->opaque = s;
 259     chr->chr_write = spice_chr_write;
 260     chr->chr_add_watch = spice_chr_add_watch;
 261     chr->chr_close = spice_chr_close;
 262     chr->chr_set_fe_open = spice_chr_set_fe_open;
 263
 264     QLIST_INSERT_HEAD(&spice_chars, s, next);
 265
 266     return chr;
 267 }
 268
 269 CharDriverState *qemu_chr_open_spice_vmc(const char *type)
 270 {
 271     const char **psubtype = spice_server_char_device_recognized_subtypes();
 272
 273     if (type == NULL) {
 274         fprintf(stderr, "spice-qemu-char: missing name parameter\n");
 275         print_allowed_subtypes();
 276         return NULL;
 277     }
 278     for (; *psubtype != NULL; ++psubtype) {
 279         if (strcmp(type, *psubtype) == 0) {
 280             break;
 281         }
 282     }
 283     if (*psubtype == NULL) {
 284         fprintf(stderr, "spice-qemu-char: unsupported type: %s\n", type);
 285         print_allowed_subtypes();
 286         return NULL;
 287     }
 288
 289     return chr_open(type);
 290 }
 291
 292 #if SPICE_SERVER_VERSION >= 0x000c02
 293 CharDriverState *qemu_chr_open_spice_port(const char *name)
 294 {
 295     CharDriverState *chr;
 296     SpiceCharDriver *s;
 297
 298     if (name == NULL) {
 299         fprintf(stderr, "spice-qemu-char: missing name parameter\n");
 300         return NULL;
 301     }
 302
 303     chr = chr_open("port");
 304     s = chr->opaque;
 305     s->sin.portname = g_strdup(name);
 306
 307     return chr;
 308 }
 309
 310 void qemu_spice_register_ports(void)
 311 {
 312     SpiceCharDriver *s;
 313
 314     QLIST_FOREACH(s, &spice_chars, next) {
 315         if (s->sin.portname == NULL) {
 316             continue;
 317         }
 318         vmc_register_interface(s);
 319     }
 320 }
 321 #endif
 322
 323 static void qemu_chr_parse_spice_vmc(QemuOpts *opts, ChardevBackend *backend,
 324                                      Error **errp)
 325 {
 326     const char *name = qemu_opt_get(opts, "name");
 327
 328     if (name == NULL) {
 329         error_setg(errp, "chardev: spice channel: no name given");
 330         return;
 331     }
 332     backend->spicevmc = g_new0(ChardevSpiceChannel, 1);
 333     backend->spicevmc->type = g_strdup(name);
 334 }
 335
 336 static void qemu_chr_parse_spice_port(QemuOpts *opts, ChardevBackend *backend,
 337                                       Error **errp)
 338 {
 339     const char *name = qemu_opt_get(opts, "name");
 340
 341     if (name == NULL) {
 342         error_setg(errp, "chardev: spice port: no name given");
 343         return;
 344     }
 345     backend->spiceport = g_new0(ChardevSpicePort, 1);
 346     backend->spiceport->fqdn = g_strdup(name);
 347 }
 348
 349 static void register_types(void)
 350 {
 351     register_char_driver_qapi("spicevmc", CHARDEV_BACKEND_KIND_SPICEVMC,
 352                               qemu_chr_parse_spice_vmc);
 353     register_char_driver_qapi("spiceport", CHARDEV_BACKEND_KIND_SPICEPORT,
 354                               qemu_chr_parse_spice_port);
 355 }
 356
 357 type_init(register_types);