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 "sysemu/sysemu.h"
18 #include "qmp-commands.h"
19 #include "sysemu/char.h"
20 #include "ui/qemu-spice.h"
22 #include "sysemu/kvm.h"
23 #include "sysemu/arch_init.h"
25 #include "sysemu/blockdev.h"
26 #include "qom/qom-qobject.h"
27 #include "qapi/qmp/qobject.h"
28 #include "qapi/qmp-input-visitor.h"
29 #include "hw/boards.h"
30 #include "qom/object_interfaces.h"
31 #include "hw/mem/pc-dimm.h"
32 #include "hw/acpi/acpi_dev_interface.h"
34 NameInfo *qmp_query_name(Error **errp)
36 NameInfo *info = g_malloc0(sizeof(*info));
39 info->has_name = true;
40 info->name = g_strdup(qemu_name);
46 VersionInfo *qmp_query_version(Error **errp)
48 VersionInfo *info = g_malloc0(sizeof(*info));
49 const char *version = QEMU_VERSION;
52 info->qemu.major = strtol(version, &tmp, 10);
54 info->qemu.minor = strtol(tmp, &tmp, 10);
56 info->qemu.micro = strtol(tmp, &tmp, 10);
57 info->package = g_strdup(QEMU_PKGVERSION);
62 KvmInfo *qmp_query_kvm(Error **errp)
64 KvmInfo *info = g_malloc0(sizeof(*info));
66 info->enabled = kvm_enabled();
67 info->present = kvm_available();
72 UuidInfo *qmp_query_uuid(Error **errp)
74 UuidInfo *info = g_malloc0(sizeof(*info));
77 snprintf(uuid, sizeof(uuid), UUID_FMT, qemu_uuid[0], qemu_uuid[1],
78 qemu_uuid[2], qemu_uuid[3], qemu_uuid[4], qemu_uuid[5],
79 qemu_uuid[6], qemu_uuid[7], qemu_uuid[8], qemu_uuid[9],
80 qemu_uuid[10], qemu_uuid[11], qemu_uuid[12], qemu_uuid[13],
81 qemu_uuid[14], qemu_uuid[15]);
83 info->UUID = g_strdup(uuid);
87 void qmp_quit(Error **errp)
90 qemu_system_shutdown_request();
93 void qmp_stop(Error **errp)
95 if (runstate_check(RUN_STATE_INMIGRATE)) {
98 vm_stop(RUN_STATE_PAUSED);
102 void qmp_system_reset(Error **errp)
104 qemu_system_reset_request();
107 void qmp_system_powerdown(Error **erp)
109 qemu_system_powerdown_request();
112 void qmp_cpu(int64_t index, Error **errp)
114 /* Just do nothing */
117 void qmp_cpu_add(int64_t id, Error **errp)
121 mc = MACHINE_GET_CLASS(current_machine);
122 if (mc->hot_add_cpu) {
123 mc->hot_add_cpu(id, errp);
125 error_setg(errp, "Not supported");
130 /* If VNC support is enabled, the "true" query-vnc command is
131 defined in the VNC subsystem */
132 VncInfo *qmp_query_vnc(Error **errp)
134 error_set(errp, QERR_FEATURE_DISABLED, "vnc");
138 VncInfo2List *qmp_query_vnc_servers(Error **errp)
140 error_set(errp, QERR_FEATURE_DISABLED, "vnc");
147 * qmp-commands.hx ensures that QMP command query-spice exists only
148 * #ifdef CONFIG_SPICE. Necessary for an accurate query-commands
149 * result. However, the QAPI schema is blissfully unaware of that,
150 * and the QAPI code generator happily generates a dead
151 * qmp_marshal_input_query_spice() that calls qmp_query_spice().
152 * Provide it one, or else linking fails.
153 * FIXME Educate the QAPI schema on CONFIG_SPICE.
155 SpiceInfo *qmp_query_spice(Error **errp)
161 void qmp_cont(Error **errp)
163 Error *local_err = NULL;
164 BlockDriverState *bs;
166 if (runstate_needs_reset()) {
167 error_setg(errp, "Resetting the Virtual Machine is required");
169 } else if (runstate_check(RUN_STATE_SUSPENDED)) {
173 for (bs = bdrv_next(NULL); bs; bs = bdrv_next(bs)) {
174 bdrv_iostatus_reset(bs);
176 for (bs = bdrv_next(NULL); bs; bs = bdrv_next(bs)) {
177 bdrv_add_key(bs, NULL, &local_err);
179 error_propagate(errp, local_err);
184 if (runstate_check(RUN_STATE_INMIGRATE)) {
191 void qmp_system_wakeup(Error **errp)
193 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_OTHER);
196 ObjectPropertyInfoList *qmp_qom_list(const char *path, Error **errp)
199 bool ambiguous = false;
200 ObjectPropertyInfoList *props = NULL;
201 ObjectProperty *prop;
203 obj = object_resolve_path(path, &ambiguous);
206 error_setg(errp, "Path '%s' is ambiguous", path);
208 error_set(errp, QERR_DEVICE_NOT_FOUND, path);
213 QTAILQ_FOREACH(prop, &obj->properties, node) {
214 ObjectPropertyInfoList *entry = g_malloc0(sizeof(*entry));
216 entry->value = g_malloc0(sizeof(ObjectPropertyInfo));
220 entry->value->name = g_strdup(prop->name);
221 entry->value->type = g_strdup(prop->type);
227 /* FIXME: teach qapi about how to pass through Visitors */
228 int qmp_qom_set(Monitor *mon, const QDict *qdict, QObject **ret)
230 const char *path = qdict_get_str(qdict, "path");
231 const char *property = qdict_get_str(qdict, "property");
232 QObject *value = qdict_get(qdict, "value");
233 Error *local_err = NULL;
236 obj = object_resolve_path(path, NULL);
238 error_set(&local_err, QERR_DEVICE_NOT_FOUND, path);
242 object_property_set_qobject(obj, value, property, &local_err);
246 qerror_report_err(local_err);
247 error_free(local_err);
254 int qmp_qom_get(Monitor *mon, const QDict *qdict, QObject **ret)
256 const char *path = qdict_get_str(qdict, "path");
257 const char *property = qdict_get_str(qdict, "property");
258 Error *local_err = NULL;
261 obj = object_resolve_path(path, NULL);
263 error_set(&local_err, QERR_DEVICE_NOT_FOUND, path);
267 *ret = object_property_get_qobject(obj, property, &local_err);
271 qerror_report_err(local_err);
272 error_free(local_err);
279 void qmp_set_password(const char *protocol, const char *password,
280 bool has_connected, const char *connected, Error **errp)
282 int disconnect_if_connected = 0;
283 int fail_if_connected = 0;
287 if (strcmp(connected, "fail") == 0) {
288 fail_if_connected = 1;
289 } else if (strcmp(connected, "disconnect") == 0) {
290 disconnect_if_connected = 1;
291 } else if (strcmp(connected, "keep") == 0) {
294 error_set(errp, QERR_INVALID_PARAMETER, "connected");
299 if (strcmp(protocol, "spice") == 0) {
300 if (!qemu_using_spice(errp)) {
303 rc = qemu_spice_set_passwd(password, fail_if_connected,
304 disconnect_if_connected);
306 error_set(errp, QERR_SET_PASSWD_FAILED);
311 if (strcmp(protocol, "vnc") == 0) {
312 if (fail_if_connected || disconnect_if_connected) {
313 /* vnc supports "connected=keep" only */
314 error_set(errp, QERR_INVALID_PARAMETER, "connected");
317 /* Note that setting an empty password will not disable login through
319 rc = vnc_display_password(NULL, password);
321 error_set(errp, QERR_SET_PASSWD_FAILED);
326 error_set(errp, QERR_INVALID_PARAMETER, "protocol");
329 void qmp_expire_password(const char *protocol, const char *whenstr,
335 if (strcmp(whenstr, "now") == 0) {
337 } else if (strcmp(whenstr, "never") == 0) {
339 } else if (whenstr[0] == '+') {
340 when = time(NULL) + strtoull(whenstr+1, NULL, 10);
342 when = strtoull(whenstr, NULL, 10);
345 if (strcmp(protocol, "spice") == 0) {
346 if (!qemu_using_spice(errp)) {
349 rc = qemu_spice_set_pw_expire(when);
351 error_set(errp, QERR_SET_PASSWD_FAILED);
356 if (strcmp(protocol, "vnc") == 0) {
357 rc = vnc_display_pw_expire(NULL, when);
359 error_set(errp, QERR_SET_PASSWD_FAILED);
364 error_set(errp, QERR_INVALID_PARAMETER, "protocol");
368 void qmp_change_vnc_password(const char *password, Error **errp)
370 if (vnc_display_password(NULL, password) < 0) {
371 error_set(errp, QERR_SET_PASSWD_FAILED);
375 static void qmp_change_vnc_listen(const char *target, Error **errp)
377 QemuOptsList *olist = qemu_find_opts("vnc");
380 if (strstr(target, "id=")) {
381 error_setg(errp, "id not supported");
385 opts = qemu_opts_find(olist, "default");
389 opts = vnc_parse_func(target);
394 vnc_auto_assign_id(olist, opts);
395 vnc_display_open("default", errp);
398 static void qmp_change_vnc(const char *target, bool has_arg, const char *arg,
401 if (strcmp(target, "passwd") == 0 || strcmp(target, "password") == 0) {
403 error_set(errp, QERR_MISSING_PARAMETER, "password");
405 qmp_change_vnc_password(arg, errp);
408 qmp_change_vnc_listen(target, errp);
412 void qmp_change_vnc_password(const char *password, Error **errp)
414 error_set(errp, QERR_FEATURE_DISABLED, "vnc");
416 static void qmp_change_vnc(const char *target, bool has_arg, const char *arg,
419 error_set(errp, QERR_FEATURE_DISABLED, "vnc");
421 #endif /* !CONFIG_VNC */
423 void qmp_change(const char *device, const char *target,
424 bool has_arg, const char *arg, Error **errp)
426 if (strcmp(device, "vnc") == 0) {
427 qmp_change_vnc(target, has_arg, arg, errp);
429 qmp_change_blockdev(device, target, arg, errp);
433 static void qom_list_types_tramp(ObjectClass *klass, void *data)
435 ObjectTypeInfoList *e, **pret = data;
436 ObjectTypeInfo *info;
438 info = g_malloc0(sizeof(*info));
439 info->name = g_strdup(object_class_get_name(klass));
441 e = g_malloc0(sizeof(*e));
447 ObjectTypeInfoList *qmp_qom_list_types(bool has_implements,
448 const char *implements,
453 ObjectTypeInfoList *ret = NULL;
455 object_class_foreach(qom_list_types_tramp, implements, abstract, &ret);
460 /* Return a DevicePropertyInfo for a qdev property.
462 * If a qdev property with the given name does not exist, use the given default
463 * type. If the qdev property info should not be shown, return NULL.
465 * The caller must free the return value.
467 static DevicePropertyInfo *make_device_property_info(ObjectClass *klass,
469 const char *default_type,
470 const char *description)
472 DevicePropertyInfo *info;
476 for (prop = DEVICE_CLASS(klass)->props; prop && prop->name; prop++) {
477 if (strcmp(name, prop->name) != 0) {
482 * TODO Properties without a parser are just for dirty hacks.
483 * qdev_prop_ptr is the only such PropertyInfo. It's marked
484 * for removal. This conditional should be removed along with
487 if (!prop->info->set) {
488 return NULL; /* no way to set it, don't show */
491 info = g_malloc0(sizeof(*info));
492 info->name = g_strdup(prop->name);
493 info->type = g_strdup(prop->info->name);
494 info->has_description = !!prop->info->description;
495 info->description = g_strdup(prop->info->description);
498 klass = object_class_get_parent(klass);
499 } while (klass != object_class_by_name(TYPE_DEVICE));
501 /* Not a qdev property, use the default type */
502 info = g_malloc0(sizeof(*info));
503 info->name = g_strdup(name);
504 info->type = g_strdup(default_type);
505 info->has_description = !!description;
506 info->description = g_strdup(description);
511 DevicePropertyInfoList *qmp_device_list_properties(const char *typename,
516 ObjectProperty *prop;
517 DevicePropertyInfoList *prop_list = NULL;
519 klass = object_class_by_name(typename);
521 error_set(errp, QERR_DEVICE_NOT_FOUND, typename);
525 klass = object_class_dynamic_cast(klass, TYPE_DEVICE);
527 error_set(errp, QERR_INVALID_PARAMETER_VALUE,
528 "name", TYPE_DEVICE);
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(container_get(object_get_root(), "/objects"),
655 id, obj, &local_err);
660 user_creatable_complete(obj, &local_err);
662 object_property_del(container_get(object_get_root(), "/objects"),
668 error_propagate(errp, local_err);
673 int qmp_object_add(Monitor *mon, const QDict *qdict, QObject **ret)
675 const char *type = qdict_get_str(qdict, "qom-type");
676 const char *id = qdict_get_str(qdict, "id");
677 QObject *props = qdict_get(qdict, "props");
678 const QDict *pdict = NULL;
679 Error *local_err = NULL;
680 QmpInputVisitor *qiv;
683 pdict = qobject_to_qdict(props);
685 error_set(&local_err, QERR_INVALID_PARAMETER_TYPE, "props", "dict");
690 qiv = qmp_input_visitor_new(props);
691 object_add(type, id, pdict, qmp_input_get_visitor(qiv), &local_err);
692 qmp_input_visitor_cleanup(qiv);
696 qerror_report_err(local_err);
697 error_free(local_err);
704 void qmp_object_del(const char *id, Error **errp)
709 container = container_get(object_get_root(), "/objects");
710 obj = object_resolve_path_component(container, id);
712 error_setg(errp, "object id not found");
715 object_unparent(obj);
718 MemoryDeviceInfoList *qmp_query_memory_devices(Error **errp)
720 MemoryDeviceInfoList *head = NULL;
721 MemoryDeviceInfoList **prev = &head;
723 qmp_pc_dimm_device_list(qdev_get_machine(), &prev);
728 ACPIOSTInfoList *qmp_query_acpi_ospm_status(Error **errp)
731 ACPIOSTInfoList *head = NULL;
732 ACPIOSTInfoList **prev = &head;
733 Object *obj = object_resolve_path_type("", TYPE_ACPI_DEVICE_IF, &ambig);
736 AcpiDeviceIfClass *adevc = ACPI_DEVICE_IF_GET_CLASS(obj);
737 AcpiDeviceIf *adev = ACPI_DEVICE_IF(obj);
739 adevc->ospm_status(adev, &prev);
741 error_setg(errp, "command is not supported, missing ACPI device");