ui/spice-core.c

   1 /*
   2  * Copyright (C) 2010 Red Hat, Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License as
   6  * published by the Free Software Foundation; either version 2 or
   7  * (at your option) version 3 of the License.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #include <spice.h>
  19 #include <spice-experimental.h>
  20
  21 #include <netdb.h>
  22
  23 #include "qemu-common.h"
  24 #include "qemu-spice.h"
  25 #include "qemu-timer.h"
  26 #include "qemu-queue.h"
  27 #include "qemu-x509.h"
  28 #include "qemu_socket.h"
  29 #include "qint.h"
  30 #include "qbool.h"
  31 #include "qstring.h"
  32 #include "qjson.h"
  33 #include "monitor.h"
  34
  35 /* core bits */
  36
  37 static SpiceServer *spice_server;
  38 static const char *auth = "spice";
  39 int using_spice = 0;
  40
  41 struct SpiceTimer {
  42     QEMUTimer *timer;
  43     QTAILQ_ENTRY(SpiceTimer) next;
  44 };
  45 static QTAILQ_HEAD(, SpiceTimer) timers = QTAILQ_HEAD_INITIALIZER(timers);
  46
  47 static SpiceTimer *timer_add(SpiceTimerFunc func, void *opaque)
  48 {
  49     SpiceTimer *timer;
  50
  51     timer = qemu_mallocz(sizeof(*timer));
  52     timer->timer = qemu_new_timer(rt_clock, func, opaque);
  53     QTAILQ_INSERT_TAIL(&timers, timer, next);
  54     return timer;
  55 }
  56
  57 static void timer_start(SpiceTimer *timer, uint32_t ms)
  58 {
  59     qemu_mod_timer(timer->timer, qemu_get_clock(rt_clock) + ms);
  60 }
  61
  62 static void timer_cancel(SpiceTimer *timer)
  63 {
  64     qemu_del_timer(timer->timer);
  65 }
  66
  67 static void timer_remove(SpiceTimer *timer)
  68 {
  69     qemu_del_timer(timer->timer);
  70     qemu_free_timer(timer->timer);
  71     QTAILQ_REMOVE(&timers, timer, next);
  72     qemu_free(timer);
  73 }
  74
  75 struct SpiceWatch {
  76     int fd;
  77     int event_mask;
  78     SpiceWatchFunc func;
  79     void *opaque;
  80     QTAILQ_ENTRY(SpiceWatch) next;
  81 };
  82 static QTAILQ_HEAD(, SpiceWatch) watches = QTAILQ_HEAD_INITIALIZER(watches);
  83
  84 static void watch_read(void *opaque)
  85 {
  86     SpiceWatch *watch = opaque;
  87     watch->func(watch->fd, SPICE_WATCH_EVENT_READ, watch->opaque);
  88 }
  89
  90 static void watch_write(void *opaque)
  91 {
  92     SpiceWatch *watch = opaque;
  93     watch->func(watch->fd, SPICE_WATCH_EVENT_WRITE, watch->opaque);
  94 }
  95
  96 static void watch_update_mask(SpiceWatch *watch, int event_mask)
  97 {
  98     IOHandler *on_read = NULL;
  99     IOHandler *on_write = NULL;
 100
 101     watch->event_mask = event_mask;
 102     if (watch->event_mask & SPICE_WATCH_EVENT_READ) {
 103         on_read = watch_read;
 104     }
 105     if (watch->event_mask & SPICE_WATCH_EVENT_WRITE) {
 106         on_write = watch_write;
 107     }
 108     qemu_set_fd_handler(watch->fd, on_read, on_write, watch);
 109 }
 110
 111 static SpiceWatch *watch_add(int fd, int event_mask, SpiceWatchFunc func, void *opaque)
 112 {
 113     SpiceWatch *watch;
 114
 115     watch = qemu_mallocz(sizeof(*watch));
 116     watch->fd     = fd;
 117     watch->func   = func;
 118     watch->opaque = opaque;
 119     QTAILQ_INSERT_TAIL(&watches, watch, next);
 120
 121     watch_update_mask(watch, event_mask);
 122     return watch;
 123 }
 124
 125 static void watch_remove(SpiceWatch *watch)
 126 {
 127     watch_update_mask(watch, 0);
 128     QTAILQ_REMOVE(&watches, watch, next);
 129     qemu_free(watch);
 130 }
 131
 132 #if SPICE_INTERFACE_CORE_MINOR >= 3
 133
 134 typedef struct ChannelList ChannelList;
 135 struct ChannelList {
 136     SpiceChannelEventInfo *info;
 137     QTAILQ_ENTRY(ChannelList) link;
 138 };
 139 static QTAILQ_HEAD(, ChannelList) channel_list = QTAILQ_HEAD_INITIALIZER(channel_list);
 140
 141 static void channel_list_add(SpiceChannelEventInfo *info)
 142 {
 143     ChannelList *item;
 144
 145     item = qemu_mallocz(sizeof(*item));
 146     item->info = info;
 147     QTAILQ_INSERT_TAIL(&channel_list, item, link);
 148 }
 149
 150 static void channel_list_del(SpiceChannelEventInfo *info)
 151 {
 152     ChannelList *item;
 153
 154     QTAILQ_FOREACH(item, &channel_list, link) {
 155         if (item->info != info) {
 156             continue;
 157         }
 158         QTAILQ_REMOVE(&channel_list, item, link);
 159         qemu_free(item);
 160         return;
 161     }
 162 }
 163
 164 static void add_addr_info(QDict *dict, struct sockaddr *addr, int len)
 165 {
 166     char host[NI_MAXHOST], port[NI_MAXSERV];
 167     const char *family;
 168
 169     getnameinfo(addr, len, host, sizeof(host), port, sizeof(port),
 170                 NI_NUMERICHOST | NI_NUMERICSERV);
 171     family = inet_strfamily(addr->sa_family);
 172
 173     qdict_put(dict, "host", qstring_from_str(host));
 174     qdict_put(dict, "port", qstring_from_str(port));
 175     qdict_put(dict, "family", qstring_from_str(family));
 176 }
 177
 178 static void add_channel_info(QDict *dict, SpiceChannelEventInfo *info)
 179 {
 180     int tls = info->flags & SPICE_CHANNEL_EVENT_FLAG_TLS;
 181
 182     qdict_put(dict, "connection-id", qint_from_int(info->connection_id));
 183     qdict_put(dict, "channel-type", qint_from_int(info->type));
 184     qdict_put(dict, "channel-id", qint_from_int(info->id));
 185     qdict_put(dict, "tls", qbool_from_int(tls));
 186 }
 187
 188 static QList *channel_list_get(void)
 189 {
 190     ChannelList *item;
 191     QList *list;
 192     QDict *dict;
 193
 194     list = qlist_new();
 195     QTAILQ_FOREACH(item, &channel_list, link) {
 196         dict = qdict_new();
 197         add_addr_info(dict, &item->info->paddr, item->info->plen);
 198         add_channel_info(dict, item->info);
 199         qlist_append(list, dict);
 200     }
 201     return list;
 202 }
 203
 204 static void channel_event(int event, SpiceChannelEventInfo *info)
 205 {
 206     static const int qevent[] = {
 207         [ SPICE_CHANNEL_EVENT_CONNECTED    ] = QEVENT_SPICE_CONNECTED,
 208         [ SPICE_CHANNEL_EVENT_INITIALIZED  ] = QEVENT_SPICE_INITIALIZED,
 209         [ SPICE_CHANNEL_EVENT_DISCONNECTED ] = QEVENT_SPICE_DISCONNECTED,
 210     };
 211     QDict *server, *client;
 212     QObject *data;
 213
 214     client = qdict_new();
 215     add_addr_info(client, &info->paddr, info->plen);
 216
 217     server = qdict_new();
 218     add_addr_info(server, &info->laddr, info->llen);
 219
 220     if (event == SPICE_CHANNEL_EVENT_INITIALIZED) {
 221         qdict_put(server, "auth", qstring_from_str(auth));
 222         add_channel_info(client, info);
 223         channel_list_add(info);
 224     }
 225     if (event == SPICE_CHANNEL_EVENT_DISCONNECTED) {
 226         channel_list_del(info);
 227     }
 228
 229     data = qobject_from_jsonf("{ 'client': %p, 'server': %p }",
 230                               QOBJECT(client), QOBJECT(server));
 231     monitor_protocol_event(qevent[event], data);
 232     qobject_decref(data);
 233 }
 234
 235 #else /* SPICE_INTERFACE_CORE_MINOR >= 3 */
 236
 237 static QList *channel_list_get(void)
 238 {
 239     return NULL;
 240 }
 241
 242 #endif /* SPICE_INTERFACE_CORE_MINOR >= 3 */
 243
 244 static SpiceCoreInterface core_interface = {
 245     .base.type          = SPICE_INTERFACE_CORE,
 246     .base.description   = "qemu core services",
 247     .base.major_version = SPICE_INTERFACE_CORE_MAJOR,
 248     .base.minor_version = SPICE_INTERFACE_CORE_MINOR,
 249
 250     .timer_add          = timer_add,
 251     .timer_start        = timer_start,
 252     .timer_cancel       = timer_cancel,
 253     .timer_remove       = timer_remove,
 254
 255     .watch_add          = watch_add,
 256     .watch_update_mask  = watch_update_mask,
 257     .watch_remove       = watch_remove,
 258
 259 #if SPICE_INTERFACE_CORE_MINOR >= 3
 260     .channel_event      = channel_event,
 261 #endif
 262 };
 263
 264 /* config string parsing */
 265
 266 static int name2enum(const char *string, const char *table[], int entries)
 267 {
 268     int i;
 269
 270     if (string) {
 271         for (i = 0; i < entries; i++) {
 272             if (!table[i]) {
 273                 continue;
 274             }
 275             if (strcmp(string, table[i]) != 0) {
 276                 continue;
 277             }
 278             return i;
 279         }
 280     }
 281     return -1;
 282 }
 283
 284 static int parse_name(const char *string, const char *optname,
 285                       const char *table[], int entries)
 286 {
 287     int value = name2enum(string, table, entries);
 288
 289     if (value != -1) {
 290         return value;
 291     }
 292     fprintf(stderr, "spice: invalid %s: %s\n", optname, string);
 293     exit(1);
 294 }
 295
 296 #if SPICE_SERVER_VERSION >= 0x000600 /* 0.6.0 */
 297
 298 static const char *stream_video_names[] = {
 299     [ SPICE_STREAM_VIDEO_OFF ]    = "off",
 300     [ SPICE_STREAM_VIDEO_ALL ]    = "all",
 301     [ SPICE_STREAM_VIDEO_FILTER ] = "filter",
 302 };
 303 #define parse_stream_video(_name) \
 304     name2enum(_name, stream_video_names, ARRAY_SIZE(stream_video_names))
 305
 306 #endif /* >= 0.6.0 */
 307
 308 static const char *compression_names[] = {
 309     [ SPICE_IMAGE_COMPRESS_OFF ]      = "off",
 310     [ SPICE_IMAGE_COMPRESS_AUTO_GLZ ] = "auto_glz",
 311     [ SPICE_IMAGE_COMPRESS_AUTO_LZ ]  = "auto_lz",
 312     [ SPICE_IMAGE_COMPRESS_QUIC ]     = "quic",
 313     [ SPICE_IMAGE_COMPRESS_GLZ ]      = "glz",
 314     [ SPICE_IMAGE_COMPRESS_LZ ]       = "lz",
 315 };
 316 #define parse_compression(_name)                                        \
 317     parse_name(_name, "image compression",                              \
 318                compression_names, ARRAY_SIZE(compression_names))
 319
 320 static const char *wan_compression_names[] = {
 321     [ SPICE_WAN_COMPRESSION_AUTO   ] = "auto",
 322     [ SPICE_WAN_COMPRESSION_NEVER  ] = "never",
 323     [ SPICE_WAN_COMPRESSION_ALWAYS ] = "always",
 324 };
 325 #define parse_wan_compression(_name)                                    \
 326     parse_name(_name, "wan compression",                                \
 327                wan_compression_names, ARRAY_SIZE(wan_compression_names))
 328
 329 /* functions for the rest of qemu */
 330
 331 static void info_spice_iter(QObject *obj, void *opaque)
 332 {
 333     QDict *client;
 334     Monitor *mon = opaque;
 335
 336     client = qobject_to_qdict(obj);
 337     monitor_printf(mon, "Channel:\n");
 338     monitor_printf(mon, "     address: %s:%s%s\n",
 339                    qdict_get_str(client, "host"),
 340                    qdict_get_str(client, "port"),
 341                    qdict_get_bool(client, "tls") ? " [tls]" : "");
 342     monitor_printf(mon, "     session: %" PRId64 "\n",
 343                    qdict_get_int(client, "connection-id"));
 344     monitor_printf(mon, "     channel: %d:%d\n",
 345                    (int)qdict_get_int(client, "channel-type"),
 346                    (int)qdict_get_int(client, "channel-id"));
 347 }
 348
 349 void do_info_spice_print(Monitor *mon, const QObject *data)
 350 {
 351     QDict *server;
 352     QList *channels;
 353     const char *host;
 354     int port;
 355
 356     server = qobject_to_qdict(data);
 357     if (qdict_get_bool(server, "enabled") == 0) {
 358         monitor_printf(mon, "Server: disabled\n");
 359         return;
 360     }
 361
 362     monitor_printf(mon, "Server:\n");
 363     host = qdict_get_str(server, "host");
 364     port = qdict_get_try_int(server, "port", -1);
 365     if (port != -1) {
 366         monitor_printf(mon, "     address: %s:%d\n", host, port);
 367     }
 368     port = qdict_get_try_int(server, "tls-port", -1);
 369     if (port != -1) {
 370         monitor_printf(mon, "     address: %s:%d [tls]\n", host, port);
 371     }
 372     monitor_printf(mon, "        auth: %s\n", qdict_get_str(server, "auth"));
 373
 374     channels = qdict_get_qlist(server, "channels");
 375     if (qlist_empty(channels)) {
 376         monitor_printf(mon, "Channels: none\n");
 377     } else {
 378         qlist_iter(channels, info_spice_iter, mon);
 379     }
 380 }
 381
 382 void do_info_spice(Monitor *mon, QObject **ret_data)
 383 {
 384     QemuOpts *opts = QTAILQ_FIRST(&qemu_spice_opts.head);
 385     QDict *server;
 386     QList *clist;
 387     const char *addr;
 388     int port, tls_port;
 389
 390     if (!spice_server) {
 391         *ret_data = qobject_from_jsonf("{ 'enabled': false }");
 392         return;
 393     }
 394
 395     addr = qemu_opt_get(opts, "addr");
 396     port = qemu_opt_get_number(opts, "port", 0);
 397     tls_port = qemu_opt_get_number(opts, "tls-port", 0);
 398     clist = channel_list_get();
 399
 400     server = qdict_new();
 401     qdict_put(server, "enabled", qbool_from_int(true));
 402     qdict_put(server, "auth", qstring_from_str(auth));
 403     qdict_put(server, "host", qstring_from_str(addr ? addr : "0.0.0.0"));
 404     if (port) {
 405         qdict_put(server, "port", qint_from_int(port));
 406     }
 407     if (tls_port) {
 408         qdict_put(server, "tls-port", qint_from_int(tls_port));
 409     }
 410     if (clist) {
 411         qdict_put(server, "channels", clist);
 412     }
 413
 414     *ret_data = QOBJECT(server);
 415 }
 416
 417 static int add_channel(const char *name, const char *value, void *opaque)
 418 {
 419     int security = 0;
 420     int rc;
 421
 422     if (strcmp(name, "tls-channel") == 0) {
 423         security = SPICE_CHANNEL_SECURITY_SSL;
 424     }
 425     if (strcmp(name, "plaintext-channel") == 0) {
 426         security = SPICE_CHANNEL_SECURITY_NONE;
 427     }
 428     if (security == 0) {
 429         return 0;
 430     }
 431     if (strcmp(value, "default") == 0) {
 432         rc = spice_server_set_channel_security(spice_server, NULL, security);
 433     } else {
 434         rc = spice_server_set_channel_security(spice_server, value, security);
 435     }
 436     if (rc != 0) {
 437         fprintf(stderr, "spice: failed to set channel security for %s\n", value);
 438         exit(1);
 439     }
 440     return 0;
 441 }
 442
 443 void qemu_spice_init(void)
 444 {
 445     QemuOpts *opts = QTAILQ_FIRST(&qemu_spice_opts.head);
 446     const char *password, *str, *x509_dir, *addr,
 447         *x509_key_password = NULL,
 448         *x509_dh_file = NULL,
 449         *tls_ciphers = NULL;
 450     char *x509_key_file = NULL,
 451         *x509_cert_file = NULL,
 452         *x509_cacert_file = NULL;
 453     int port, tls_port, len, addr_flags;
 454     spice_image_compression_t compression;
 455     spice_wan_compression_t wan_compr;
 456
 457     if (!opts) {
 458         return;
 459     }
 460     port = qemu_opt_get_number(opts, "port", 0);
 461     tls_port = qemu_opt_get_number(opts, "tls-port", 0);
 462     if (!port && !tls_port) {
 463         return;
 464     }
 465     password = qemu_opt_get(opts, "password");
 466
 467     if (tls_port) {
 468         x509_dir = qemu_opt_get(opts, "x509-dir");
 469         if (NULL == x509_dir) {
 470             x509_dir = ".";
 471         }
 472         len = strlen(x509_dir) + 32;
 473
 474         str = qemu_opt_get(opts, "x509-key-file");
 475         if (str) {
 476             x509_key_file = qemu_strdup(str);
 477         } else {
 478             x509_key_file = qemu_malloc(len);
 479             snprintf(x509_key_file, len, "%s/%s", x509_dir, X509_SERVER_KEY_FILE);
 480         }
 481
 482         str = qemu_opt_get(opts, "x509-cert-file");
 483         if (str) {
 484             x509_cert_file = qemu_strdup(str);
 485         } else {
 486             x509_cert_file = qemu_malloc(len);
 487             snprintf(x509_cert_file, len, "%s/%s", x509_dir, X509_SERVER_CERT_FILE);
 488         }
 489
 490         str = qemu_opt_get(opts, "x509-cacert-file");
 491         if (str) {
 492             x509_cacert_file = qemu_strdup(str);
 493         } else {
 494             x509_cacert_file = qemu_malloc(len);
 495             snprintf(x509_cacert_file, len, "%s/%s", x509_dir, X509_CA_CERT_FILE);
 496         }
 497
 498         x509_key_password = qemu_opt_get(opts, "x509-key-password");
 499         x509_dh_file = qemu_opt_get(opts, "x509-dh-file");
 500         tls_ciphers = qemu_opt_get(opts, "tls-ciphers");
 501     }
 502
 503     addr = qemu_opt_get(opts, "addr");
 504     addr_flags = 0;
 505     if (qemu_opt_get_bool(opts, "ipv4", 0)) {
 506         addr_flags |= SPICE_ADDR_FLAG_IPV4_ONLY;
 507     } else if (qemu_opt_get_bool(opts, "ipv6", 0)) {
 508         addr_flags |= SPICE_ADDR_FLAG_IPV6_ONLY;
 509     }
 510
 511     spice_server = spice_server_new();
 512     spice_server_set_addr(spice_server, addr ? addr : "", addr_flags);
 513     if (port) {
 514         spice_server_set_port(spice_server, port);
 515     }
 516     if (tls_port) {
 517         spice_server_set_tls(spice_server, tls_port,
 518                              x509_cacert_file,
 519                              x509_cert_file,
 520                              x509_key_file,
 521                              x509_key_password,
 522                              x509_dh_file,
 523                              tls_ciphers);
 524     }
 525     if (password) {
 526         spice_server_set_ticket(spice_server, password, 0, 0, 0);
 527     }
 528     if (qemu_opt_get_bool(opts, "disable-ticketing", 0)) {
 529         auth = "none";
 530         spice_server_set_noauth(spice_server);
 531     }
 532
 533     compression = SPICE_IMAGE_COMPRESS_AUTO_GLZ;
 534     str = qemu_opt_get(opts, "image-compression");
 535     if (str) {
 536         compression = parse_compression(str);
 537     }
 538     spice_server_set_image_compression(spice_server, compression);
 539
 540     wan_compr = SPICE_WAN_COMPRESSION_AUTO;
 541     str = qemu_opt_get(opts, "jpeg-wan-compression");
 542     if (str) {
 543         wan_compr = parse_wan_compression(str);
 544     }
 545     spice_server_set_jpeg_compression(spice_server, wan_compr);
 546
 547     wan_compr = SPICE_WAN_COMPRESSION_AUTO;
 548     str = qemu_opt_get(opts, "zlib-glz-wan-compression");
 549     if (str) {
 550         wan_compr = parse_wan_compression(str);
 551     }
 552     spice_server_set_zlib_glz_compression(spice_server, wan_compr);
 553
 554 #if SPICE_SERVER_VERSION >= 0x000600 /* 0.6.0 */
 555
 556     str = qemu_opt_get(opts, "streaming-video");
 557     if (str) {
 558         int streaming_video = parse_stream_video(str);
 559         spice_server_set_streaming_video(spice_server, streaming_video);
 560     }
 561
 562     spice_server_set_agent_mouse
 563         (spice_server, qemu_opt_get_bool(opts, "agent-mouse", 1));
 564     spice_server_set_playback_compression
 565         (spice_server, qemu_opt_get_bool(opts, "playback-compression", 1));
 566
 567 #endif /* >= 0.6.0 */
 568
 569     qemu_opt_foreach(opts, add_channel, NULL, 0);
 570
 571     spice_server_init(spice_server, &core_interface);
 572     using_spice = 1;
 573
 574     qemu_spice_input_init();
 575     qemu_spice_audio_init();
 576
 577     qemu_free(x509_key_file);
 578     qemu_free(x509_cert_file);
 579     qemu_free(x509_cacert_file);
 580 }
 581
 582 int qemu_spice_add_interface(SpiceBaseInstance *sin)
 583 {
 584     if (!spice_server) {
 585         if (QTAILQ_FIRST(&qemu_spice_opts.head) != NULL) {
 586             fprintf(stderr, "Oops: spice configured but not active\n");
 587             exit(1);
 588         }
 589         /*
 590          * Create a spice server instance.
 591          * It does *not* listen on the network.
 592          * It handles QXL local rendering only.
 593          *
 594          * With a command line like '-vnc :0 -vga qxl' you'll end up here.
 595          */
 596         spice_server = spice_server_new();
 597         spice_server_init(spice_server, &core_interface);
 598     }
 599     return spice_server_add_interface(spice_server, sin);
 600 }
 601
 602 static void spice_register_config(void)
 603 {
 604     qemu_add_opts(&qemu_spice_opts);
 605 }
 606 machine_init(spice_register_config);
 607
 608 static void spice_initialize(void)
 609 {
 610     qemu_spice_init();
 611 }
 612 device_init(spice_initialize);