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