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;
213 ObjectPropertyIterator *iter;
215 obj = object_resolve_path(path, &ambiguous);
218 error_setg(errp, "Path '%s' is ambiguous", path);
220 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
221 "Device '%s' not found", path);
226 iter = object_property_iter_init(obj);
227 while ((prop = object_property_iter_next(iter))) {
228 ObjectPropertyInfoList *entry = g_malloc0(sizeof(*entry));
230 entry->value = g_malloc0(sizeof(ObjectPropertyInfo));
234 entry->value->name = g_strdup(prop->name);
235 entry->value->type = g_strdup(prop->type);
237 object_property_iter_free(iter);
242 void qmp_qom_set(const char *path, const char *property, QObject *value,
247 obj = object_resolve_path(path, NULL);
249 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
250 "Device '%s' not found", path);
254 object_property_set_qobject(obj, value, property, errp);
257 QObject *qmp_qom_get(const char *path, const char *property, Error **errp)
261 obj = object_resolve_path(path, NULL);
263 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
264 "Device '%s' not found", path);
268 return object_property_get_qobject(obj, property, errp);
271 void qmp_set_password(const char *protocol, const char *password,
272 bool has_connected, const char *connected, Error **errp)
274 int disconnect_if_connected = 0;
275 int fail_if_connected = 0;
279 if (strcmp(connected, "fail") == 0) {
280 fail_if_connected = 1;
281 } else if (strcmp(connected, "disconnect") == 0) {
282 disconnect_if_connected = 1;
283 } else if (strcmp(connected, "keep") == 0) {
286 error_setg(errp, QERR_INVALID_PARAMETER, "connected");
291 if (strcmp(protocol, "spice") == 0) {
292 if (!qemu_using_spice(errp)) {
295 rc = qemu_spice_set_passwd(password, fail_if_connected,
296 disconnect_if_connected);
298 error_setg(errp, QERR_SET_PASSWD_FAILED);
303 if (strcmp(protocol, "vnc") == 0) {
304 if (fail_if_connected || disconnect_if_connected) {
305 /* vnc supports "connected=keep" only */
306 error_setg(errp, QERR_INVALID_PARAMETER, "connected");
309 /* Note that setting an empty password will not disable login through
311 rc = vnc_display_password(NULL, password);
313 error_setg(errp, QERR_SET_PASSWD_FAILED);
318 error_setg(errp, QERR_INVALID_PARAMETER, "protocol");
321 void qmp_expire_password(const char *protocol, const char *whenstr,
327 if (strcmp(whenstr, "now") == 0) {
329 } else if (strcmp(whenstr, "never") == 0) {
331 } else if (whenstr[0] == '+') {
332 when = time(NULL) + strtoull(whenstr+1, NULL, 10);
334 when = strtoull(whenstr, NULL, 10);
337 if (strcmp(protocol, "spice") == 0) {
338 if (!qemu_using_spice(errp)) {
341 rc = qemu_spice_set_pw_expire(when);
343 error_setg(errp, QERR_SET_PASSWD_FAILED);
348 if (strcmp(protocol, "vnc") == 0) {
349 rc = vnc_display_pw_expire(NULL, when);
351 error_setg(errp, QERR_SET_PASSWD_FAILED);
356 error_setg(errp, QERR_INVALID_PARAMETER, "protocol");
360 void qmp_change_vnc_password(const char *password, Error **errp)
362 if (vnc_display_password(NULL, password) < 0) {
363 error_setg(errp, QERR_SET_PASSWD_FAILED);
367 static void qmp_change_vnc_listen(const char *target, Error **errp)
369 QemuOptsList *olist = qemu_find_opts("vnc");
372 if (strstr(target, "id=")) {
373 error_setg(errp, "id not supported");
377 opts = qemu_opts_find(olist, "default");
381 opts = vnc_parse(target, errp);
386 vnc_display_open("default", errp);
389 static void qmp_change_vnc(const char *target, bool has_arg, const char *arg,
392 if (strcmp(target, "passwd") == 0 || strcmp(target, "password") == 0) {
394 error_setg(errp, QERR_MISSING_PARAMETER, "password");
396 qmp_change_vnc_password(arg, errp);
399 qmp_change_vnc_listen(target, errp);
403 void qmp_change_vnc_password(const char *password, Error **errp)
405 error_setg(errp, QERR_FEATURE_DISABLED, "vnc");
407 static void qmp_change_vnc(const char *target, bool has_arg, const char *arg,
410 error_setg(errp, QERR_FEATURE_DISABLED, "vnc");
412 #endif /* !CONFIG_VNC */
414 void qmp_change(const char *device, const char *target,
415 bool has_arg, const char *arg, Error **errp)
417 if (strcmp(device, "vnc") == 0) {
418 qmp_change_vnc(target, has_arg, arg, errp);
420 qmp_blockdev_change_medium(device, target, has_arg, arg, false, 0,
425 static void qom_list_types_tramp(ObjectClass *klass, void *data)
427 ObjectTypeInfoList *e, **pret = data;
428 ObjectTypeInfo *info;
430 info = g_malloc0(sizeof(*info));
431 info->name = g_strdup(object_class_get_name(klass));
433 e = g_malloc0(sizeof(*e));
439 ObjectTypeInfoList *qmp_qom_list_types(bool has_implements,
440 const char *implements,
445 ObjectTypeInfoList *ret = NULL;
447 object_class_foreach(qom_list_types_tramp, implements, abstract, &ret);
452 /* Return a DevicePropertyInfo for a qdev property.
454 * If a qdev property with the given name does not exist, use the given default
455 * type. If the qdev property info should not be shown, return NULL.
457 * The caller must free the return value.
459 static DevicePropertyInfo *make_device_property_info(ObjectClass *klass,
461 const char *default_type,
462 const char *description)
464 DevicePropertyInfo *info;
468 for (prop = DEVICE_CLASS(klass)->props; prop && prop->name; prop++) {
469 if (strcmp(name, prop->name) != 0) {
474 * TODO Properties without a parser are just for dirty hacks.
475 * qdev_prop_ptr is the only such PropertyInfo. It's marked
476 * for removal. This conditional should be removed along with
479 if (!prop->info->set) {
480 return NULL; /* no way to set it, don't show */
483 info = g_malloc0(sizeof(*info));
484 info->name = g_strdup(prop->name);
485 info->type = g_strdup(prop->info->name);
486 info->has_description = !!prop->info->description;
487 info->description = g_strdup(prop->info->description);
490 klass = object_class_get_parent(klass);
491 } while (klass != object_class_by_name(TYPE_DEVICE));
493 /* Not a qdev property, use the default type */
494 info = g_malloc0(sizeof(*info));
495 info->name = g_strdup(name);
496 info->type = g_strdup(default_type);
497 info->has_description = !!description;
498 info->description = g_strdup(description);
503 DevicePropertyInfoList *qmp_device_list_properties(const char *typename,
508 ObjectProperty *prop;
509 ObjectPropertyIterator *iter;
510 DevicePropertyInfoList *prop_list = NULL;
512 klass = object_class_by_name(typename);
514 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
515 "Device '%s' not found", typename);
519 klass = object_class_dynamic_cast(klass, TYPE_DEVICE);
521 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "name", TYPE_DEVICE);
525 if (object_class_is_abstract(klass)) {
526 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "name",
527 "non-abstract device type");
531 if (DEVICE_CLASS(klass)->cannot_destroy_with_object_finalize_yet) {
532 error_setg(errp, "Can't list properties of device '%s'", typename);
536 obj = object_new(typename);
538 iter = object_property_iter_init(obj);
539 while ((prop = object_property_iter_next(iter))) {
540 DevicePropertyInfo *info;
541 DevicePropertyInfoList *entry;
543 /* Skip Object and DeviceState properties */
544 if (strcmp(prop->name, "type") == 0 ||
545 strcmp(prop->name, "realized") == 0 ||
546 strcmp(prop->name, "hotpluggable") == 0 ||
547 strcmp(prop->name, "hotplugged") == 0 ||
548 strcmp(prop->name, "parent_bus") == 0) {
552 /* Skip legacy properties since they are just string versions of
553 * properties that we already list.
555 if (strstart(prop->name, "legacy-", NULL)) {
559 info = make_device_property_info(klass, prop->name, prop->type,
565 entry = g_malloc0(sizeof(*entry));
567 entry->next = prop_list;
570 object_property_iter_free(iter);
577 CpuDefinitionInfoList *qmp_query_cpu_definitions(Error **errp)
579 return arch_query_cpu_definitions(errp);
582 void qmp_add_client(const char *protocol, const char *fdname,
583 bool has_skipauth, bool skipauth, bool has_tls, bool tls,
589 fd = monitor_get_fd(cur_mon, fdname, errp);
594 if (strcmp(protocol, "spice") == 0) {
595 if (!qemu_using_spice(errp)) {
599 skipauth = has_skipauth ? skipauth : false;
600 tls = has_tls ? tls : false;
601 if (qemu_spice_display_add_client(fd, skipauth, tls) < 0) {
602 error_setg(errp, "spice failed to add client");
607 } else if (strcmp(protocol, "vnc") == 0) {
608 skipauth = has_skipauth ? skipauth : false;
609 vnc_display_add_client(NULL, fd, skipauth);
612 } else if ((s = qemu_chr_find(protocol)) != NULL) {
613 if (qemu_chr_add_client(s, fd) < 0) {
614 error_setg(errp, "failed to add client");
621 error_setg(errp, "protocol '%s' is invalid", protocol);
625 void object_add(const char *type, const char *id, const QDict *qdict,
626 Visitor *v, Error **errp)
631 Error *local_err = NULL;
633 klass = object_class_by_name(type);
635 error_setg(errp, "invalid object type: %s", type);
639 if (!object_class_dynamic_cast(klass, TYPE_USER_CREATABLE)) {
640 error_setg(errp, "object type '%s' isn't supported by object-add",
645 if (object_class_is_abstract(klass)) {
646 error_setg(errp, "object type '%s' is abstract", type);
650 obj = object_new(type);
652 for (e = qdict_first(qdict); e; e = qdict_next(qdict, e)) {
653 object_property_set(obj, v, e->key, &local_err);
660 object_property_add_child(object_get_objects_root(),
661 id, obj, &local_err);
666 user_creatable_complete(obj, &local_err);
668 object_property_del(object_get_objects_root(),
674 error_propagate(errp, local_err);
679 void qmp_object_add(const char *type, const char *id,
680 bool has_props, QObject *props, Error **errp)
682 const QDict *pdict = NULL;
683 QmpInputVisitor *qiv;
686 pdict = qobject_to_qdict(props);
688 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, "props", "dict");
693 qiv = qmp_input_visitor_new(props);
694 object_add(type, id, pdict, qmp_input_get_visitor(qiv), errp);
695 qmp_input_visitor_cleanup(qiv);
698 void qmp_object_del(const char *id, Error **errp)
703 container = object_get_objects_root();
704 obj = object_resolve_path_component(container, id);
706 error_setg(errp, "object id not found");
710 if (!user_creatable_can_be_deleted(USER_CREATABLE(obj), errp)) {
711 error_setg(errp, "%s is in use, can not be deleted", id);
714 object_unparent(obj);
717 MemoryDeviceInfoList *qmp_query_memory_devices(Error **errp)
719 MemoryDeviceInfoList *head = NULL;
720 MemoryDeviceInfoList **prev = &head;
722 qmp_pc_dimm_device_list(qdev_get_machine(), &prev);
727 ACPIOSTInfoList *qmp_query_acpi_ospm_status(Error **errp)
730 ACPIOSTInfoList *head = NULL;
731 ACPIOSTInfoList **prev = &head;
732 Object *obj = object_resolve_path_type("", TYPE_ACPI_DEVICE_IF, &ambig);
735 AcpiDeviceIfClass *adevc = ACPI_DEVICE_IF_GET_CLASS(obj);
736 AcpiDeviceIf *adev = ACPI_DEVICE_IF(obj);
738 adevc->ospm_status(adev, &prev);
740 error_setg(errp, "command is not supported, missing ACPI device");