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