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/osdep.h"
17 #include "qemu-version.h"
18 #include "qemu/cutils.h"
19 #include "qemu/option.h"
20 #include "monitor/monitor.h"
21 #include "sysemu/sysemu.h"
22 #include "qemu/config-file.h"
23 #include "qemu/uuid.h"
24 #include "chardev/char.h"
25 #include "ui/qemu-spice.h"
27 #include "sysemu/kvm.h"
28 #include "sysemu/arch_init.h"
30 #include "sysemu/blockdev.h"
31 #include "sysemu/block-backend.h"
32 #include "qom/qom-qobject.h"
33 #include "qapi/error.h"
34 #include "qapi/qapi-commands-block-core.h"
35 #include "qapi/qapi-commands-misc.h"
36 #include "qapi/qapi-commands-ui.h"
37 #include "qapi/qmp/qdict.h"
38 #include "qapi/qmp/qerror.h"
39 #include "qapi/qobject-input-visitor.h"
40 #include "hw/boards.h"
41 #include "qom/object_interfaces.h"
42 #include "hw/mem/memory-device.h"
43 #include "hw/acpi/acpi_dev_interface.h"
45 NameInfo
*qmp_query_name(Error
**errp
)
47 NameInfo
*info
= g_malloc0(sizeof(*info
));
50 info
->has_name
= true;
51 info
->name
= g_strdup(qemu_name
);
57 VersionInfo
*qmp_query_version(Error
**errp
)
59 VersionInfo
*info
= g_new0(VersionInfo
, 1);
61 info
->qemu
= g_new0(VersionTriple
, 1);
62 info
->qemu
->major
= QEMU_VERSION_MAJOR
;
63 info
->qemu
->minor
= QEMU_VERSION_MINOR
;
64 info
->qemu
->micro
= QEMU_VERSION_MICRO
;
65 info
->package
= g_strdup(QEMU_PKGVERSION
);
70 KvmInfo
*qmp_query_kvm(Error
**errp
)
72 KvmInfo
*info
= g_malloc0(sizeof(*info
));
74 info
->enabled
= kvm_enabled();
75 info
->present
= kvm_available();
80 UuidInfo
*qmp_query_uuid(Error
**errp
)
82 UuidInfo
*info
= g_malloc0(sizeof(*info
));
84 info
->UUID
= qemu_uuid_unparse_strdup(&qemu_uuid
);
88 void qmp_quit(Error
**errp
)
91 qemu_system_shutdown_request(SHUTDOWN_CAUSE_HOST_QMP_QUIT
);
94 void qmp_stop(Error
**errp
)
96 /* if there is a dump in background, we should wait until the dump
98 if (dump_in_progress()) {
99 error_setg(errp
, "There is a dump in process, please wait.");
103 if (runstate_check(RUN_STATE_INMIGRATE
)) {
106 vm_stop(RUN_STATE_PAUSED
);
110 void qmp_system_reset(Error
**errp
)
112 qemu_system_reset_request(SHUTDOWN_CAUSE_HOST_QMP_SYSTEM_RESET
);
115 void qmp_system_powerdown(Error
**erp
)
117 qemu_system_powerdown_request();
120 void qmp_cpu_add(int64_t id
, Error
**errp
)
124 mc
= MACHINE_GET_CLASS(current_machine
);
125 if (mc
->hot_add_cpu
) {
126 mc
->hot_add_cpu(id
, errp
);
128 error_setg(errp
, "Not supported");
132 void qmp_x_exit_preconfig(Error
**errp
)
134 if (!runstate_check(RUN_STATE_PRECONFIG
)) {
135 error_setg(errp
, "The command is permitted only in '%s' state",
136 RunState_str(RUN_STATE_PRECONFIG
));
139 qemu_exit_preconfig_request();
142 void qmp_cont(Error
**errp
)
145 Error
*local_err
= NULL
;
147 /* if there is a dump in background, we should wait until the dump
149 if (dump_in_progress()) {
150 error_setg(errp
, "There is a dump in process, please wait.");
154 if (runstate_needs_reset()) {
155 error_setg(errp
, "Resetting the Virtual Machine is required");
157 } else if (runstate_check(RUN_STATE_SUSPENDED
)) {
161 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
162 blk_iostatus_reset(blk
);
165 /* Continuing after completed migration. Images have been inactivated to
166 * allow the destination to take control. Need to get control back now.
168 * If there are no inactive block nodes (e.g. because the VM was just
169 * paused rather than completing a migration), bdrv_inactivate_all() simply
170 * doesn't do anything. */
171 bdrv_invalidate_cache_all(&local_err
);
173 error_propagate(errp
, local_err
);
177 if (runstate_check(RUN_STATE_INMIGRATE
)) {
184 void qmp_system_wakeup(Error
**errp
)
186 if (!qemu_wakeup_suspend_enabled()) {
188 "wake-up from suspend is not supported by this guest");
192 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_OTHER
, errp
);
195 ObjectPropertyInfoList
*qmp_qom_list(const char *path
, Error
**errp
)
198 bool ambiguous
= false;
199 ObjectPropertyInfoList
*props
= NULL
;
200 ObjectProperty
*prop
;
201 ObjectPropertyIterator iter
;
203 obj
= object_resolve_path(path
, &ambiguous
);
206 error_setg(errp
, "Path '%s' is ambiguous", path
);
208 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
209 "Device '%s' not found", path
);
214 object_property_iter_init(&iter
, obj
);
215 while ((prop
= object_property_iter_next(&iter
))) {
216 ObjectPropertyInfoList
*entry
= g_malloc0(sizeof(*entry
));
218 entry
->value
= g_malloc0(sizeof(ObjectPropertyInfo
));
222 entry
->value
->name
= g_strdup(prop
->name
);
223 entry
->value
->type
= g_strdup(prop
->type
);
229 void qmp_qom_set(const char *path
, const char *property
, QObject
*value
,
234 obj
= object_resolve_path(path
, NULL
);
236 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
237 "Device '%s' not found", path
);
241 object_property_set_qobject(obj
, value
, property
, errp
);
244 QObject
*qmp_qom_get(const char *path
, const char *property
, Error
**errp
)
248 obj
= object_resolve_path(path
, NULL
);
250 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
251 "Device '%s' not found", path
);
255 return object_property_get_qobject(obj
, property
, errp
);
258 void qmp_set_password(const char *protocol
, const char *password
,
259 bool has_connected
, const char *connected
, Error
**errp
)
261 int disconnect_if_connected
= 0;
262 int fail_if_connected
= 0;
266 if (strcmp(connected
, "fail") == 0) {
267 fail_if_connected
= 1;
268 } else if (strcmp(connected
, "disconnect") == 0) {
269 disconnect_if_connected
= 1;
270 } else if (strcmp(connected
, "keep") == 0) {
273 error_setg(errp
, QERR_INVALID_PARAMETER
, "connected");
278 if (strcmp(protocol
, "spice") == 0) {
279 if (!qemu_using_spice(errp
)) {
282 rc
= qemu_spice_set_passwd(password
, fail_if_connected
,
283 disconnect_if_connected
);
285 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
290 if (strcmp(protocol
, "vnc") == 0) {
291 if (fail_if_connected
|| disconnect_if_connected
) {
292 /* vnc supports "connected=keep" only */
293 error_setg(errp
, QERR_INVALID_PARAMETER
, "connected");
296 /* Note that setting an empty password will not disable login through
298 rc
= vnc_display_password(NULL
, password
);
300 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
305 error_setg(errp
, QERR_INVALID_PARAMETER
, "protocol");
308 void qmp_expire_password(const char *protocol
, const char *whenstr
,
314 if (strcmp(whenstr
, "now") == 0) {
316 } else if (strcmp(whenstr
, "never") == 0) {
318 } else if (whenstr
[0] == '+') {
319 when
= time(NULL
) + strtoull(whenstr
+1, NULL
, 10);
321 when
= strtoull(whenstr
, NULL
, 10);
324 if (strcmp(protocol
, "spice") == 0) {
325 if (!qemu_using_spice(errp
)) {
328 rc
= qemu_spice_set_pw_expire(when
);
330 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
335 if (strcmp(protocol
, "vnc") == 0) {
336 rc
= vnc_display_pw_expire(NULL
, when
);
338 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
343 error_setg(errp
, QERR_INVALID_PARAMETER
, "protocol");
347 void qmp_change_vnc_password(const char *password
, Error
**errp
)
349 if (vnc_display_password(NULL
, password
) < 0) {
350 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
354 static void qmp_change_vnc_listen(const char *target
, Error
**errp
)
356 QemuOptsList
*olist
= qemu_find_opts("vnc");
359 if (strstr(target
, "id=")) {
360 error_setg(errp
, "id not supported");
364 opts
= qemu_opts_find(olist
, "default");
368 opts
= vnc_parse(target
, errp
);
373 vnc_display_open("default", errp
);
376 static void qmp_change_vnc(const char *target
, bool has_arg
, const char *arg
,
379 if (strcmp(target
, "passwd") == 0 || strcmp(target
, "password") == 0) {
381 error_setg(errp
, QERR_MISSING_PARAMETER
, "password");
383 qmp_change_vnc_password(arg
, errp
);
386 qmp_change_vnc_listen(target
, errp
);
389 #endif /* !CONFIG_VNC */
391 void qmp_change(const char *device
, const char *target
,
392 bool has_arg
, const char *arg
, Error
**errp
)
394 if (strcmp(device
, "vnc") == 0) {
396 qmp_change_vnc(target
, has_arg
, arg
, errp
);
398 error_setg(errp
, QERR_FEATURE_DISABLED
, "vnc");
401 qmp_blockdev_change_medium(true, device
, false, NULL
, target
,
402 has_arg
, arg
, false, 0, errp
);
406 static void qom_list_types_tramp(ObjectClass
*klass
, void *data
)
408 ObjectTypeInfoList
*e
, **pret
= data
;
409 ObjectTypeInfo
*info
;
410 ObjectClass
*parent
= object_class_get_parent(klass
);
412 info
= g_malloc0(sizeof(*info
));
413 info
->name
= g_strdup(object_class_get_name(klass
));
414 info
->has_abstract
= info
->abstract
= object_class_is_abstract(klass
);
416 info
->has_parent
= true;
417 info
->parent
= g_strdup(object_class_get_name(parent
));
420 e
= g_malloc0(sizeof(*e
));
426 ObjectTypeInfoList
*qmp_qom_list_types(bool has_implements
,
427 const char *implements
,
432 ObjectTypeInfoList
*ret
= NULL
;
434 object_class_foreach(qom_list_types_tramp
, implements
, abstract
, &ret
);
439 /* Return a DevicePropertyInfo for a qdev property.
441 * If a qdev property with the given name does not exist, use the given default
442 * type. If the qdev property info should not be shown, return NULL.
444 * The caller must free the return value.
446 static ObjectPropertyInfo
*make_device_property_info(ObjectClass
*klass
,
448 const char *default_type
,
449 const char *description
)
451 ObjectPropertyInfo
*info
;
455 for (prop
= DEVICE_CLASS(klass
)->props
; prop
&& prop
->name
; prop
++) {
456 if (strcmp(name
, prop
->name
) != 0) {
461 * TODO Properties without a parser are just for dirty hacks.
462 * qdev_prop_ptr is the only such PropertyInfo. It's marked
463 * for removal. This conditional should be removed along with
466 if (!prop
->info
->set
&& !prop
->info
->create
) {
467 return NULL
; /* no way to set it, don't show */
470 info
= g_malloc0(sizeof(*info
));
471 info
->name
= g_strdup(prop
->name
);
472 info
->type
= default_type
? g_strdup(default_type
)
473 : g_strdup(prop
->info
->name
);
474 info
->has_description
= !!prop
->info
->description
;
475 info
->description
= g_strdup(prop
->info
->description
);
478 klass
= object_class_get_parent(klass
);
479 } while (klass
!= object_class_by_name(TYPE_DEVICE
));
481 /* Not a qdev property, use the default type */
482 info
= g_malloc0(sizeof(*info
));
483 info
->name
= g_strdup(name
);
484 info
->type
= g_strdup(default_type
);
485 info
->has_description
= !!description
;
486 info
->description
= g_strdup(description
);
491 ObjectPropertyInfoList
*qmp_device_list_properties(const char *typename
,
496 ObjectProperty
*prop
;
497 ObjectPropertyIterator iter
;
498 ObjectPropertyInfoList
*prop_list
= NULL
;
500 klass
= object_class_by_name(typename
);
502 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
503 "Device '%s' not found", typename
);
507 klass
= object_class_dynamic_cast(klass
, TYPE_DEVICE
);
509 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "typename", TYPE_DEVICE
);
513 if (object_class_is_abstract(klass
)) {
514 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "typename",
515 "non-abstract device type");
519 obj
= object_new(typename
);
521 object_property_iter_init(&iter
, obj
);
522 while ((prop
= object_property_iter_next(&iter
))) {
523 ObjectPropertyInfo
*info
;
524 ObjectPropertyInfoList
*entry
;
526 /* Skip Object and DeviceState properties */
527 if (strcmp(prop
->name
, "type") == 0 ||
528 strcmp(prop
->name
, "realized") == 0 ||
529 strcmp(prop
->name
, "hotpluggable") == 0 ||
530 strcmp(prop
->name
, "hotplugged") == 0 ||
531 strcmp(prop
->name
, "parent_bus") == 0) {
535 /* Skip legacy properties since they are just string versions of
536 * properties that we already list.
538 if (strstart(prop
->name
, "legacy-", NULL
)) {
542 info
= make_device_property_info(klass
, prop
->name
, prop
->type
,
548 entry
= g_malloc0(sizeof(*entry
));
550 entry
->next
= prop_list
;
559 ObjectPropertyInfoList
*qmp_qom_list_properties(const char *typename
,
564 ObjectProperty
*prop
;
565 ObjectPropertyIterator iter
;
566 ObjectPropertyInfoList
*prop_list
= NULL
;
568 klass
= object_class_by_name(typename
);
570 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
571 "Class '%s' not found", typename
);
575 klass
= object_class_dynamic_cast(klass
, TYPE_OBJECT
);
577 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "typename", TYPE_OBJECT
);
581 if (object_class_is_abstract(klass
)) {
582 object_class_property_iter_init(&iter
, klass
);
584 obj
= object_new(typename
);
585 object_property_iter_init(&iter
, obj
);
587 while ((prop
= object_property_iter_next(&iter
))) {
588 ObjectPropertyInfo
*info
;
589 ObjectPropertyInfoList
*entry
;
591 info
= g_malloc0(sizeof(*info
));
592 info
->name
= g_strdup(prop
->name
);
593 info
->type
= g_strdup(prop
->type
);
594 info
->has_description
= !!prop
->description
;
595 info
->description
= g_strdup(prop
->description
);
597 entry
= g_malloc0(sizeof(*entry
));
599 entry
->next
= prop_list
;
608 CpuDefinitionInfoList
*qmp_query_cpu_definitions(Error
**errp
)
610 return arch_query_cpu_definitions(errp
);
613 CpuModelExpansionInfo
*qmp_query_cpu_model_expansion(CpuModelExpansionType type
,
617 return arch_query_cpu_model_expansion(type
, model
, errp
);
620 CpuModelCompareInfo
*qmp_query_cpu_model_comparison(CpuModelInfo
*modela
,
621 CpuModelInfo
*modelb
,
624 return arch_query_cpu_model_comparison(modela
, modelb
, errp
);
627 CpuModelBaselineInfo
*qmp_query_cpu_model_baseline(CpuModelInfo
*modela
,
628 CpuModelInfo
*modelb
,
631 return arch_query_cpu_model_baseline(modela
, modelb
, errp
);
634 void qmp_add_client(const char *protocol
, const char *fdname
,
635 bool has_skipauth
, bool skipauth
, bool has_tls
, bool tls
,
641 fd
= monitor_get_fd(cur_mon
, fdname
, errp
);
646 if (strcmp(protocol
, "spice") == 0) {
647 if (!qemu_using_spice(errp
)) {
651 skipauth
= has_skipauth
? skipauth
: false;
652 tls
= has_tls
? tls
: false;
653 if (qemu_spice_display_add_client(fd
, skipauth
, tls
) < 0) {
654 error_setg(errp
, "spice failed to add client");
659 } else if (strcmp(protocol
, "vnc") == 0) {
660 skipauth
= has_skipauth
? skipauth
: false;
661 vnc_display_add_client(NULL
, fd
, skipauth
);
664 } else if ((s
= qemu_chr_find(protocol
)) != NULL
) {
665 if (qemu_chr_add_client(s
, fd
) < 0) {
666 error_setg(errp
, "failed to add client");
673 error_setg(errp
, "protocol '%s' is invalid", protocol
);
678 void qmp_object_add(const char *type
, const char *id
,
679 bool has_props
, QObject
*props
, Error
**errp
)
686 pdict
= qobject_to(QDict
, props
);
688 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, "props", "dict");
696 v
= qobject_input_visitor_new(QOBJECT(pdict
));
697 obj
= user_creatable_add_type(type
, id
, pdict
, v
, errp
);
702 qobject_unref(pdict
);
705 void qmp_object_del(const char *id
, Error
**errp
)
707 user_creatable_del(id
, errp
);
710 MemoryDeviceInfoList
*qmp_query_memory_devices(Error
**errp
)
712 return qmp_memory_device_list();
715 ACPIOSTInfoList
*qmp_query_acpi_ospm_status(Error
**errp
)
718 ACPIOSTInfoList
*head
= NULL
;
719 ACPIOSTInfoList
**prev
= &head
;
720 Object
*obj
= object_resolve_path_type("", TYPE_ACPI_DEVICE_IF
, &ambig
);
723 AcpiDeviceIfClass
*adevc
= ACPI_DEVICE_IF_GET_CLASS(obj
);
724 AcpiDeviceIf
*adev
= ACPI_DEVICE_IF(obj
);
726 adevc
->ospm_status(adev
, &prev
);
728 error_setg(errp
, "command is not supported, missing ACPI device");
734 MemoryInfo
*qmp_query_memory_size_summary(Error
**errp
)
736 MemoryInfo
*mem_info
= g_malloc0(sizeof(MemoryInfo
));
738 mem_info
->base_memory
= ram_size
;
740 mem_info
->plugged_memory
= get_plugged_memory_size();
741 mem_info
->has_plugged_memory
=
742 mem_info
->plugged_memory
!= (uint64_t)-1;