blob: 91e258a621d7d4d87bdbb7eb2ec334843f86fbbb [file] [log] [blame]
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +01001/*
2 * QEMU external Spice client display driver
3 *
4 * Copyright (c) 2018 Marc-André Lureau <marcandre.lureau@redhat.com>
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
Markus Armbruster0b8fa322019-05-23 16:35:07 +020024
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +010025#include "qemu/osdep.h"
26
27#include <gio/gio.h>
28
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +010029#include "ui/console.h"
Akihiko Odaki9a6c69d2021-07-14 14:57:35 +090030#include "ui/spice-display.h"
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +010031#include "qemu/config-file.h"
Thomas Huth5feed382023-02-10 12:19:31 +010032#include "qemu/error-report.h"
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +010033#include "qemu/option.h"
34#include "qemu/cutils.h"
Markus Armbruster0b8fa322019-05-23 16:35:07 +020035#include "qemu/module.h"
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +010036#include "qapi/error.h"
37#include "io/channel-command.h"
38#include "chardev/spice.h"
Philippe Mathieu-Daudé32cad1f2024-12-03 15:20:13 +010039#include "system/system.h"
Eduardo Habkostdb1015e2020-09-03 16:43:22 -040040#include "qom/object.h"
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +010041
42static const char *tmp_dir;
43static char *app_dir;
44static char *sock_path;
45
Eduardo Habkostdb1015e2020-09-03 16:43:22 -040046struct VCChardev {
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +010047 SpiceChardev parent;
Eduardo Habkostdb1015e2020-09-03 16:43:22 -040048};
Gerd Hoffmanne220cf82020-10-14 14:11:15 +020049
50struct VCChardevClass {
51 ChardevClass parent;
52 void (*parent_open)(Chardev *chr, ChardevBackend *backend,
53 bool *be_opened, Error **errp);
54};
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +010055
56#define TYPE_CHARDEV_VC "chardev-vc"
Gerd Hoffmanne220cf82020-10-14 14:11:15 +020057OBJECT_DECLARE_TYPE(VCChardev, VCChardevClass, CHARDEV_VC)
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +010058
59static ChardevBackend *
60chr_spice_backend_new(void)
61{
62 ChardevBackend *be = g_new0(ChardevBackend, 1);
63
64 be->type = CHARDEV_BACKEND_KIND_SPICEPORT;
65 be->u.spiceport.data = g_new0(ChardevSpicePort, 1);
66
67 return be;
68}
69
70static void vc_chr_open(Chardev *chr,
71 ChardevBackend *backend,
72 bool *be_opened,
73 Error **errp)
74{
Gerd Hoffmanne220cf82020-10-14 14:11:15 +020075 VCChardevClass *vc = CHARDEV_VC_GET_CLASS(chr);
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +010076 ChardevBackend *be;
77 const char *fqdn = NULL;
78
79 if (strstart(chr->label, "serial", NULL)) {
80 fqdn = "org.qemu.console.serial.0";
81 } else if (strstart(chr->label, "parallel", NULL)) {
82 fqdn = "org.qemu.console.parallel.0";
83 } else if (strstart(chr->label, "compat_monitor", NULL)) {
84 fqdn = "org.qemu.monitor.hmp.0";
85 }
86
87 be = chr_spice_backend_new();
88 be->u.spiceport.data->fqdn = fqdn ?
89 g_strdup(fqdn) : g_strdup_printf("org.qemu.console.%s", chr->label);
Gerd Hoffmanne220cf82020-10-14 14:11:15 +020090 vc->parent_open(chr, be, be_opened, errp);
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +010091 qapi_free_ChardevBackend(be);
92}
93
94static void vc_chr_set_echo(Chardev *chr, bool echo)
95{
96 /* TODO: set echo for frontends QMP and qtest */
97}
98
Marc-André Lureau32aa1f82023-08-30 13:38:17 +040099static void vc_chr_parse(QemuOpts *opts, ChardevBackend *backend, Error **errp)
100{
101 /* fqdn is dealt with in vc_chr_open() */
102}
103
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +0100104static void char_vc_class_init(ObjectClass *oc, void *data)
105{
Gerd Hoffmanne220cf82020-10-14 14:11:15 +0200106 VCChardevClass *vc = CHARDEV_VC_CLASS(oc);
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +0100107 ChardevClass *cc = CHARDEV_CLASS(oc);
108
Gerd Hoffmanne220cf82020-10-14 14:11:15 +0200109 vc->parent_open = cc->open;
110
Marc-André Lureau32aa1f82023-08-30 13:38:17 +0400111 cc->parse = vc_chr_parse;
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +0100112 cc->open = vc_chr_open;
113 cc->chr_set_echo = vc_chr_set_echo;
114}
115
116static const TypeInfo char_vc_type_info = {
117 .name = TYPE_CHARDEV_VC,
118 .parent = TYPE_CHARDEV_SPICEPORT,
119 .instance_size = sizeof(VCChardev),
120 .class_init = char_vc_class_init,
Gerd Hoffmanne220cf82020-10-14 14:11:15 +0200121 .class_size = sizeof(VCChardevClass),
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +0100122};
123
124static void spice_app_atexit(void)
125{
126 if (sock_path) {
127 unlink(sock_path);
128 }
129 if (tmp_dir) {
130 rmdir(tmp_dir);
131 }
132 g_free(sock_path);
133 g_free(app_dir);
134}
135
136static void spice_app_display_early_init(DisplayOptions *opts)
137{
138 QemuOpts *qopts;
Bruce Rogers122e4ef2021-02-12 20:23:18 -0700139 QemuOptsList *list;
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +0100140 GError *err = NULL;
141
142 if (opts->has_full_screen) {
143 error_report("spice-app full-screen isn't supported yet.");
144 exit(1);
145 }
146 if (opts->has_window_close) {
147 error_report("spice-app window-close isn't supported yet.");
148 exit(1);
149 }
150
151 atexit(spice_app_atexit);
152
153 if (qemu_name) {
154 app_dir = g_build_filename(g_get_user_runtime_dir(),
155 "qemu", qemu_name, NULL);
156 if (g_mkdir_with_parents(app_dir, S_IRWXU) < -1) {
157 error_report("Failed to create directory %s: %s",
158 app_dir, strerror(errno));
159 exit(1);
160 }
161 } else {
162 app_dir = g_dir_make_tmp(NULL, &err);
163 tmp_dir = app_dir;
164 if (err) {
165 error_report("Failed to create temporary directory: %s",
166 err->message);
167 exit(1);
168 }
169 }
Bruce Rogers122e4ef2021-02-12 20:23:18 -0700170 list = qemu_find_opts("spice");
171 if (list == NULL) {
172 error_report("spice-app missing spice support");
173 exit(1);
174 }
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +0100175
Zhao Liue5d60d92024-10-29 16:59:32 +0800176 type_register_static(&char_vc_type_info);
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +0100177
178 sock_path = g_strjoin("", app_dir, "/", "spice.sock", NULL);
Bruce Rogers122e4ef2021-02-12 20:23:18 -0700179 qopts = qemu_opts_create(list, NULL, 0, &error_abort);
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +0100180 qemu_opt_set(qopts, "disable-ticketing", "on", &error_abort);
181 qemu_opt_set(qopts, "unix", "on", &error_abort);
182 qemu_opt_set(qopts, "addr", sock_path, &error_abort);
183 qemu_opt_set(qopts, "image-compression", "off", &error_abort);
184 qemu_opt_set(qopts, "streaming-video", "off", &error_abort);
Akihiko Odaki9a6c69d2021-07-14 14:57:35 +0900185#ifdef HAVE_SPICE_GL
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +0100186 qemu_opt_set(qopts, "gl", opts->has_gl ? "on" : "off", &error_abort);
187 display_opengl = opts->has_gl;
Marc-André Lureaucb0efb72019-05-24 15:09:43 +0200188#endif
Gerd Hoffmann93ab5842020-10-14 14:11:17 +0200189}
190
191static void spice_app_display_init(DisplayState *ds, DisplayOptions *opts)
192{
193 ChardevBackend *be = chr_spice_backend_new();
194 QemuOpts *qopts;
195 GError *err = NULL;
196 gchar *uri;
197
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +0100198 be->u.spiceport.data->fqdn = g_strdup("org.qemu.monitor.qmp.0");
199 qemu_chardev_new("org.qemu.monitor.qmp", TYPE_CHARDEV_SPICEPORT,
200 be, NULL, &error_abort);
201 qopts = qemu_opts_create(qemu_find_opts("mon"),
202 NULL, 0, &error_fatal);
203 qemu_opt_set(qopts, "chardev", "org.qemu.monitor.qmp", &error_abort);
204 qemu_opt_set(qopts, "mode", "control", &error_abort);
205
206 qapi_free_ChardevBackend(be);
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +0100207 uri = g_strjoin("", "spice+unix://", app_dir, "/", "spice.sock", NULL);
208 info_report("Launching display with URI: %s", uri);
209 g_app_info_launch_default_for_uri(uri, NULL, &err);
210 if (err) {
211 error_report("Failed to launch %s URI: %s", uri, err->message);
212 error_report("You need a capable Spice client, "
213 "such as virt-viewer 8.0");
214 exit(1);
215 }
216 g_free(uri);
217}
218
219static QemuDisplay qemu_display_spice_app = {
220 .type = DISPLAY_TYPE_SPICE_APP,
221 .early_init = spice_app_display_early_init,
222 .init = spice_app_display_init,
Marc-André Lureaub7f1bb32023-11-17 14:55:07 +0400223 .vc = "vc",
Marc-André Lureaud8aec9d2019-02-21 12:07:03 +0100224};
225
226static void register_spice_app(void)
227{
228 qemu_display_register(&qemu_display_spice_app);
229}
230
231type_init(register_spice_app);
Gerd Hoffmannb36ae1c2021-06-24 12:38:13 +0200232
233module_dep("ui-spice-core");
234module_dep("chardev-spice");