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