2 * QEMU Management Protocol commands
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"
17 #include "qemu/cutils.h"
18 #include "qemu/option.h"
19 #include "monitor/monitor.h"
20 #include "sysemu/sysemu.h"
21 #include "qemu/config-file.h"
22 #include "qemu/uuid.h"
23 #include "chardev/char.h"
24 #include "ui/qemu-spice.h"
25 #include "ui/console.h"
26 #include "ui/dbus-display.h"
27 #include "sysemu/kvm.h"
28 #include "sysemu/runstate.h"
29 #include "sysemu/runstate-action.h"
30 #include "sysemu/blockdev.h"
31 #include "sysemu/block-backend.h"
32 #include "qapi/error.h"
33 #include "qapi/qapi-commands-acpi.h"
34 #include "qapi/qapi-commands-block.h"
35 #include "qapi/qapi-commands-control.h"
36 #include "qapi/qapi-commands-machine.h"
37 #include "qapi/qapi-commands-misc.h"
38 #include "qapi/qapi-commands-stats.h"
39 #include "qapi/qapi-commands-ui.h"
40 #include "qapi/type-helpers.h"
41 #include "qapi/qmp/qerror.h"
42 #include "exec/ramlist.h"
43 #include "hw/mem/memory-device.h"
44 #include "hw/acpi/acpi_dev_interface.h"
45 #include "hw/intc/intc.h"
46 #include "hw/rdma/rdma.h"
47 #include "monitor/stats.h"
49 NameInfo *qmp_query_name(Error **errp)
51 NameInfo *info = g_malloc0(sizeof(*info));
54 info->has_name = true;
55 info->name = g_strdup(qemu_name);
61 KvmInfo *qmp_query_kvm(Error **errp)
63 KvmInfo *info = g_malloc0(sizeof(*info));
65 info->enabled = kvm_enabled();
66 info->present = accel_find("kvm");
71 UuidInfo *qmp_query_uuid(Error **errp)
73 UuidInfo *info = g_malloc0(sizeof(*info));
75 info->UUID = qemu_uuid_unparse_strdup(&qemu_uuid);
79 void qmp_quit(Error **errp)
81 shutdown_action = SHUTDOWN_ACTION_POWEROFF;
82 qemu_system_shutdown_request(SHUTDOWN_CAUSE_HOST_QMP_QUIT);
85 void qmp_stop(Error **errp)
87 /* if there is a dump in background, we should wait until the dump
89 if (qemu_system_dump_in_progress()) {
90 error_setg(errp, "There is a dump in process, please wait.");
94 if (runstate_check(RUN_STATE_INMIGRATE)) {
97 vm_stop(RUN_STATE_PAUSED);
101 void qmp_system_reset(Error **errp)
103 qemu_system_reset_request(SHUTDOWN_CAUSE_HOST_QMP_SYSTEM_RESET);
106 void qmp_system_powerdown(Error **errp)
108 qemu_system_powerdown_request();
111 void qmp_cont(Error **errp)
115 Error *local_err = NULL;
117 /* if there is a dump in background, we should wait until the dump
119 if (qemu_system_dump_in_progress()) {
120 error_setg(errp, "There is a dump in process, please wait.");
124 if (runstate_needs_reset()) {
125 error_setg(errp, "Resetting the Virtual Machine is required");
127 } else if (runstate_check(RUN_STATE_SUSPENDED)) {
129 } else if (runstate_check(RUN_STATE_FINISH_MIGRATE)) {
130 error_setg(errp, "Migration is not finalized yet");
134 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
135 blk_iostatus_reset(blk);
138 WITH_JOB_LOCK_GUARD() {
139 for (job = block_job_next_locked(NULL); job;
140 job = block_job_next_locked(job)) {
141 block_job_iostatus_reset_locked(job);
145 /* Continuing after completed migration. Images have been inactivated to
146 * allow the destination to take control. Need to get control back now.
148 * If there are no inactive block nodes (e.g. because the VM was just
149 * paused rather than completing a migration), bdrv_inactivate_all() simply
150 * doesn't do anything. */
151 bdrv_activate_all(&local_err);
153 error_propagate(errp, local_err);
157 if (runstate_check(RUN_STATE_INMIGRATE)) {
164 void qmp_system_wakeup(Error **errp)
166 if (!qemu_wakeup_suspend_enabled()) {
168 "wake-up from suspend is not supported by this guest");
172 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_OTHER, errp);
175 void qmp_set_password(SetPasswordOptions *opts, Error **errp)
179 if (opts->protocol == DISPLAY_PROTOCOL_SPICE) {
180 if (!qemu_using_spice(errp)) {
183 rc = qemu_spice.set_passwd(opts->password,
184 opts->connected == SET_PASSWORD_ACTION_FAIL,
185 opts->connected == SET_PASSWORD_ACTION_DISCONNECT);
187 assert(opts->protocol == DISPLAY_PROTOCOL_VNC);
188 if (opts->connected != SET_PASSWORD_ACTION_KEEP) {
189 /* vnc supports "connected=keep" only */
190 error_setg(errp, QERR_INVALID_PARAMETER, "connected");
193 /* Note that setting an empty password will not disable login through
195 rc = vnc_display_password(opts->u.vnc.display, opts->password);
199 error_setg(errp, "Could not set password");
203 void qmp_expire_password(ExpirePasswordOptions *opts, Error **errp)
207 const char *whenstr = opts->time;
209 if (strcmp(whenstr, "now") == 0) {
211 } else if (strcmp(whenstr, "never") == 0) {
213 } else if (whenstr[0] == '+') {
214 when = time(NULL) + strtoull(whenstr+1, NULL, 10);
216 when = strtoull(whenstr, NULL, 10);
219 if (opts->protocol == DISPLAY_PROTOCOL_SPICE) {
220 if (!qemu_using_spice(errp)) {
223 rc = qemu_spice.set_pw_expire(when);
225 assert(opts->protocol == DISPLAY_PROTOCOL_VNC);
226 rc = vnc_display_pw_expire(opts->u.vnc.display, when);
230 error_setg(errp, "Could not set password expire time");
235 void qmp_change_vnc_password(const char *password, Error **errp)
237 if (vnc_display_password(NULL, password) < 0) {
238 error_setg(errp, "Could not set password");
243 void qmp_add_client(const char *protocol, const char *fdname,
244 bool has_skipauth, bool skipauth, bool has_tls, bool tls,
250 fd = monitor_get_fd(monitor_cur(), fdname, errp);
255 if (strcmp(protocol, "spice") == 0) {
256 if (!qemu_using_spice(errp)) {
260 skipauth = has_skipauth ? skipauth : false;
261 tls = has_tls ? tls : false;
262 if (qemu_spice.display_add_client(fd, skipauth, tls) < 0) {
263 error_setg(errp, "spice failed to add client");
268 } else if (strcmp(protocol, "vnc") == 0) {
269 skipauth = has_skipauth ? skipauth : false;
270 vnc_display_add_client(NULL, fd, skipauth);
273 #ifdef CONFIG_DBUS_DISPLAY
274 } else if (strcmp(protocol, "@dbus-display") == 0) {
275 if (!qemu_using_dbus_display(errp)) {
279 if (!qemu_dbus_display.add_client(fd, errp)) {
285 } else if ((s = qemu_chr_find(protocol)) != NULL) {
286 if (qemu_chr_add_client(s, fd) < 0) {
287 error_setg(errp, "failed to add client");
294 error_setg(errp, "protocol '%s' is invalid", protocol);
299 MemoryDeviceInfoList *qmp_query_memory_devices(Error **errp)
301 return qmp_memory_device_list();
304 ACPIOSTInfoList *qmp_query_acpi_ospm_status(Error **errp)
307 ACPIOSTInfoList *head = NULL;
308 ACPIOSTInfoList **prev = &head;
309 Object *obj = object_resolve_path_type("", TYPE_ACPI_DEVICE_IF, &ambig);
312 AcpiDeviceIfClass *adevc = ACPI_DEVICE_IF_GET_CLASS(obj);
313 AcpiDeviceIf *adev = ACPI_DEVICE_IF(obj);
315 adevc->ospm_status(adev, &prev);
317 error_setg(errp, "command is not supported, missing ACPI device");
323 MemoryInfo *qmp_query_memory_size_summary(Error **errp)
325 MemoryInfo *mem_info = g_new0(MemoryInfo, 1);
326 MachineState *ms = MACHINE(qdev_get_machine());
328 mem_info->base_memory = ms->ram_size;
330 mem_info->plugged_memory = get_plugged_memory_size();
331 mem_info->has_plugged_memory =
332 mem_info->plugged_memory != (uint64_t)-1;
337 void qmp_display_reload(DisplayReloadOptions *arg, Error **errp)
340 case DISPLAY_RELOAD_TYPE_VNC:
342 if (arg->u.vnc.has_tls_certs && arg->u.vnc.tls_certs) {
343 vnc_display_reload_certs(NULL, errp);
346 error_setg(errp, "vnc is invalid, missing 'CONFIG_VNC'");
354 void qmp_display_update(DisplayUpdateOptions *arg, Error **errp)
357 case DISPLAY_UPDATE_TYPE_VNC:
359 vnc_display_update(&arg->u.vnc, errp);
361 error_setg(errp, "vnc is invalid, missing 'CONFIG_VNC'");
369 static int qmp_x_query_rdma_foreach(Object *obj, void *opaque)
372 RdmaProviderClass *k;
373 GString *buf = opaque;
375 if (object_dynamic_cast(obj, INTERFACE_RDMA_PROVIDER)) {
376 rdma = RDMA_PROVIDER(obj);
377 k = RDMA_PROVIDER_GET_CLASS(obj);
378 if (k->format_statistics) {
379 k->format_statistics(rdma, buf);
381 g_string_append_printf(buf,
382 "RDMA statistics not available for %s.\n",
383 object_get_typename(obj));
390 HumanReadableText *qmp_x_query_rdma(Error **errp)
392 g_autoptr(GString) buf = g_string_new("");
394 object_child_foreach_recursive(object_get_root(),
395 qmp_x_query_rdma_foreach, buf);
397 return human_readable_text_from_str(buf);
400 HumanReadableText *qmp_x_query_ramblock(Error **errp)
402 g_autoptr(GString) buf = ram_block_format();
404 return human_readable_text_from_str(buf);
407 static int qmp_x_query_irq_foreach(Object *obj, void *opaque)
409 InterruptStatsProvider *intc;
410 InterruptStatsProviderClass *k;
411 GString *buf = opaque;
413 if (object_dynamic_cast(obj, TYPE_INTERRUPT_STATS_PROVIDER)) {
414 intc = INTERRUPT_STATS_PROVIDER(obj);
415 k = INTERRUPT_STATS_PROVIDER_GET_CLASS(obj);
416 uint64_t *irq_counts;
417 unsigned int nb_irqs, i;
418 if (k->get_statistics &&
419 k->get_statistics(intc, &irq_counts, &nb_irqs)) {
421 g_string_append_printf(buf, "IRQ statistics for %s:\n",
422 object_get_typename(obj));
423 for (i = 0; i < nb_irqs; i++) {
424 if (irq_counts[i] > 0) {
425 g_string_append_printf(buf, "%2d: %" PRId64 "\n", i,
431 g_string_append_printf(buf,
432 "IRQ statistics not available for %s.\n",
433 object_get_typename(obj));
440 HumanReadableText *qmp_x_query_irq(Error **errp)
442 g_autoptr(GString) buf = g_string_new("");
444 object_child_foreach_recursive(object_get_root(),
445 qmp_x_query_irq_foreach, buf);
447 return human_readable_text_from_str(buf);
450 typedef struct StatsCallbacks {
451 StatsProvider provider;
452 StatRetrieveFunc *stats_cb;
453 SchemaRetrieveFunc *schemas_cb;
454 QTAILQ_ENTRY(StatsCallbacks) next;
457 static QTAILQ_HEAD(, StatsCallbacks) stats_callbacks =
458 QTAILQ_HEAD_INITIALIZER(stats_callbacks);
460 void add_stats_callbacks(StatsProvider provider,
461 StatRetrieveFunc *stats_fn,
462 SchemaRetrieveFunc *schemas_fn)
464 StatsCallbacks *entry = g_new(StatsCallbacks, 1);
465 entry->provider = provider;
466 entry->stats_cb = stats_fn;
467 entry->schemas_cb = schemas_fn;
469 QTAILQ_INSERT_TAIL(&stats_callbacks, entry, next);
472 static bool invoke_stats_cb(StatsCallbacks *entry,
473 StatsResultList **stats_results,
474 StatsFilter *filter, StatsRequest *request,
477 strList *targets = NULL;
478 strList *names = NULL;
482 if (request->provider != entry->provider) {
485 if (request->has_names && !request->names) {
488 names = request->has_names ? request->names : NULL;
491 switch (filter->target) {
492 case STATS_TARGET_VM:
494 case STATS_TARGET_VCPU:
495 if (filter->u.vcpu.has_vcpus) {
496 if (!filter->u.vcpu.vcpus) {
497 /* No targets allowed? Return no statistics. */
500 targets = filter->u.vcpu.vcpus;
507 entry->stats_cb(stats_results, filter->target, names, targets, errp);
509 qapi_free_StatsResultList(*stats_results);
510 *stats_results = NULL;
516 StatsResultList *qmp_query_stats(StatsFilter *filter, Error **errp)
518 StatsResultList *stats_results = NULL;
519 StatsCallbacks *entry;
520 StatsRequestList *request;
522 QTAILQ_FOREACH(entry, &stats_callbacks, next) {
523 if (filter->has_providers) {
524 for (request = filter->providers; request; request = request->next) {
525 if (!invoke_stats_cb(entry, &stats_results, filter,
526 request->value, errp)) {
531 if (!invoke_stats_cb(entry, &stats_results, filter, NULL, errp)) {
537 return stats_results;
540 StatsSchemaList *qmp_query_stats_schemas(bool has_provider,
541 StatsProvider provider,
544 StatsSchemaList *stats_results = NULL;
545 StatsCallbacks *entry;
548 QTAILQ_FOREACH(entry, &stats_callbacks, next) {
549 if (!has_provider || provider == entry->provider) {
550 entry->schemas_cb(&stats_results, errp);
552 qapi_free_StatsSchemaList(stats_results);
558 return stats_results;
561 void add_stats_entry(StatsResultList **stats_results, StatsProvider provider,
562 const char *qom_path, StatsList *stats_list)
564 StatsResult *entry = g_new0(StatsResult, 1);
566 entry->provider = provider;
568 entry->has_qom_path = true;
569 entry->qom_path = g_strdup(qom_path);
571 entry->stats = stats_list;
573 QAPI_LIST_PREPEND(*stats_results, entry);
576 void add_stats_schema(StatsSchemaList **schema_results,
577 StatsProvider provider, StatsTarget target,
578 StatsSchemaValueList *stats_list)
580 StatsSchema *entry = g_new0(StatsSchema, 1);
582 entry->provider = provider;
583 entry->target = target;
584 entry->stats = stats_list;
585 QAPI_LIST_PREPEND(*schema_results, entry);
588 bool apply_str_list_filter(const char *string, strList *list)
590 strList *str_list = NULL;
595 for (str_list = list; str_list; str_list = str_list->next) {
596 if (g_str_equal(string, str_list->value)) {