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 "qemu/osdep.h"
  19 #include <spice.h>
  20
  21 #include "sysemu/sysemu.h"
  22 #include "sysemu/runstate.h"
  23 #include "ui/qemu-spice.h"
  24 #include "qemu/error-report.h"
  25 #include "qemu/main-loop.h"
  26 #include "qemu/module.h"
  27 #include "qemu/thread.h"
  28 #include "qemu/timer.h"
  29 #include "qemu/queue.h"
  30 #include "qemu-x509.h"
  31 #include "qemu/sockets.h"
  32 #include "qapi/error.h"
  33 #include "qapi/qapi-commands-ui.h"
  34 #include "qapi/qapi-events-ui.h"
  35 #include "qemu/notify.h"
  36 #include "qemu/option.h"
  37 #include "crypto/secret_common.h"
  38 #include "migration/misc.h"
  39 #include "hw/pci/pci_bus.h"
  40 #include "ui/spice-display.h"
  41
  42 /* core bits */
  43
  44 static SpiceServer *spice_server;
  45 static Notifier migration_state;
  46 static const char *auth = "spice";
  47 static char *auth_passwd;
  48 static time_t auth_expires = TIME_MAX;
  49 static int spice_migration_completed;
  50 static int spice_display_is_running;
  51 static int spice_have_target_host;
  52
  53 static QemuThread me;
  54
  55 struct SpiceTimer {
  56     QEMUTimer *timer;
  57 };
  58
  59 static SpiceTimer *timer_add(SpiceTimerFunc func, void *opaque)
  60 {
  61     SpiceTimer *timer;
  62
  63     timer = g_malloc0(sizeof(*timer));
  64     timer->timer = timer_new_ms(QEMU_CLOCK_REALTIME, func, opaque);
  65     return timer;
  66 }
  67
  68 static void timer_start(SpiceTimer *timer, uint32_t ms)
  69 {
  70     timer_mod(timer->timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + ms);
  71 }
  72
  73 static void timer_cancel(SpiceTimer *timer)
  74 {
  75     timer_del(timer->timer);
  76 }
  77
  78 static void timer_remove(SpiceTimer *timer)
  79 {
  80     timer_free(timer->timer);
  81     g_free(timer);
  82 }
  83
  84 struct SpiceWatch {
  85     int fd;
  86     SpiceWatchFunc func;
  87     void *opaque;
  88 };
  89
  90 static void watch_read(void *opaque)
  91 {
  92     SpiceWatch *watch = opaque;
  93     watch->func(watch->fd, SPICE_WATCH_EVENT_READ, watch->opaque);
  94 }
  95
  96 static void watch_write(void *opaque)
  97 {
  98     SpiceWatch *watch = opaque;
  99     watch->func(watch->fd, SPICE_WATCH_EVENT_WRITE, watch->opaque);
 100 }
 101
 102 static void watch_update_mask(SpiceWatch *watch, int event_mask)
 103 {
 104     IOHandler *on_read = NULL;
 105     IOHandler *on_write = NULL;
 106
 107     if (event_mask & SPICE_WATCH_EVENT_READ) {
 108         on_read = watch_read;
 109     }
 110     if (event_mask & SPICE_WATCH_EVENT_WRITE) {
 111         on_write = watch_write;
 112     }
 113     qemu_set_fd_handler(watch->fd, on_read, on_write, watch);
 114 }
 115
 116 static SpiceWatch *watch_add(int fd, int event_mask, SpiceWatchFunc func, void *opaque)
 117 {
 118     SpiceWatch *watch;
 119
 120     watch = g_malloc0(sizeof(*watch));
 121     watch->fd     = fd;
 122     watch->func   = func;
 123     watch->opaque = opaque;
 124
 125     watch_update_mask(watch, event_mask);
 126     return watch;
 127 }
 128
 129 static void watch_remove(SpiceWatch *watch)
 130 {
 131     qemu_set_fd_handler(watch->fd, NULL, NULL, NULL);
 132     g_free(watch);
 133 }
 134
 135 typedef struct ChannelList ChannelList;
 136 struct ChannelList {
 137     SpiceChannelEventInfo *info;
 138     QTAILQ_ENTRY(ChannelList) link;
 139 };
 140 static QTAILQ_HEAD(, ChannelList) channel_list = QTAILQ_HEAD_INITIALIZER(channel_list);
 141
 142 static void channel_list_add(SpiceChannelEventInfo *info)
 143 {
 144     ChannelList *item;
 145
 146     item = g_malloc0(sizeof(*item));
 147     item->info = info;
 148     QTAILQ_INSERT_TAIL(&channel_list, item, link);
 149 }
 150
 151 static void channel_list_del(SpiceChannelEventInfo *info)
 152 {
 153     ChannelList *item;
 154
 155     QTAILQ_FOREACH(item, &channel_list, link) {
 156         if (item->info != info) {
 157             continue;
 158         }
 159         QTAILQ_REMOVE(&channel_list, item, link);
 160         g_free(item);
 161         return;
 162     }
 163 }
 164
 165 static void add_addr_info(SpiceBasicInfo *info, struct sockaddr *addr, int len)
 166 {
 167     char host[NI_MAXHOST], port[NI_MAXSERV];
 168
 169     getnameinfo(addr, len, host, sizeof(host), port, sizeof(port),
 170                 NI_NUMERICHOST | NI_NUMERICSERV);
 171
 172     info->host = g_strdup(host);
 173     info->port = g_strdup(port);
 174     info->family = inet_netfamily(addr->sa_family);
 175 }
 176
 177 static void add_channel_info(SpiceChannel *sc, SpiceChannelEventInfo *info)
 178 {
 179     int tls = info->flags & SPICE_CHANNEL_EVENT_FLAG_TLS;
 180
 181     sc->connection_id = info->connection_id;
 182     sc->channel_type = info->type;
 183     sc->channel_id = info->id;
 184     sc->tls = !!tls;
 185 }
 186
 187 static void channel_event(int event, SpiceChannelEventInfo *info)
 188 {
 189     SpiceServerInfo *server = g_malloc0(sizeof(*server));
 190     SpiceChannel *client = g_malloc0(sizeof(*client));
 191
 192     /*
 193      * Spice server might have called us from spice worker thread
 194      * context (happens on display channel disconnects).  Spice should
 195      * not do that.  It isn't that easy to fix it in spice and even
 196      * when it is fixed we still should cover the already released
 197      * spice versions.  So detect that we've been called from another
 198      * thread and grab the iothread lock if so before calling qemu
 199      * functions.
 200      */
 201     bool need_lock = !qemu_thread_is_self(&me);
 202     if (need_lock) {
 203         qemu_mutex_lock_iothread();
 204     }
 205
 206     if (info->flags & SPICE_CHANNEL_EVENT_FLAG_ADDR_EXT) {
 207         add_addr_info(qapi_SpiceChannel_base(client),
 208                       (struct sockaddr *)&info->paddr_ext,
 209                       info->plen_ext);
 210         add_addr_info(qapi_SpiceServerInfo_base(server),
 211                       (struct sockaddr *)&info->laddr_ext,
 212                       info->llen_ext);
 213     } else {
 214         error_report("spice: %s, extended address is expected",
 215                      __func__);
 216     }
 217
 218     switch (event) {
 219     case SPICE_CHANNEL_EVENT_CONNECTED:
 220         qapi_event_send_spice_connected(qapi_SpiceServerInfo_base(server),
 221                                         qapi_SpiceChannel_base(client));
 222         break;
 223     case SPICE_CHANNEL_EVENT_INITIALIZED:
 224         if (auth) {
 225             server->has_auth = true;
 226             server->auth = g_strdup(auth);
 227         }
 228         add_channel_info(client, info);
 229         channel_list_add(info);
 230         qapi_event_send_spice_initialized(server, client);
 231         break;
 232     case SPICE_CHANNEL_EVENT_DISCONNECTED:
 233         channel_list_del(info);
 234         qapi_event_send_spice_disconnected(qapi_SpiceServerInfo_base(server),
 235                                            qapi_SpiceChannel_base(client));
 236         break;
 237     default:
 238         break;
 239     }
 240
 241     if (need_lock) {
 242         qemu_mutex_unlock_iothread();
 243     }
 244
 245     qapi_free_SpiceServerInfo(server);
 246     qapi_free_SpiceChannel(client);
 247 }
 248
 249 static SpiceCoreInterface core_interface = {
 250     .base.type          = SPICE_INTERFACE_CORE,
 251     .base.description   = "qemu core services",
 252     .base.major_version = SPICE_INTERFACE_CORE_MAJOR,
 253     .base.minor_version = SPICE_INTERFACE_CORE_MINOR,
 254
 255     .timer_add          = timer_add,
 256     .timer_start        = timer_start,
 257     .timer_cancel       = timer_cancel,
 258     .timer_remove       = timer_remove,
 259
 260     .watch_add          = watch_add,
 261     .watch_update_mask  = watch_update_mask,
 262     .watch_remove       = watch_remove,
 263
 264     .channel_event      = channel_event,
 265 };
 266
 267 static void migrate_connect_complete_cb(SpiceMigrateInstance *sin);
 268 static void migrate_end_complete_cb(SpiceMigrateInstance *sin);
 269
 270 static const SpiceMigrateInterface migrate_interface = {
 271     .base.type = SPICE_INTERFACE_MIGRATION,
 272     .base.description = "migration",
 273     .base.major_version = SPICE_INTERFACE_MIGRATION_MAJOR,
 274     .base.minor_version = SPICE_INTERFACE_MIGRATION_MINOR,
 275     .migrate_connect_complete = migrate_connect_complete_cb,
 276     .migrate_end_complete = migrate_end_complete_cb,
 277 };
 278
 279 static SpiceMigrateInstance spice_migrate;
 280
 281 static void migrate_connect_complete_cb(SpiceMigrateInstance *sin)
 282 {
 283     /* nothing, but libspice-server expects this cb being present. */
 284 }
 285
 286 static void migrate_end_complete_cb(SpiceMigrateInstance *sin)
 287 {
 288     qapi_event_send_spice_migrate_completed();
 289     spice_migration_completed = true;
 290 }
 291
 292 /* config string parsing */
 293
 294 static int name2enum(const char *string, const char *table[], int entries)
 295 {
 296     int i;
 297
 298     if (string) {
 299         for (i = 0; i < entries; i++) {
 300             if (!table[i]) {
 301                 continue;
 302             }
 303             if (strcmp(string, table[i]) != 0) {
 304                 continue;
 305             }
 306             return i;
 307         }
 308     }
 309     return -1;
 310 }
 311
 312 static int parse_name(const char *string, const char *optname,
 313                       const char *table[], int entries)
 314 {
 315     int value = name2enum(string, table, entries);
 316
 317     if (value != -1) {
 318         return value;
 319     }
 320     error_report("spice: invalid %s: %s", optname, string);
 321     exit(1);
 322 }
 323
 324 static const char *stream_video_names[] = {
 325     [ SPICE_STREAM_VIDEO_OFF ]    = "off",
 326     [ SPICE_STREAM_VIDEO_ALL ]    = "all",
 327     [ SPICE_STREAM_VIDEO_FILTER ] = "filter",
 328 };
 329 #define parse_stream_video(_name) \
 330     parse_name(_name, "stream video control", \
 331                stream_video_names, ARRAY_SIZE(stream_video_names))
 332
 333 static const char *compression_names[] = {
 334     [ SPICE_IMAGE_COMPRESS_OFF ]      = "off",
 335     [ SPICE_IMAGE_COMPRESS_AUTO_GLZ ] = "auto_glz",
 336     [ SPICE_IMAGE_COMPRESS_AUTO_LZ ]  = "auto_lz",
 337     [ SPICE_IMAGE_COMPRESS_QUIC ]     = "quic",
 338     [ SPICE_IMAGE_COMPRESS_GLZ ]      = "glz",
 339     [ SPICE_IMAGE_COMPRESS_LZ ]       = "lz",
 340 };
 341 #define parse_compression(_name)                                        \
 342     parse_name(_name, "image compression",                              \
 343                compression_names, ARRAY_SIZE(compression_names))
 344
 345 static const char *wan_compression_names[] = {
 346     [ SPICE_WAN_COMPRESSION_AUTO   ] = "auto",
 347     [ SPICE_WAN_COMPRESSION_NEVER  ] = "never",
 348     [ SPICE_WAN_COMPRESSION_ALWAYS ] = "always",
 349 };
 350 #define parse_wan_compression(_name)                                    \
 351     parse_name(_name, "wan compression",                                \
 352                wan_compression_names, ARRAY_SIZE(wan_compression_names))
 353
 354 /* functions for the rest of qemu */
 355
 356 static SpiceChannelList *qmp_query_spice_channels(void)
 357 {
 358     SpiceChannelList *head = NULL, **tail = &head;
 359     ChannelList *item;
 360
 361     QTAILQ_FOREACH(item, &channel_list, link) {
 362         SpiceChannel *chan;
 363         char host[NI_MAXHOST], port[NI_MAXSERV];
 364         struct sockaddr *paddr;
 365         socklen_t plen;
 366
 367         assert(item->info->flags & SPICE_CHANNEL_EVENT_FLAG_ADDR_EXT);
 368
 369         chan = g_malloc0(sizeof(*chan));
 370
 371         paddr = (struct sockaddr *)&item->info->paddr_ext;
 372         plen = item->info->plen_ext;
 373         getnameinfo(paddr, plen,
 374                     host, sizeof(host), port, sizeof(port),
 375                     NI_NUMERICHOST | NI_NUMERICSERV);
 376         chan->host = g_strdup(host);
 377         chan->port = g_strdup(port);
 378         chan->family = inet_netfamily(paddr->sa_family);
 379
 380         chan->connection_id = item->info->connection_id;
 381         chan->channel_type = item->info->type;
 382         chan->channel_id = item->info->id;
 383         chan->tls = item->info->flags & SPICE_CHANNEL_EVENT_FLAG_TLS;
 384
 385         QAPI_LIST_APPEND(tail, chan);
 386     }
 387
 388     return head;
 389 }
 390
 391 static QemuOptsList qemu_spice_opts = {
 392     .name = "spice",
 393     .head = QTAILQ_HEAD_INITIALIZER(qemu_spice_opts.head),
 394     .merge_lists = true,
 395     .desc = {
 396         {
 397             .name = "port",
 398             .type = QEMU_OPT_NUMBER,
 399         },{
 400             .name = "tls-port",
 401             .type = QEMU_OPT_NUMBER,
 402         },{
 403             .name = "addr",
 404             .type = QEMU_OPT_STRING,
 405         },{
 406             .name = "ipv4",
 407             .type = QEMU_OPT_BOOL,
 408         },{
 409             .name = "ipv6",
 410             .type = QEMU_OPT_BOOL,
 411 #ifdef SPICE_ADDR_FLAG_UNIX_ONLY
 412         },{
 413             .name = "unix",
 414             .type = QEMU_OPT_BOOL,
 415 #endif
 416         },{
 417             .name = "password",
 418             .type = QEMU_OPT_STRING,
 419         },{
 420             .name = "password-secret",
 421             .type = QEMU_OPT_STRING,
 422         },{
 423             .name = "disable-ticketing",
 424             .type = QEMU_OPT_BOOL,
 425         },{
 426             .name = "disable-copy-paste",
 427             .type = QEMU_OPT_BOOL,
 428         },{
 429             .name = "disable-agent-file-xfer",
 430             .type = QEMU_OPT_BOOL,
 431         },{
 432             .name = "sasl",
 433             .type = QEMU_OPT_BOOL,
 434         },{
 435             .name = "x509-dir",
 436             .type = QEMU_OPT_STRING,
 437         },{
 438             .name = "x509-key-file",
 439             .type = QEMU_OPT_STRING,
 440         },{
 441             .name = "x509-key-password",
 442             .type = QEMU_OPT_STRING,
 443         },{
 444             .name = "x509-cert-file",
 445             .type = QEMU_OPT_STRING,
 446         },{
 447             .name = "x509-cacert-file",
 448             .type = QEMU_OPT_STRING,
 449         },{
 450             .name = "x509-dh-key-file",
 451             .type = QEMU_OPT_STRING,
 452         },{
 453             .name = "tls-ciphers",
 454             .type = QEMU_OPT_STRING,
 455         },{
 456             .name = "tls-channel",
 457             .type = QEMU_OPT_STRING,
 458         },{
 459             .name = "plaintext-channel",
 460             .type = QEMU_OPT_STRING,
 461         },{
 462             .name = "image-compression",
 463             .type = QEMU_OPT_STRING,
 464         },{
 465             .name = "jpeg-wan-compression",
 466             .type = QEMU_OPT_STRING,
 467         },{
 468             .name = "zlib-glz-wan-compression",
 469             .type = QEMU_OPT_STRING,
 470         },{
 471             .name = "streaming-video",
 472             .type = QEMU_OPT_STRING,
 473         },{
 474             .name = "agent-mouse",
 475             .type = QEMU_OPT_BOOL,
 476         },{
 477             .name = "playback-compression",
 478             .type = QEMU_OPT_BOOL,
 479         },{
 480             .name = "seamless-migration",
 481             .type = QEMU_OPT_BOOL,
 482         },{
 483             .name = "display",
 484             .type = QEMU_OPT_STRING,
 485         },{
 486             .name = "head",
 487             .type = QEMU_OPT_NUMBER,
 488 #ifdef HAVE_SPICE_GL
 489         },{
 490             .name = "gl",
 491             .type = QEMU_OPT_BOOL,
 492         },{
 493             .name = "rendernode",
 494             .type = QEMU_OPT_STRING,
 495 #endif
 496         },
 497         { /* end of list */ }
 498     },
 499 };
 500
 501 static SpiceInfo *qmp_query_spice_real(Error **errp)
 502 {
 503     QemuOpts *opts = QTAILQ_FIRST(&qemu_spice_opts.head);
 504     int port, tls_port;
 505     const char *addr;
 506     SpiceInfo *info;
 507     unsigned int major;
 508     unsigned int minor;
 509     unsigned int micro;
 510
 511     info = g_malloc0(sizeof(*info));
 512
 513     if (!spice_server || !opts) {
 514         info->enabled = false;
 515         return info;
 516     }
 517
 518     info->enabled = true;
 519     info->migrated = spice_migration_completed;
 520
 521     addr = qemu_opt_get(opts, "addr");
 522     port = qemu_opt_get_number(opts, "port", 0);
 523     tls_port = qemu_opt_get_number(opts, "tls-port", 0);
 524
 525     info->has_auth = true;
 526     info->auth = g_strdup(auth);
 527
 528     info->has_host = true;
 529     info->host = g_strdup(addr ? addr : "*");
 530
 531     info->has_compiled_version = true;
 532     major = (SPICE_SERVER_VERSION & 0xff0000) >> 16;
 533     minor = (SPICE_SERVER_VERSION & 0xff00) >> 8;
 534     micro = SPICE_SERVER_VERSION & 0xff;
 535     info->compiled_version = g_strdup_printf("%d.%d.%d", major, minor, micro);
 536
 537     if (port) {
 538         info->has_port = true;
 539         info->port = port;
 540     }
 541     if (tls_port) {
 542         info->has_tls_port = true;
 543         info->tls_port = tls_port;
 544     }
 545
 546     info->mouse_mode = spice_server_is_server_mouse(spice_server) ?
 547                        SPICE_QUERY_MOUSE_MODE_SERVER :
 548                        SPICE_QUERY_MOUSE_MODE_CLIENT;
 549
 550     /* for compatibility with the original command */
 551     info->has_channels = true;
 552     info->channels = qmp_query_spice_channels();
 553
 554     return info;
 555 }
 556
 557 static void migration_state_notifier(Notifier *notifier, void *data)
 558 {
 559     MigrationState *s = data;
 560
 561     if (!spice_have_target_host) {
 562         return;
 563     }
 564
 565     if (migration_in_setup(s)) {
 566         spice_server_migrate_start(spice_server);
 567     } else if (migration_has_finished(s) ||
 568                migration_in_postcopy_after_devices(s)) {
 569         spice_server_migrate_end(spice_server, true);
 570         spice_have_target_host = false;
 571     } else if (migration_has_failed(s)) {
 572         spice_server_migrate_end(spice_server, false);
 573         spice_have_target_host = false;
 574     }
 575 }
 576
 577 int qemu_spice_migrate_info(const char *hostname, int port, int tls_port,
 578                             const char *subject)
 579 {
 580     int ret;
 581
 582     ret = spice_server_migrate_connect(spice_server, hostname,
 583                                        port, tls_port, subject);
 584     spice_have_target_host = true;
 585     return ret;
 586 }
 587
 588 static int add_channel(void *opaque, const char *name, const char *value,
 589                        Error **errp)
 590 {
 591     int security = 0;
 592     int rc;
 593
 594     if (strcmp(name, "tls-channel") == 0) {
 595         int *tls_port = opaque;
 596         if (!*tls_port) {
 597             error_setg(errp, "spice: tried to setup tls-channel"
 598                        " without specifying a TLS port");
 599             return -1;
 600         }
 601         security = SPICE_CHANNEL_SECURITY_SSL;
 602     }
 603     if (strcmp(name, "plaintext-channel") == 0) {
 604         security = SPICE_CHANNEL_SECURITY_NONE;
 605     }
 606     if (security == 0) {
 607         return 0;
 608     }
 609     if (strcmp(value, "default") == 0) {
 610         rc = spice_server_set_channel_security(spice_server, NULL, security);
 611     } else {
 612         rc = spice_server_set_channel_security(spice_server, value, security);
 613     }
 614     if (rc != 0) {
 615         error_setg(errp, "spice: failed to set channel security for %s",
 616                    value);
 617         return -1;
 618     }
 619     return 0;
 620 }
 621
 622 static void vm_change_state_handler(void *opaque, bool running,
 623                                     RunState state)
 624 {
 625     if (running) {
 626         qemu_spice_display_start();
 627     } else if (state != RUN_STATE_PAUSED) {
 628         qemu_spice_display_stop();
 629     }
 630 }
 631
 632 void qemu_spice_display_init_done(void)
 633 {
 634     if (runstate_is_running()) {
 635         qemu_spice_display_start();
 636     }
 637     qemu_add_vm_change_state_handler(vm_change_state_handler, NULL);
 638 }
 639
 640 static void qemu_spice_init(void)
 641 {
 642     QemuOpts *opts = QTAILQ_FIRST(&qemu_spice_opts.head);
 643     char *password = NULL;
 644     const char *passwordSecret;
 645     const char *str, *x509_dir, *addr,
 646         *x509_key_password = NULL,
 647         *x509_dh_file = NULL,
 648         *tls_ciphers = NULL;
 649     char *x509_key_file = NULL,
 650         *x509_cert_file = NULL,
 651         *x509_cacert_file = NULL;
 652     int port, tls_port, addr_flags;
 653     spice_image_compression_t compression;
 654     spice_wan_compression_t wan_compr;
 655     bool seamless_migration;
 656
 657     qemu_thread_get_self(&me);
 658
 659     if (!opts) {
 660         return;
 661     }
 662     port = qemu_opt_get_number(opts, "port", 0);
 663     tls_port = qemu_opt_get_number(opts, "tls-port", 0);
 664     if (port < 0 || port > 65535) {
 665         error_report("spice port is out of range");
 666         exit(1);
 667     }
 668     if (tls_port < 0 || tls_port > 65535) {
 669         error_report("spice tls-port is out of range");
 670         exit(1);
 671     }
 672     passwordSecret = qemu_opt_get(opts, "password-secret");
 673     if (passwordSecret) {
 674         if (qemu_opt_get(opts, "password")) {
 675             error_report("'password' option is mutually exclusive with "
 676                          "'password-secret'");
 677             exit(1);
 678         }
 679         password = qcrypto_secret_lookup_as_utf8(passwordSecret,
 680                                                  &error_fatal);
 681     } else {
 682         str = qemu_opt_get(opts, "password");
 683         if (str) {
 684             warn_report("'password' option is deprecated and insecure, "
 685                         "use 'password-secret' instead");
 686             password = g_strdup(str);
 687         }
 688     }
 689
 690     if (tls_port) {
 691         x509_dir = qemu_opt_get(opts, "x509-dir");
 692         if (!x509_dir) {
 693             x509_dir = ".";
 694         }
 695
 696         str = qemu_opt_get(opts, "x509-key-file");
 697         if (str) {
 698             x509_key_file = g_strdup(str);
 699         } else {
 700             x509_key_file = g_strdup_printf("%s/%s", x509_dir,
 701                                             X509_SERVER_KEY_FILE);
 702         }
 703
 704         str = qemu_opt_get(opts, "x509-cert-file");
 705         if (str) {
 706             x509_cert_file = g_strdup(str);
 707         } else {
 708             x509_cert_file = g_strdup_printf("%s/%s", x509_dir,
 709                                              X509_SERVER_CERT_FILE);
 710         }
 711
 712         str = qemu_opt_get(opts, "x509-cacert-file");
 713         if (str) {
 714             x509_cacert_file = g_strdup(str);
 715         } else {
 716             x509_cacert_file = g_strdup_printf("%s/%s", x509_dir,
 717                                                X509_CA_CERT_FILE);
 718         }
 719
 720         x509_key_password = qemu_opt_get(opts, "x509-key-password");
 721         x509_dh_file = qemu_opt_get(opts, "x509-dh-key-file");
 722         tls_ciphers = qemu_opt_get(opts, "tls-ciphers");
 723     }
 724
 725     addr = qemu_opt_get(opts, "addr");
 726     addr_flags = 0;
 727     if (qemu_opt_get_bool(opts, "ipv4", 0)) {
 728         addr_flags |= SPICE_ADDR_FLAG_IPV4_ONLY;
 729     } else if (qemu_opt_get_bool(opts, "ipv6", 0)) {
 730         addr_flags |= SPICE_ADDR_FLAG_IPV6_ONLY;
 731 #ifdef SPICE_ADDR_FLAG_UNIX_ONLY
 732     } else if (qemu_opt_get_bool(opts, "unix", 0)) {
 733         addr_flags |= SPICE_ADDR_FLAG_UNIX_ONLY;
 734 #endif
 735     }
 736
 737     spice_server = spice_server_new();
 738     spice_server_set_addr(spice_server, addr ? addr : "", addr_flags);
 739     if (port) {
 740         spice_server_set_port(spice_server, port);
 741     }
 742     if (tls_port) {
 743         spice_server_set_tls(spice_server, tls_port,
 744                              x509_cacert_file,
 745                              x509_cert_file,
 746                              x509_key_file,
 747                              x509_key_password,
 748                              x509_dh_file,
 749                              tls_ciphers);
 750     }
 751     if (password) {
 752         qemu_spice.set_passwd(password, false, false);
 753     }
 754     if (qemu_opt_get_bool(opts, "sasl", 0)) {
 755         if (spice_server_set_sasl(spice_server, 1) == -1) {
 756             error_report("spice: failed to enable sasl");
 757             exit(1);
 758         }
 759         auth = "sasl";
 760     }
 761     if (qemu_opt_get_bool(opts, "disable-ticketing", 0)) {
 762         auth = "none";
 763         spice_server_set_noauth(spice_server);
 764     }
 765
 766     if (qemu_opt_get_bool(opts, "disable-copy-paste", 0)) {
 767         spice_server_set_agent_copypaste(spice_server, false);
 768     }
 769
 770     if (qemu_opt_get_bool(opts, "disable-agent-file-xfer", 0)) {
 771         spice_server_set_agent_file_xfer(spice_server, false);
 772     }
 773
 774     compression = SPICE_IMAGE_COMPRESS_AUTO_GLZ;
 775     str = qemu_opt_get(opts, "image-compression");
 776     if (str) {
 777         compression = parse_compression(str);
 778     }
 779     spice_server_set_image_compression(spice_server, compression);
 780
 781     wan_compr = SPICE_WAN_COMPRESSION_AUTO;
 782     str = qemu_opt_get(opts, "jpeg-wan-compression");
 783     if (str) {
 784         wan_compr = parse_wan_compression(str);
 785     }
 786     spice_server_set_jpeg_compression(spice_server, wan_compr);
 787
 788     wan_compr = SPICE_WAN_COMPRESSION_AUTO;
 789     str = qemu_opt_get(opts, "zlib-glz-wan-compression");
 790     if (str) {
 791         wan_compr = parse_wan_compression(str);
 792     }
 793     spice_server_set_zlib_glz_compression(spice_server, wan_compr);
 794
 795     str = qemu_opt_get(opts, "streaming-video");
 796     if (str) {
 797         int streaming_video = parse_stream_video(str);
 798         spice_server_set_streaming_video(spice_server, streaming_video);
 799     } else {
 800         spice_server_set_streaming_video(spice_server, SPICE_STREAM_VIDEO_OFF);
 801     }
 802
 803     spice_server_set_agent_mouse
 804         (spice_server, qemu_opt_get_bool(opts, "agent-mouse", 1));
 805     spice_server_set_playback_compression
 806         (spice_server, qemu_opt_get_bool(opts, "playback-compression", 1));
 807
 808     qemu_opt_foreach(opts, add_channel, &tls_port, &error_fatal);
 809
 810     spice_server_set_name(spice_server, qemu_name ?: "QEMU " QEMU_VERSION);
 811     spice_server_set_uuid(spice_server, (unsigned char *)&qemu_uuid);
 812
 813     seamless_migration = qemu_opt_get_bool(opts, "seamless-migration", 0);
 814     spice_server_set_seamless_migration(spice_server, seamless_migration);
 815     spice_server_set_sasl_appname(spice_server, "qemu");
 816     if (spice_server_init(spice_server, &core_interface) != 0) {
 817         error_report("failed to initialize spice server");
 818         exit(1);
 819     };
 820     using_spice = 1;
 821
 822     migration_state.notify = migration_state_notifier;
 823     add_migration_state_change_notifier(&migration_state);
 824     spice_migrate.base.sif = &migrate_interface.base;
 825     qemu_spice.add_interface(&spice_migrate.base);
 826
 827     qemu_spice_input_init();
 828
 829     qemu_spice_display_stop();
 830
 831     g_free(x509_key_file);
 832     g_free(x509_cert_file);
 833     g_free(x509_cacert_file);
 834     g_free(password);
 835
 836 #ifdef HAVE_SPICE_GL
 837     if (qemu_opt_get_bool(opts, "gl", 0)) {
 838         if ((port != 0) || (tls_port != 0)) {
 839             error_report("SPICE GL support is local-only for now and "
 840                          "incompatible with -spice port/tls-port");
 841             exit(1);
 842         }
 843         if (egl_rendernode_init(qemu_opt_get(opts, "rendernode"),
 844                                 DISPLAYGL_MODE_ON) != 0) {
 845             error_report("Failed to initialize EGL render node for SPICE GL");
 846             exit(1);
 847         }
 848         display_opengl = 1;
 849         spice_opengl = 1;
 850     }
 851 #endif
 852 }
 853
 854 static int qemu_spice_add_interface(SpiceBaseInstance *sin)
 855 {
 856     if (!spice_server) {
 857         if (QTAILQ_FIRST(&qemu_spice_opts.head) != NULL) {
 858             error_report("Oops: spice configured but not active");
 859             exit(1);
 860         }
 861         /*
 862          * Create a spice server instance.
 863          * It does *not* listen on the network.
 864          * It handles QXL local rendering only.
 865          *
 866          * With a command line like '-vnc :0 -vga qxl' you'll end up here.
 867          */
 868         spice_server = spice_server_new();
 869         spice_server_set_sasl_appname(spice_server, "qemu");
 870         spice_server_init(spice_server, &core_interface);
 871         qemu_add_vm_change_state_handler(vm_change_state_handler, NULL);
 872     }
 873
 874     return spice_server_add_interface(spice_server, sin);
 875 }
 876
 877 static GSList *spice_consoles;
 878
 879 bool qemu_spice_have_display_interface(QemuConsole *con)
 880 {
 881     if (g_slist_find(spice_consoles, con)) {
 882         return true;
 883     }
 884     return false;
 885 }
 886
 887 /*
 888  * Recursively (in reverse order) appends addresses of PCI devices as it moves
 889  * up in the PCI hierarchy.
 890  *
 891  * @returns true on success, false when the buffer wasn't large enough
 892  */
 893 static bool append_pci_address(char *buf, size_t buf_size, const PCIDevice *pci)
 894 {
 895     PCIBus *bus = pci_get_bus(pci);
 896     /*
 897      * equivalent to if (!pci_bus_is_root(bus)), but the function is not built
 898      * with PCI_CONFIG=n, avoid using an #ifdef by checking directly
 899      */
 900     if (bus->parent_dev != NULL) {
 901         append_pci_address(buf, buf_size, bus->parent_dev);
 902     }
 903
 904     size_t len = strlen(buf);
 905     ssize_t written = snprintf(buf + len, buf_size - len, "/%02x.%x",
 906         PCI_SLOT(pci->devfn), PCI_FUNC(pci->devfn));
 907
 908     return written > 0 && written < buf_size - len;
 909 }
 910
 911 bool qemu_spice_fill_device_address(QemuConsole *con,
 912                                     char *device_address,
 913                                     size_t size)
 914 {
 915     DeviceState *dev = DEVICE(object_property_get_link(OBJECT(con),
 916                                                        "device",
 917                                                        &error_abort));
 918     PCIDevice *pci = (PCIDevice *) object_dynamic_cast(OBJECT(dev),
 919                                                        TYPE_PCI_DEVICE);
 920
 921     if (pci == NULL) {
 922         warn_report("Setting device address of a display device to SPICE: "
 923                     "Not a PCI device.");
 924         return false;
 925     }
 926
 927     strncpy(device_address, "pci/0000", size);
 928     if (!append_pci_address(device_address, size, pci)) {
 929         warn_report("Setting device address of a display device to SPICE: "
 930             "Too many PCI devices in the chain.");
 931         return false;
 932     }
 933
 934     return true;
 935 }
 936
 937 int qemu_spice_add_display_interface(QXLInstance *qxlin, QemuConsole *con)
 938 {
 939     if (g_slist_find(spice_consoles, con)) {
 940         return -1;
 941     }
 942     qxlin->id = qemu_console_get_index(con);
 943     spice_consoles = g_slist_append(spice_consoles, con);
 944     return qemu_spice_add_interface(&qxlin->base);
 945 }
 946
 947 static int qemu_spice_set_ticket(bool fail_if_conn, bool disconnect_if_conn)
 948 {
 949     time_t lifetime, now = time(NULL);
 950     char *passwd;
 951
 952     if (now < auth_expires) {
 953         passwd = auth_passwd;
 954         lifetime = (auth_expires - now);
 955         if (lifetime > INT_MAX) {
 956             lifetime = INT_MAX;
 957         }
 958     } else {
 959         passwd = NULL;
 960         lifetime = 1;
 961     }
 962     return spice_server_set_ticket(spice_server, passwd, lifetime,
 963                                    fail_if_conn, disconnect_if_conn);
 964 }
 965
 966 static int qemu_spice_set_passwd(const char *passwd,
 967                                  bool fail_if_conn, bool disconnect_if_conn)
 968 {
 969     if (strcmp(auth, "spice") != 0) {
 970         return -1;
 971     }
 972
 973     g_free(auth_passwd);
 974     auth_passwd = g_strdup(passwd);
 975     return qemu_spice_set_ticket(fail_if_conn, disconnect_if_conn);
 976 }
 977
 978 static int qemu_spice_set_pw_expire(time_t expires)
 979 {
 980     auth_expires = expires;
 981     return qemu_spice_set_ticket(false, false);
 982 }
 983
 984 static int qemu_spice_display_add_client(int csock, int skipauth, int tls)
 985 {
 986     if (tls) {
 987         return spice_server_add_ssl_client(spice_server, csock, skipauth);
 988     } else {
 989         return spice_server_add_client(spice_server, csock, skipauth);
 990     }
 991 }
 992
 993 void qemu_spice_display_start(void)
 994 {
 995     if (spice_display_is_running) {
 996         return;
 997     }
 998
 999     spice_display_is_running = true;
1000     spice_server_vm_start(spice_server);
1001 }
1002
1003 void qemu_spice_display_stop(void)
1004 {
1005     if (!spice_display_is_running) {
1006         return;
1007     }
1008
1009     spice_server_vm_stop(spice_server);
1010     spice_display_is_running = false;
1011 }
1012
1013 int qemu_spice_display_is_running(SimpleSpiceDisplay *ssd)
1014 {
1015     return spice_display_is_running;
1016 }
1017
1018 static struct QemuSpiceOps real_spice_ops = {
1019     .init         = qemu_spice_init,
1020     .display_init = qemu_spice_display_init,
1021     .migrate_info = qemu_spice_migrate_info,
1022     .set_passwd   = qemu_spice_set_passwd,
1023     .set_pw_expire = qemu_spice_set_pw_expire,
1024     .display_add_client = qemu_spice_display_add_client,
1025     .add_interface = qemu_spice_add_interface,
1026     .qmp_query = qmp_query_spice_real,
1027 };
1028
1029 static void spice_register_config(void)
1030 {
1031     qemu_spice = real_spice_ops;
1032     qemu_add_opts(&qemu_spice_opts);
1033 }
1034 opts_init(spice_register_config);
1035 module_opts("spice");
1036
1037 #ifdef HAVE_SPICE_GL
1038 module_dep("ui-opengl");
1039 #endif