2 * QMP commands related to UI
4 * Copyright IBM, Corp. 2011
7 * Anthony Liguori <aliguori@us.ibm.com>
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
12 * Contributions after 2012-01-13 are licensed under the terms of the
13 * GNU GPL, version 2 or (at your option) any later version.
16 #include "qemu/osdep.h"
18 #include "io/channel-file.h"
19 #include "monitor/qmp-helpers.h"
20 #include "qapi/qapi-commands-ui.h"
21 #include "qapi/qmp/qerror.h"
22 #include "qemu/coroutine.h"
23 #include "qemu/cutils.h"
25 #include "ui/console.h"
26 #include "ui/dbus-display.h"
27 #include "ui/qemu-spice.h"
32 void qmp_set_password(SetPasswordOptions *opts, Error **errp)
36 if (opts->protocol == DISPLAY_PROTOCOL_SPICE) {
37 if (!qemu_using_spice(errp)) {
40 rc = qemu_spice.set_passwd(opts->password,
41 opts->connected == SET_PASSWORD_ACTION_FAIL,
42 opts->connected == SET_PASSWORD_ACTION_DISCONNECT);
44 assert(opts->protocol == DISPLAY_PROTOCOL_VNC);
45 if (opts->connected != SET_PASSWORD_ACTION_KEEP) {
46 /* vnc supports "connected=keep" only */
47 error_setg(errp, "parameter 'connected' must be 'keep'"
48 " when 'protocol' is 'vnc'");
52 * Note that setting an empty password will not disable login
53 * through this interface.
55 rc = vnc_display_password(opts->u.vnc.display, opts->password);
59 error_setg(errp, "Could not set password");
63 void qmp_expire_password(ExpirePasswordOptions *opts, Error **errp)
67 const char *whenstr = opts->time;
68 const char *numstr = NULL;
71 if (strcmp(whenstr, "now") == 0) {
73 } else if (strcmp(whenstr, "never") == 0) {
75 } else if (whenstr[0] == '+') {
84 if (qemu_strtou64(numstr, NULL, 10, &num) < 0) {
85 error_setg(errp, "Parameter 'time' doesn't take value '%s'",
92 if (opts->protocol == DISPLAY_PROTOCOL_SPICE) {
93 if (!qemu_using_spice(errp)) {
96 rc = qemu_spice.set_pw_expire(when);
98 assert(opts->protocol == DISPLAY_PROTOCOL_VNC);
99 rc = vnc_display_pw_expire(opts->u.vnc.display, when);
103 error_setg(errp, "Could not set password expire time");
108 void qmp_change_vnc_password(const char *password, Error **errp)
110 if (vnc_display_password(NULL, password) < 0) {
111 error_setg(errp, "Could not set password");
116 bool qmp_add_client_spice(int fd, bool has_skipauth, bool skipauth,
117 bool has_tls, bool tls, Error **errp)
119 if (!qemu_using_spice(errp)) {
122 skipauth = has_skipauth ? skipauth : false;
123 tls = has_tls ? tls : false;
124 if (qemu_spice.display_add_client(fd, skipauth, tls) < 0) {
125 error_setg(errp, "spice failed to add client");
132 bool qmp_add_client_vnc(int fd, bool has_skipauth, bool skipauth,
133 bool has_tls, bool tls, Error **errp)
135 skipauth = has_skipauth ? skipauth : false;
136 vnc_display_add_client(NULL, fd, skipauth);
141 #ifdef CONFIG_DBUS_DISPLAY
142 bool qmp_add_client_dbus_display(int fd, bool has_skipauth, bool skipauth,
143 bool has_tls, bool tls, Error **errp)
145 if (!qemu_using_dbus_display(errp)) {
148 if (!qemu_dbus_display.add_client(fd, errp)) {
155 void qmp_display_reload(DisplayReloadOptions *arg, Error **errp)
158 case DISPLAY_RELOAD_TYPE_VNC:
160 if (arg->u.vnc.has_tls_certs && arg->u.vnc.tls_certs) {
161 vnc_display_reload_certs(NULL, errp);
164 error_setg(errp, "vnc is invalid, missing 'CONFIG_VNC'");
172 void qmp_display_update(DisplayUpdateOptions *arg, Error **errp)
175 case DISPLAY_UPDATE_TYPE_VNC:
177 vnc_display_update(&arg->u.vnc, errp);
179 error_setg(errp, "vnc is invalid, missing 'CONFIG_VNC'");
187 void qmp_client_migrate_info(const char *protocol, const char *hostname,
188 bool has_port, int64_t port,
189 bool has_tls_port, int64_t tls_port,
190 const char *cert_subject,
193 if (strcmp(protocol, "spice") == 0) {
194 if (!qemu_using_spice(errp)) {
198 if (!has_port && !has_tls_port) {
199 error_setg(errp, "parameter 'port' or 'tls-port' is required");
203 if (qemu_spice.migrate_info(hostname,
204 has_port ? port : -1,
205 has_tls_port ? tls_port : -1,
207 error_setg(errp, "Could not set up display for migration");
213 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "protocol", "'spice'");
219 * png_save: Take a screenshot as PNG
221 * Saves screendump as a PNG file
223 * Returns true for success or false for error.
225 * @fd: File descriptor for PNG file.
226 * @image: Image data in pixman format.
227 * @errp: Pointer to an error.
229 static bool png_save(int fd, pixman_image_t *image, Error **errp)
231 int width = pixman_image_get_width(image);
232 int height = pixman_image_get_height(image);
235 g_autoptr(pixman_image_t) linebuf =
236 qemu_pixman_linebuf_create(PIXMAN_BE_r8g8b8, width);
237 uint8_t *buf = (uint8_t *)pixman_image_get_data(linebuf);
238 FILE *f = fdopen(fd, "wb");
241 error_setg_errno(errp, errno,
242 "Failed to create file from file descriptor");
246 png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING, NULL,
249 error_setg(errp, "PNG creation failed. Unable to write struct");
254 info_ptr = png_create_info_struct(png_ptr);
257 error_setg(errp, "PNG creation failed. Unable to write info");
259 png_destroy_write_struct(&png_ptr, &info_ptr);
263 png_init_io(png_ptr, f);
265 png_set_IHDR(png_ptr, info_ptr, width, height, 8,
266 PNG_COLOR_TYPE_RGB, PNG_INTERLACE_NONE,
267 PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
269 png_write_info(png_ptr, info_ptr);
271 for (y = 0; y < height; ++y) {
272 qemu_pixman_linebuf_fill(linebuf, image, width, 0, y);
273 png_write_row(png_ptr, buf);
276 png_write_end(png_ptr, NULL);
278 png_destroy_write_struct(&png_ptr, &info_ptr);
280 if (fclose(f) != 0) {
281 error_setg_errno(errp, errno,
282 "PNG creation failed. Unable to close file");
289 #else /* no png support */
291 static bool png_save(int fd, pixman_image_t *image, Error **errp)
293 error_setg(errp, "Enable PNG support with libpng for screendump");
297 #endif /* CONFIG_PNG */
299 static bool ppm_save(int fd, pixman_image_t *image, Error **errp)
301 int width = pixman_image_get_width(image);
302 int height = pixman_image_get_height(image);
303 g_autoptr(Object) ioc = OBJECT(qio_channel_file_new_fd(fd));
304 g_autofree char *header = NULL;
305 g_autoptr(pixman_image_t) linebuf = NULL;
308 trace_ppm_save(fd, image);
310 header = g_strdup_printf("P6\n%d %d\n%d\n", width, height, 255);
311 if (qio_channel_write_all(QIO_CHANNEL(ioc),
312 header, strlen(header), errp) < 0) {
316 linebuf = qemu_pixman_linebuf_create(PIXMAN_BE_r8g8b8, width);
317 for (y = 0; y < height; y++) {
318 qemu_pixman_linebuf_fill(linebuf, image, width, 0, y);
319 if (qio_channel_write_all(QIO_CHANNEL(ioc),
320 (char *)pixman_image_get_data(linebuf),
321 pixman_image_get_stride(linebuf), errp) < 0) {
329 /* Safety: coroutine-only, concurrent-coroutine safe, main thread only */
331 qmp_screendump(const char *filename, const char *device,
332 bool has_head, int64_t head,
333 bool has_format, ImageFormat format, Error **errp)
335 g_autoptr(pixman_image_t) image = NULL;
337 DisplaySurface *surface;
341 con = qemu_console_lookup_by_device_name(device, has_head ? head : 0,
348 error_setg(errp, "'head' must be specified together with 'device'");
351 con = qemu_console_lookup_by_index(0);
353 error_setg(errp, "There is no console to take a screendump from");
358 qemu_console_co_wait_update(con);
361 * All pending coroutines are woken up, while the BQL is held. No
362 * further graphic update are possible until it is released. Take
363 * an image ref before that.
365 surface = qemu_console_surface(con);
367 error_setg(errp, "no surface");
370 image = pixman_image_ref(surface->image);
372 fd = qemu_open_old(filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0666);
374 error_setg(errp, "failed to open file '%s': %s", filename,
380 * The image content could potentially be updated as the coroutine
381 * yields and releases the BQL. It could produce corrupted dump, but
382 * it should be otherwise safe.
384 if (has_format && format == IMAGE_FORMAT_PNG) {
385 /* PNG format specified for screendump */
386 if (!png_save(fd, image, errp)) {
387 qemu_unlink(filename);
390 /* PPM format specified/default for screendump */
391 if (!ppm_save(fd, image, errp)) {
392 qemu_unlink(filename);
396 #endif /* CONFIG_PIXMAN */