2 * QEMU Management Protocol
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-common.h"
17 #include "monitor/monitor.h"
18 #include "sysemu/sysemu.h"
19 #include "qmp-commands.h"
20 #include "sysemu/char.h"
21 #include "ui/qemu-spice.h"
23 #include "sysemu/kvm.h"
24 #include "sysemu/arch_init.h"
26 #include "sysemu/blockdev.h"
27 #include "sysemu/block-backend.h"
28 #include "qom/qom-qobject.h"
29 #include "qapi/qmp/qerror.h"
30 #include "qapi/qmp/qobject.h"
31 #include "qapi/qmp-input-visitor.h"
32 #include "hw/boards.h"
33 #include "qom/object_interfaces.h"
34 #include "hw/mem/pc-dimm.h"
35 #include "hw/acpi/acpi_dev_interface.h"
37 NameInfo *qmp_query_name(Error **errp)
39 NameInfo *info = g_malloc0(sizeof(*info));
42 info->has_name = true;
43 info->name = g_strdup(qemu_name);
49 VersionInfo *qmp_query_version(Error **errp)
51 VersionInfo *info = g_new0(VersionInfo, 1);
52 const char *version = QEMU_VERSION;
56 info->qemu = g_new0(VersionTriple, 1);
57 err = qemu_strtoll(version, &tmp, 10, &info->qemu->major);
61 err = qemu_strtoll(tmp, &tmp, 10, &info->qemu->minor);
65 err = qemu_strtoll(tmp, &tmp, 10, &info->qemu->micro);
67 info->package = g_strdup(QEMU_PKGVERSION);
72 KvmInfo *qmp_query_kvm(Error **errp)
74 KvmInfo *info = g_malloc0(sizeof(*info));
76 info->enabled = kvm_enabled();
77 info->present = kvm_available();
82 UuidInfo *qmp_query_uuid(Error **errp)
84 UuidInfo *info = g_malloc0(sizeof(*info));
87 snprintf(uuid, sizeof(uuid), UUID_FMT, qemu_uuid[0], qemu_uuid[1],
88 qemu_uuid[2], qemu_uuid[3], qemu_uuid[4], qemu_uuid[5],
89 qemu_uuid[6], qemu_uuid[7], qemu_uuid[8], qemu_uuid[9],
90 qemu_uuid[10], qemu_uuid[11], qemu_uuid[12], qemu_uuid[13],
91 qemu_uuid[14], qemu_uuid[15]);
93 info->UUID = g_strdup(uuid);
97 void qmp_quit(Error **errp)
100 qemu_system_shutdown_request();
103 void qmp_stop(Error **errp)
105 if (runstate_check(RUN_STATE_INMIGRATE)) {
108 vm_stop(RUN_STATE_PAUSED);
112 void qmp_system_reset(Error **errp)
114 qemu_system_reset_request();
117 void qmp_system_powerdown(Error **erp)
119 qemu_system_powerdown_request();
122 void qmp_cpu(int64_t index, Error **errp)
124 /* Just do nothing */
127 void qmp_cpu_add(int64_t id, Error **errp)
131 mc = MACHINE_GET_CLASS(current_machine);
132 if (mc->hot_add_cpu) {
133 mc->hot_add_cpu(id, errp);
135 error_setg(errp, "Not supported");
140 /* If VNC support is enabled, the "true" query-vnc command is
141 defined in the VNC subsystem */
142 VncInfo *qmp_query_vnc(Error **errp)
144 error_setg(errp, QERR_FEATURE_DISABLED, "vnc");
148 VncInfo2List *qmp_query_vnc_servers(Error **errp)
150 error_setg(errp, QERR_FEATURE_DISABLED, "vnc");
157 * qmp-commands.hx ensures that QMP command query-spice exists only
158 * #ifdef CONFIG_SPICE. Necessary for an accurate query-commands
159 * result. However, the QAPI schema is blissfully unaware of that,
160 * and the QAPI code generator happily generates a dead
161 * qmp_marshal_query_spice() that calls qmp_query_spice(). Provide it
162 * one, or else linking fails. FIXME Educate the QAPI schema on
165 SpiceInfo *qmp_query_spice(Error **errp)
171 void qmp_cont(Error **errp)
173 Error *local_err = NULL;
175 BlockDriverState *bs;
177 if (runstate_needs_reset()) {
178 error_setg(errp, "Resetting the Virtual Machine is required");
180 } else if (runstate_check(RUN_STATE_SUSPENDED)) {
184 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
185 blk_iostatus_reset(blk);
187 for (bs = bdrv_next(NULL); bs; bs = bdrv_next(bs)) {
188 bdrv_add_key(bs, NULL, &local_err);
190 error_propagate(errp, local_err);
195 if (runstate_check(RUN_STATE_INMIGRATE)) {
202 void qmp_system_wakeup(Error **errp)
204 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_OTHER);
207 ObjectPropertyInfoList *qmp_qom_list(const char *path, Error **errp)
210 bool ambiguous = false;
211 ObjectPropertyInfoList *props = NULL;
212 ObjectProperty *prop;
214 obj = object_resolve_path(path, &ambiguous);
217 error_setg(errp, "Path '%s' is ambiguous", path);
219 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
220 "Device '%s' not found", path);
225 QTAILQ_FOREACH(prop, &obj->properties, node) {
226 ObjectPropertyInfoList *entry = g_malloc0(sizeof(*entry));
228 entry->value = g_malloc0(sizeof(ObjectPropertyInfo));
232 entry->value->name = g_strdup(prop->name);
233 entry->value->type = g_strdup(prop->type);
239 void qmp_qom_set(const char *path, const char *property, QObject *value,
244 obj = object_resolve_path(path, NULL);
246 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
247 "Device '%s' not found", path);
251 object_property_set_qobject(obj, value, property, errp);
254 QObject *qmp_qom_get(const char *path, const char *property, Error **errp)
258 obj = object_resolve_path(path, NULL);
260 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
261 "Device '%s' not found", path);
265 return object_property_get_qobject(obj, property, errp);
268 void qmp_set_password(const char *protocol, const char *password,
269 bool has_connected, const char *connected, Error **errp)
271 int disconnect_if_connected = 0;
272 int fail_if_connected = 0;
276 if (strcmp(connected, "fail") == 0) {
277 fail_if_connected = 1;
278 } else if (strcmp(connected, "disconnect") == 0) {
279 disconnect_if_connected = 1;
280 } else if (strcmp(connected, "keep") == 0) {
283 error_setg(errp, QERR_INVALID_PARAMETER, "connected");
288 if (strcmp(protocol, "spice") == 0) {
289 if (!qemu_using_spice(errp)) {
292 rc = qemu_spice_set_passwd(password, fail_if_connected,
293 disconnect_if_connected);
295 error_setg(errp, QERR_SET_PASSWD_FAILED);
300 if (strcmp(protocol, "vnc") == 0) {
301 if (fail_if_connected || disconnect_if_connected) {
302 /* vnc supports "connected=keep" only */
303 error_setg(errp, QERR_INVALID_PARAMETER, "connected");
306 /* Note that setting an empty password will not disable login through
308 rc = vnc_display_password(NULL, password);
310 error_setg(errp, QERR_SET_PASSWD_FAILED);
315 error_setg(errp, QERR_INVALID_PARAMETER, "protocol");
318 void qmp_expire_password(const char *protocol, const char *whenstr,
324 if (strcmp(whenstr, "now") == 0) {
326 } else if (strcmp(whenstr, "never") == 0) {
328 } else if (whenstr[0] == '+') {
329 when = time(NULL) + strtoull(whenstr+1, NULL, 10);
331 when = strtoull(whenstr, NULL, 10);
334 if (strcmp(protocol, "spice") == 0) {
335 if (!qemu_using_spice(errp)) {
338 rc = qemu_spice_set_pw_expire(when);
340 error_setg(errp, QERR_SET_PASSWD_FAILED);
345 if (strcmp(protocol, "vnc") == 0) {
346 rc = vnc_display_pw_expire(NULL, when);
348 error_setg(errp, QERR_SET_PASSWD_FAILED);
353 error_setg(errp, QERR_INVALID_PARAMETER, "protocol");
357 void qmp_change_vnc_password(const char *password, Error **errp)
359 if (vnc_display_password(NULL, password) < 0) {
360 error_setg(errp, QERR_SET_PASSWD_FAILED);
364 static void qmp_change_vnc_listen(const char *target, Error **errp)
366 QemuOptsList *olist = qemu_find_opts("vnc");
369 if (strstr(target, "id=")) {
370 error_setg(errp, "id not supported");
374 opts = qemu_opts_find(olist, "default");
378 opts = vnc_parse(target, errp);
383 vnc_display_open("default", errp);
386 static void qmp_change_vnc(const char *target, bool has_arg, const char *arg,
389 if (strcmp(target, "passwd") == 0 || strcmp(target, "password") == 0) {
391 error_setg(errp, QERR_MISSING_PARAMETER, "password");
393 qmp_change_vnc_password(arg, errp);
396 qmp_change_vnc_listen(target, errp);
400 void qmp_change_vnc_password(const char *password, Error **errp)
402 error_setg(errp, QERR_FEATURE_DISABLED, "vnc");
404 static void qmp_change_vnc(const char *target, bool has_arg, const char *arg,
407 error_setg(errp, QERR_FEATURE_DISABLED, "vnc");
409 #endif /* !CONFIG_VNC */
411 void qmp_change(const char *device, const char *target,
412 bool has_arg, const char *arg, Error **errp)
414 if (strcmp(device, "vnc") == 0) {
415 qmp_change_vnc(target, has_arg, arg, errp);
417 qmp_blockdev_change_medium(device, target, has_arg, arg, false, 0,
422 static void qom_list_types_tramp(ObjectClass *klass, void *data)
424 ObjectTypeInfoList *e, **pret = data;
425 ObjectTypeInfo *info;
427 info = g_malloc0(sizeof(*info));
428 info->name = g_strdup(object_class_get_name(klass));
430 e = g_malloc0(sizeof(*e));
436 ObjectTypeInfoList *qmp_qom_list_types(bool has_implements,
437 const char *implements,
442 ObjectTypeInfoList *ret = NULL;
444 object_class_foreach(qom_list_types_tramp, implements, abstract, &ret);
449 /* Return a DevicePropertyInfo for a qdev property.
451 * If a qdev property with the given name does not exist, use the given default
452 * type. If the qdev property info should not be shown, return NULL.
454 * The caller must free the return value.
456 static DevicePropertyInfo *make_device_property_info(ObjectClass *klass,
458 const char *default_type,
459 const char *description)
461 DevicePropertyInfo *info;
465 for (prop = DEVICE_CLASS(klass)->props; prop && prop->name; prop++) {
466 if (strcmp(name, prop->name) != 0) {
471 * TODO Properties without a parser are just for dirty hacks.
472 * qdev_prop_ptr is the only such PropertyInfo. It's marked
473 * for removal. This conditional should be removed along with
476 if (!prop->info->set) {
477 return NULL; /* no way to set it, don't show */
480 info = g_malloc0(sizeof(*info));
481 info->name = g_strdup(prop->name);
482 info->type = g_strdup(prop->info->name);
483 info->has_description = !!prop->info->description;
484 info->description = g_strdup(prop->info->description);
487 klass = object_class_get_parent(klass);
488 } while (klass != object_class_by_name(TYPE_DEVICE));
490 /* Not a qdev property, use the default type */
491 info = g_malloc0(sizeof(*info));
492 info->name = g_strdup(name);
493 info->type = g_strdup(default_type);
494 info->has_description = !!description;
495 info->description = g_strdup(description);
500 DevicePropertyInfoList *qmp_device_list_properties(const char *typename,
505 ObjectProperty *prop;
506 DevicePropertyInfoList *prop_list = NULL;
508 klass = object_class_by_name(typename);
510 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
511 "Device '%s' not found", typename);
515 klass = object_class_dynamic_cast(klass, TYPE_DEVICE);
517 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "name", TYPE_DEVICE);
521 if (object_class_is_abstract(klass)) {
522 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "name",
523 "non-abstract device type");
527 if (DEVICE_CLASS(klass)->cannot_destroy_with_object_finalize_yet) {
528 error_setg(errp, "Can't list properties of device '%s'", typename);
532 obj = object_new(typename);
534 QTAILQ_FOREACH(prop, &obj->properties, node) {
535 DevicePropertyInfo *info;
536 DevicePropertyInfoList *entry;
538 /* Skip Object and DeviceState properties */
539 if (strcmp(prop->name, "type") == 0 ||
540 strcmp(prop->name, "realized") == 0 ||
541 strcmp(prop->name, "hotpluggable") == 0 ||
542 strcmp(prop->name, "hotplugged") == 0 ||
543 strcmp(prop->name, "parent_bus") == 0) {
547 /* Skip legacy properties since they are just string versions of
548 * properties that we already list.
550 if (strstart(prop->name, "legacy-", NULL)) {
554 info = make_device_property_info(klass, prop->name, prop->type,
560 entry = g_malloc0(sizeof(*entry));
562 entry->next = prop_list;
571 CpuDefinitionInfoList *qmp_query_cpu_definitions(Error **errp)
573 return arch_query_cpu_definitions(errp);
576 void qmp_add_client(const char *protocol, const char *fdname,
577 bool has_skipauth, bool skipauth, bool has_tls, bool tls,
583 fd = monitor_get_fd(cur_mon, fdname, errp);
588 if (strcmp(protocol, "spice") == 0) {
589 if (!qemu_using_spice(errp)) {
593 skipauth = has_skipauth ? skipauth : false;
594 tls = has_tls ? tls : false;
595 if (qemu_spice_display_add_client(fd, skipauth, tls) < 0) {
596 error_setg(errp, "spice failed to add client");
601 } else if (strcmp(protocol, "vnc") == 0) {
602 skipauth = has_skipauth ? skipauth : false;
603 vnc_display_add_client(NULL, fd, skipauth);
606 } else if ((s = qemu_chr_find(protocol)) != NULL) {
607 if (qemu_chr_add_client(s, fd) < 0) {
608 error_setg(errp, "failed to add client");
615 error_setg(errp, "protocol '%s' is invalid", protocol);
619 void object_add(const char *type, const char *id, const QDict *qdict,
620 Visitor *v, Error **errp)
625 Error *local_err = NULL;
627 klass = object_class_by_name(type);
629 error_setg(errp, "invalid object type: %s", type);
633 if (!object_class_dynamic_cast(klass, TYPE_USER_CREATABLE)) {
634 error_setg(errp, "object type '%s' isn't supported by object-add",
639 if (object_class_is_abstract(klass)) {
640 error_setg(errp, "object type '%s' is abstract", type);
644 obj = object_new(type);
646 for (e = qdict_first(qdict); e; e = qdict_next(qdict, e)) {
647 object_property_set(obj, v, e->key, &local_err);
654 object_property_add_child(object_get_objects_root(),
655 id, obj, &local_err);
660 user_creatable_complete(obj, &local_err);
662 object_property_del(object_get_objects_root(),
668 error_propagate(errp, local_err);
673 void qmp_object_add(const char *type, const char *id,
674 bool has_props, QObject *props, Error **errp)
676 const QDict *pdict = NULL;
677 QmpInputVisitor *qiv;
680 pdict = qobject_to_qdict(props);
682 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, "props", "dict");
687 qiv = qmp_input_visitor_new(props);
688 object_add(type, id, pdict, qmp_input_get_visitor(qiv), errp);
689 qmp_input_visitor_cleanup(qiv);
692 void qmp_object_del(const char *id, Error **errp)
697 container = object_get_objects_root();
698 obj = object_resolve_path_component(container, id);
700 error_setg(errp, "object id not found");
704 if (!user_creatable_can_be_deleted(USER_CREATABLE(obj), errp)) {
705 error_setg(errp, "%s is in use, can not be deleted", id);
708 object_unparent(obj);
711 MemoryDeviceInfoList *qmp_query_memory_devices(Error **errp)
713 MemoryDeviceInfoList *head = NULL;
714 MemoryDeviceInfoList **prev = &head;
716 qmp_pc_dimm_device_list(qdev_get_machine(), &prev);
721 ACPIOSTInfoList *qmp_query_acpi_ospm_status(Error **errp)
724 ACPIOSTInfoList *head = NULL;
725 ACPIOSTInfoList **prev = &head;
726 Object *obj = object_resolve_path_type("", TYPE_ACPI_DEVICE_IF, &ambig);
729 AcpiDeviceIfClass *adevc = ACPI_DEVICE_IF_GET_CLASS(obj);
730 AcpiDeviceIf *adev = ACPI_DEVICE_IF(obj);
732 adevc->ospm_status(adev, &prev);
734 error_setg(errp, "command is not supported, missing ACPI device");