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