ui/spice-app.c

   1 /*
   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  */
  24
  25 #include "qemu/osdep.h"
  26
  27 #include <gio/gio.h>
  28
  29 #include "ui/console.h"
  30 #include "qemu/config-file.h"
  31 #include "qemu/option.h"
  32 #include "qemu/cutils.h"
  33 #include "qemu/module.h"
  34 #include "qapi/error.h"
  35 #include "io/channel-command.h"
  36 #include "chardev/spice.h"
  37 #include "sysemu/sysemu.h"
  38
  39 static const char *tmp_dir;
  40 static char *app_dir;
  41 static char *sock_path;
  42
  43 typedef struct VCChardev {
  44     SpiceChardev parent;
  45 } VCChardev;
  46
  47 #define TYPE_CHARDEV_VC "chardev-vc"
  48 #define VC_CHARDEV(obj) OBJECT_CHECK(VCChardev, (obj), TYPE_CHARDEV_VC)
  49
  50 static ChardevBackend *
  51 chr_spice_backend_new(void)
  52 {
  53     ChardevBackend *be = g_new0(ChardevBackend, 1);
  54
  55     be->type = CHARDEV_BACKEND_KIND_SPICEPORT;
  56     be->u.spiceport.data = g_new0(ChardevSpicePort, 1);
  57
  58     return be;
  59 }
  60
  61 static void vc_chr_open(Chardev *chr,
  62                         ChardevBackend *backend,
  63                         bool *be_opened,
  64                         Error **errp)
  65 {
  66     ChardevBackend *be;
  67     const char *fqdn = NULL;
  68
  69     if (strstart(chr->label, "serial", NULL)) {
  70         fqdn = "org.qemu.console.serial.0";
  71     } else if (strstart(chr->label, "parallel", NULL)) {
  72         fqdn = "org.qemu.console.parallel.0";
  73     } else if (strstart(chr->label, "compat_monitor", NULL)) {
  74         fqdn = "org.qemu.monitor.hmp.0";
  75     }
  76
  77     be = chr_spice_backend_new();
  78     be->u.spiceport.data->fqdn = fqdn ?
  79         g_strdup(fqdn) : g_strdup_printf("org.qemu.console.%s", chr->label);
  80     qemu_chr_open_spice_port(chr, be, be_opened, errp);
  81     qapi_free_ChardevBackend(be);
  82 }
  83
  84 static void vc_chr_set_echo(Chardev *chr, bool echo)
  85 {
  86     /* TODO: set echo for frontends QMP and qtest */
  87 }
  88
  89 static void char_vc_class_init(ObjectClass *oc, void *data)
  90 {
  91     ChardevClass *cc = CHARDEV_CLASS(oc);
  92
  93     cc->parse = qemu_chr_parse_vc;
  94     cc->open = vc_chr_open;
  95     cc->chr_set_echo = vc_chr_set_echo;
  96 }
  97
  98 static const TypeInfo char_vc_type_info = {
  99     .name = TYPE_CHARDEV_VC,
 100     .parent = TYPE_CHARDEV_SPICEPORT,
 101     .instance_size = sizeof(VCChardev),
 102     .class_init = char_vc_class_init,
 103 };
 104
 105 static void spice_app_atexit(void)
 106 {
 107     if (sock_path) {
 108         unlink(sock_path);
 109     }
 110     if (tmp_dir) {
 111         rmdir(tmp_dir);
 112     }
 113     g_free(sock_path);
 114     g_free(app_dir);
 115 }
 116
 117 static void spice_app_display_early_init(DisplayOptions *opts)
 118 {
 119     QemuOpts *qopts;
 120     ChardevBackend *be = chr_spice_backend_new();
 121     GError *err = NULL;
 122
 123     if (opts->has_full_screen) {
 124         error_report("spice-app full-screen isn't supported yet.");
 125         exit(1);
 126     }
 127     if (opts->has_window_close) {
 128         error_report("spice-app window-close isn't supported yet.");
 129         exit(1);
 130     }
 131
 132     atexit(spice_app_atexit);
 133
 134     if (qemu_name) {
 135         app_dir = g_build_filename(g_get_user_runtime_dir(),
 136                                    "qemu", qemu_name, NULL);
 137         if (g_mkdir_with_parents(app_dir, S_IRWXU) < -1) {
 138             error_report("Failed to create directory %s: %s",
 139                          app_dir, strerror(errno));
 140             exit(1);
 141         }
 142     } else {
 143         app_dir = g_dir_make_tmp(NULL, &err);
 144         tmp_dir = app_dir;
 145         if (err) {
 146             error_report("Failed to create temporary directory: %s",
 147                          err->message);
 148             exit(1);
 149         }
 150     }
 151
 152     type_register(&char_vc_type_info);
 153
 154     sock_path = g_strjoin("", app_dir, "/", "spice.sock", NULL);
 155     qopts = qemu_opts_create(qemu_find_opts("spice"), NULL, 0, &error_abort);
 156     qemu_opt_set(qopts, "disable-ticketing", "on", &error_abort);
 157     qemu_opt_set(qopts, "unix", "on", &error_abort);
 158     qemu_opt_set(qopts, "addr", sock_path, &error_abort);
 159     qemu_opt_set(qopts, "image-compression", "off", &error_abort);
 160     qemu_opt_set(qopts, "streaming-video", "off", &error_abort);
 161 #ifdef CONFIG_OPENGL
 162     qemu_opt_set(qopts, "gl", opts->has_gl ? "on" : "off", &error_abort);
 163     display_opengl = opts->has_gl;
 164 #endif
 165     be->u.spiceport.data->fqdn = g_strdup("org.qemu.monitor.qmp.0");
 166     qemu_chardev_new("org.qemu.monitor.qmp", TYPE_CHARDEV_SPICEPORT,
 167                      be, NULL, &error_abort);
 168     qopts = qemu_opts_create(qemu_find_opts("mon"),
 169                              NULL, 0, &error_fatal);
 170     qemu_opt_set(qopts, "chardev", "org.qemu.monitor.qmp", &error_abort);
 171     qemu_opt_set(qopts, "mode", "control", &error_abort);
 172
 173     qapi_free_ChardevBackend(be);
 174 }
 175
 176 static void spice_app_display_init(DisplayState *ds, DisplayOptions *opts)
 177 {
 178     GError *err = NULL;
 179     gchar *uri;
 180
 181     uri = g_strjoin("", "spice+unix://", app_dir, "/", "spice.sock", NULL);
 182     info_report("Launching display with URI: %s", uri);
 183     g_app_info_launch_default_for_uri(uri, NULL, &err);
 184     if (err) {
 185         error_report("Failed to launch %s URI: %s", uri, err->message);
 186         error_report("You need a capable Spice client, "
 187                      "such as virt-viewer 8.0");
 188         exit(1);
 189     }
 190     g_free(uri);
 191 }
 192
 193 static QemuDisplay qemu_display_spice_app = {
 194     .type       = DISPLAY_TYPE_SPICE_APP,
 195     .early_init = spice_app_display_early_init,
 196     .init       = spice_app_display_init,
 197 };
 198
 199 static void register_spice_app(void)
 200 {
 201     qemu_display_register(&qemu_display_spice_app);
 202 }
 203
 204 type_init(register_spice_app);