xref: /openbmc/qemu/ui/spice-core.c (revision c4fa97c7f216fc80b09a5d32be847ff8d502cba6)
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 "system/system.h"
22 #include "system/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 NotifierWithReturn 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 struct SpiceTimer {
54     QEMUTimer *timer;
55 };
56 
57 #define DEFAULT_MAX_REFRESH_RATE 30
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 BQL if so before calling qemu
221      * functions.
222      */
223     bool need_lock = !bql_locked();
224     if (need_lock) {
225         bql_lock();
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         bql_unlock();
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 = "video-codec",
493             .type = QEMU_OPT_STRING,
494         },{
495             .name = "max-refresh-rate",
496             .type = QEMU_OPT_NUMBER,
497         },{
498             .name = "agent-mouse",
499             .type = QEMU_OPT_BOOL,
500         },{
501             .name = "playback-compression",
502             .type = QEMU_OPT_BOOL,
503         },{
504             .name = "seamless-migration",
505             .type = QEMU_OPT_BOOL,
506         },{
507             .name = "display",
508             .type = QEMU_OPT_STRING,
509         },{
510             .name = "head",
511             .type = QEMU_OPT_NUMBER,
512 #ifdef HAVE_SPICE_GL
513         },{
514             .name = "gl",
515             .type = QEMU_OPT_BOOL,
516         },{
517             .name = "rendernode",
518             .type = QEMU_OPT_STRING,
519 #endif
520         },
521         { /* end of list */ }
522     },
523 };
524 
525 static SpiceInfo *qmp_query_spice_real(Error **errp)
526 {
527     QemuOpts *opts = QTAILQ_FIRST(&qemu_spice_opts.head);
528     int port, tls_port;
529     const char *addr;
530     SpiceInfo *info;
531     unsigned int major;
532     unsigned int minor;
533     unsigned int micro;
534 
535     info = g_malloc0(sizeof(*info));
536 
537     if (!spice_server || !opts) {
538         info->enabled = false;
539         return info;
540     }
541 
542     info->enabled = true;
543     info->migrated = spice_migration_completed;
544 
545     addr = qemu_opt_get(opts, "addr");
546     port = qemu_opt_get_number(opts, "port", 0);
547     tls_port = qemu_opt_get_number(opts, "tls-port", 0);
548 
549     info->auth = g_strdup(auth);
550     info->host = g_strdup(addr ? addr : "*");
551 
552     major = (SPICE_SERVER_VERSION & 0xff0000) >> 16;
553     minor = (SPICE_SERVER_VERSION & 0xff00) >> 8;
554     micro = SPICE_SERVER_VERSION & 0xff;
555     info->compiled_version = g_strdup_printf("%d.%d.%d", major, minor, micro);
556 
557     if (port) {
558         info->has_port = true;
559         info->port = port;
560     }
561     if (tls_port) {
562         info->has_tls_port = true;
563         info->tls_port = tls_port;
564     }
565 
566     info->mouse_mode = spice_server_is_server_mouse(spice_server) ?
567                        SPICE_QUERY_MOUSE_MODE_SERVER :
568                        SPICE_QUERY_MOUSE_MODE_CLIENT;
569 
570     /* for compatibility with the original command */
571     info->has_channels = true;
572     info->channels = qmp_query_spice_channels();
573 
574     return info;
575 }
576 
577 static int migration_state_notifier(NotifierWithReturn *notifier,
578                                     MigrationEvent *e, Error **errp)
579 {
580     if (!spice_have_target_host) {
581         return 0;
582     }
583 
584     if (e->type == MIG_EVENT_PRECOPY_SETUP) {
585         spice_server_migrate_start(spice_server);
586     } else if (e->type == MIG_EVENT_PRECOPY_DONE) {
587         spice_server_migrate_end(spice_server, true);
588         spice_have_target_host = false;
589     } else if (e->type == MIG_EVENT_PRECOPY_FAILED) {
590         spice_server_migrate_end(spice_server, false);
591         spice_have_target_host = false;
592     }
593     return 0;
594 }
595 
596 int qemu_spice_migrate_info(const char *hostname, int port, int tls_port,
597                             const char *subject)
598 {
599     int ret;
600 
601     ret = spice_server_migrate_connect(spice_server, hostname,
602                                        port, tls_port, subject);
603     spice_have_target_host = true;
604     return ret;
605 }
606 
607 static int add_channel(void *opaque, const char *name, const char *value,
608                        Error **errp)
609 {
610     int security = 0;
611     int rc;
612 
613     if (strcmp(name, "tls-channel") == 0) {
614         int *tls_port = opaque;
615         if (!*tls_port) {
616             error_setg(errp, "spice: tried to setup tls-channel"
617                        " without specifying a TLS port");
618             return -1;
619         }
620         security = SPICE_CHANNEL_SECURITY_SSL;
621     }
622     if (strcmp(name, "plaintext-channel") == 0) {
623         security = SPICE_CHANNEL_SECURITY_NONE;
624     }
625     if (security == 0) {
626         return 0;
627     }
628     if (strcmp(value, "default") == 0) {
629         rc = spice_server_set_channel_security(spice_server, NULL, security);
630     } else {
631         rc = spice_server_set_channel_security(spice_server, value, security);
632     }
633     if (rc != 0) {
634         error_setg(errp, "spice: failed to set channel security for %s",
635                    value);
636         return -1;
637     }
638     return 0;
639 }
640 
641 static void vm_change_state_handler(void *opaque, bool running,
642                                     RunState state)
643 {
644     if (running) {
645         qemu_spice_display_start();
646     } else if (state != RUN_STATE_PAUSED) {
647         qemu_spice_display_stop();
648     }
649 }
650 
651 void qemu_spice_display_init_done(void)
652 {
653     if (runstate_is_running()) {
654         qemu_spice_display_start();
655     }
656     qemu_add_vm_change_state_handler(vm_change_state_handler, NULL);
657 }
658 
659 static void qemu_spice_init(void)
660 {
661     QemuOpts *opts = QTAILQ_FIRST(&qemu_spice_opts.head);
662     char *password = NULL;
663     const char *passwordSecret;
664     const char *str, *x509_dir, *addr,
665         *x509_key_password = NULL,
666         *x509_dh_file = NULL,
667         *tls_ciphers = NULL;
668     char *x509_key_file = NULL,
669         *x509_cert_file = NULL,
670         *x509_cacert_file = NULL;
671     int port, tls_port, addr_flags;
672     spice_image_compression_t compression;
673     spice_wan_compression_t wan_compr;
674     bool seamless_migration;
675 
676     if (!opts) {
677         return;
678     }
679     port = qemu_opt_get_number(opts, "port", 0);
680     tls_port = qemu_opt_get_number(opts, "tls-port", 0);
681     if (port < 0 || port > 65535) {
682         error_report("spice port is out of range");
683         exit(1);
684     }
685     if (tls_port < 0 || tls_port > 65535) {
686         error_report("spice tls-port is out of range");
687         exit(1);
688     }
689     passwordSecret = qemu_opt_get(opts, "password-secret");
690     if (passwordSecret) {
691         password = qcrypto_secret_lookup_as_utf8(passwordSecret,
692                                                  &error_fatal);
693     }
694 
695     if (tls_port) {
696         x509_dir = qemu_opt_get(opts, "x509-dir");
697         if (!x509_dir) {
698             x509_dir = ".";
699         }
700 
701         str = qemu_opt_get(opts, "x509-key-file");
702         if (str) {
703             x509_key_file = g_strdup(str);
704         } else {
705             x509_key_file = g_strdup_printf("%s/%s", x509_dir,
706                                             X509_SERVER_KEY_FILE);
707         }
708 
709         str = qemu_opt_get(opts, "x509-cert-file");
710         if (str) {
711             x509_cert_file = g_strdup(str);
712         } else {
713             x509_cert_file = g_strdup_printf("%s/%s", x509_dir,
714                                              X509_SERVER_CERT_FILE);
715         }
716 
717         str = qemu_opt_get(opts, "x509-cacert-file");
718         if (str) {
719             x509_cacert_file = g_strdup(str);
720         } else {
721             x509_cacert_file = g_strdup_printf("%s/%s", x509_dir,
722                                                X509_CA_CERT_FILE);
723         }
724 
725         x509_key_password = qemu_opt_get(opts, "x509-key-password");
726         x509_dh_file = qemu_opt_get(opts, "x509-dh-key-file");
727         tls_ciphers = qemu_opt_get(opts, "tls-ciphers");
728     }
729 
730     addr = qemu_opt_get(opts, "addr");
731     addr_flags = 0;
732     if (qemu_opt_get_bool(opts, "ipv4", 0)) {
733         addr_flags |= SPICE_ADDR_FLAG_IPV4_ONLY;
734     } else if (qemu_opt_get_bool(opts, "ipv6", 0)) {
735         addr_flags |= SPICE_ADDR_FLAG_IPV6_ONLY;
736 #ifdef SPICE_ADDR_FLAG_UNIX_ONLY
737     } else if (qemu_opt_get_bool(opts, "unix", 0)) {
738         addr_flags |= SPICE_ADDR_FLAG_UNIX_ONLY;
739 #endif
740     }
741 
742     spice_server = spice_server_new();
743     spice_server_set_addr(spice_server, addr ? addr : "", addr_flags);
744     if (port) {
745         spice_server_set_port(spice_server, port);
746     }
747     if (tls_port) {
748         spice_server_set_tls(spice_server, tls_port,
749                              x509_cacert_file,
750                              x509_cert_file,
751                              x509_key_file,
752                              x509_key_password,
753                              x509_dh_file,
754                              tls_ciphers);
755     }
756     if (password) {
757         qemu_spice.set_passwd(password, false, false);
758     }
759     if (qemu_opt_get_bool(opts, "sasl", 0)) {
760         if (spice_server_set_sasl(spice_server, 1) == -1) {
761             error_report("spice: failed to enable sasl");
762             exit(1);
763         }
764         auth = "sasl";
765     }
766     if (qemu_opt_get_bool(opts, "disable-ticketing", 0)) {
767         auth = "none";
768         spice_server_set_noauth(spice_server);
769     }
770 
771     if (qemu_opt_get_bool(opts, "disable-copy-paste", 0)) {
772         spice_server_set_agent_copypaste(spice_server, false);
773     }
774 
775     if (qemu_opt_get_bool(opts, "disable-agent-file-xfer", 0)) {
776         spice_server_set_agent_file_xfer(spice_server, false);
777     }
778 
779     compression = SPICE_IMAGE_COMPRESS_AUTO_GLZ;
780     str = qemu_opt_get(opts, "image-compression");
781     if (str) {
782         compression = parse_compression(str);
783     }
784     spice_server_set_image_compression(spice_server, compression);
785 
786     wan_compr = SPICE_WAN_COMPRESSION_AUTO;
787     str = qemu_opt_get(opts, "jpeg-wan-compression");
788     if (str) {
789         wan_compr = parse_wan_compression(str);
790     }
791     spice_server_set_jpeg_compression(spice_server, wan_compr);
792 
793     wan_compr = SPICE_WAN_COMPRESSION_AUTO;
794     str = qemu_opt_get(opts, "zlib-glz-wan-compression");
795     if (str) {
796         wan_compr = parse_wan_compression(str);
797     }
798     spice_server_set_zlib_glz_compression(spice_server, wan_compr);
799 
800     str = qemu_opt_get(opts, "streaming-video");
801     if (str) {
802         int streaming_video = parse_stream_video(str);
803         spice_server_set_streaming_video(spice_server, streaming_video);
804     } else {
805         spice_server_set_streaming_video(spice_server, SPICE_STREAM_VIDEO_OFF);
806     }
807 
808     spice_max_refresh_rate = qemu_opt_get_number(opts, "max-refresh-rate",
809                                                  DEFAULT_MAX_REFRESH_RATE);
810     if (spice_max_refresh_rate <= 0) {
811         error_report("max refresh rate/fps is invalid");
812         exit(1);
813     }
814 
815     spice_server_set_agent_mouse
816         (spice_server, qemu_opt_get_bool(opts, "agent-mouse", 1));
817     spice_server_set_playback_compression
818         (spice_server, qemu_opt_get_bool(opts, "playback-compression", 1));
819 
820     qemu_opt_foreach(opts, add_channel, &tls_port, &error_fatal);
821 
822     spice_server_set_name(spice_server, qemu_name ?: "QEMU " QEMU_VERSION);
823     spice_server_set_uuid(spice_server, (unsigned char *)&qemu_uuid);
824 
825     seamless_migration = qemu_opt_get_bool(opts, "seamless-migration", 0);
826     spice_server_set_seamless_migration(spice_server, seamless_migration);
827     spice_server_set_sasl_appname(spice_server, "qemu");
828     if (spice_server_init(spice_server, &core_interface) != 0) {
829         error_report("failed to initialize spice server");
830         exit(1);
831     };
832     using_spice = 1;
833 
834     migration_add_notifier(&migration_state, migration_state_notifier);
835     spice_migrate.base.sif = &migrate_interface.base;
836     qemu_spice.add_interface(&spice_migrate.base);
837 
838     qemu_spice_input_init();
839 
840     qemu_spice_display_stop();
841 
842     g_free(x509_key_file);
843     g_free(x509_cert_file);
844     g_free(x509_cacert_file);
845     g_free(password);
846 
847 #ifdef HAVE_SPICE_GL
848     if (qemu_opt_get_bool(opts, "gl", 0)) {
849         if ((port != 0) || (tls_port != 0)) {
850 #if SPICE_SERVER_VERSION >= 0x000f03 /* release 0.15.3 */
851             const char *video_codec = NULL;
852             g_autofree char *enc_codec = NULL;
853 
854             spice_remote_client = 1;
855 
856             video_codec = qemu_opt_get(opts, "video-codec");
857             if (video_codec) {
858                 enc_codec = g_strconcat("gstreamer:", video_codec, NULL);
859             }
860             if (spice_server_set_video_codecs(spice_server,
861                                               enc_codec ?: "gstreamer:h264")) {
862                 error_report("invalid video codec");
863                 exit(1);
864             }
865 #else
866             error_report("SPICE GL support is local-only for now and "
867                          "incompatible with -spice port/tls-port");
868             exit(1);
869 #endif
870         }
871         egl_init(qemu_opt_get(opts, "rendernode"), DISPLAY_GL_MODE_ON, &error_fatal);
872         spice_opengl = 1;
873     }
874 #endif
875 }
876 
877 static int qemu_spice_add_interface(SpiceBaseInstance *sin)
878 {
879     if (!spice_server) {
880         if (QTAILQ_FIRST(&qemu_spice_opts.head) != NULL) {
881             error_report("Oops: spice configured but not active");
882             exit(1);
883         }
884         /*
885          * Create a spice server instance.
886          * It does *not* listen on the network.
887          * It handles QXL local rendering only.
888          *
889          * With a command line like '-vnc :0 -vga qxl' you'll end up here.
890          */
891         spice_server = spice_server_new();
892         spice_server_set_sasl_appname(spice_server, "qemu");
893         spice_server_init(spice_server, &core_interface);
894         qemu_add_vm_change_state_handler(vm_change_state_handler, NULL);
895     }
896 
897     return spice_server_add_interface(spice_server, sin);
898 }
899 
900 static GSList *spice_consoles;
901 
902 bool qemu_spice_have_display_interface(QemuConsole *con)
903 {
904     if (g_slist_find(spice_consoles, con)) {
905         return true;
906     }
907     return false;
908 }
909 
910 int qemu_spice_add_display_interface(QXLInstance *qxlin, QemuConsole *con)
911 {
912     if (g_slist_find(spice_consoles, con)) {
913         return -1;
914     }
915     qxlin->id = qemu_console_get_index(con);
916     spice_consoles = g_slist_append(spice_consoles, con);
917     return qemu_spice_add_interface(&qxlin->base);
918 }
919 
920 static int qemu_spice_set_ticket(bool fail_if_conn, bool disconnect_if_conn)
921 {
922     time_t lifetime, now = time(NULL);
923     char *passwd;
924 
925     if (now < auth_expires) {
926         passwd = auth_passwd;
927         lifetime = (auth_expires - now);
928         if (lifetime > INT_MAX) {
929             lifetime = INT_MAX;
930         }
931     } else {
932         passwd = NULL;
933         lifetime = 1;
934     }
935     return spice_server_set_ticket(spice_server, passwd, lifetime,
936                                    fail_if_conn, disconnect_if_conn);
937 }
938 
939 static int qemu_spice_set_passwd(const char *passwd,
940                                  bool fail_if_conn, bool disconnect_if_conn)
941 {
942     if (strcmp(auth, "spice") != 0) {
943         return -1;
944     }
945 
946     g_free(auth_passwd);
947     auth_passwd = g_strdup(passwd);
948     return qemu_spice_set_ticket(fail_if_conn, disconnect_if_conn);
949 }
950 
951 static int qemu_spice_set_pw_expire(time_t expires)
952 {
953     auth_expires = expires;
954     return qemu_spice_set_ticket(false, false);
955 }
956 
957 static int qemu_spice_display_add_client(int csock, int skipauth, int tls)
958 {
959 #ifdef WIN32
960     csock = qemu_close_socket_osfhandle(csock);
961 #endif
962     if (tls) {
963         return spice_server_add_ssl_client(spice_server, csock, skipauth);
964     } else {
965         return spice_server_add_client(spice_server, csock, skipauth);
966     }
967 }
968 
969 void qemu_spice_display_start(void)
970 {
971     if (spice_display_is_running) {
972         return;
973     }
974 
975     spice_display_is_running = true;
976     spice_server_vm_start(spice_server);
977 }
978 
979 void qemu_spice_display_stop(void)
980 {
981     if (!spice_display_is_running) {
982         return;
983     }
984 
985     spice_server_vm_stop(spice_server);
986     spice_display_is_running = false;
987 }
988 
989 int qemu_spice_display_is_running(SimpleSpiceDisplay *ssd)
990 {
991     return spice_display_is_running;
992 }
993 
994 static struct QemuSpiceOps real_spice_ops = {
995     .init         = qemu_spice_init,
996     .display_init = qemu_spice_display_init,
997     .migrate_info = qemu_spice_migrate_info,
998     .set_passwd   = qemu_spice_set_passwd,
999     .set_pw_expire = qemu_spice_set_pw_expire,
1000     .display_add_client = qemu_spice_display_add_client,
1001     .add_interface = qemu_spice_add_interface,
1002     .qmp_query = qmp_query_spice_real,
1003 };
1004 
1005 static void spice_register_config(void)
1006 {
1007     qemu_spice = real_spice_ops;
1008     qemu_add_opts(&qemu_spice_opts);
1009 }
1010 opts_init(spice_register_config);
1011 module_opts("spice");
1012 
1013 #ifdef HAVE_SPICE_GL
1014 module_dep("ui-opengl");
1015 #endif
1016