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/pc-dimm.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
);
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
);
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");
133 /* If VNC support is enabled, the "true" query-vnc command is
134 defined in the VNC subsystem */
135 VncInfo
*qmp_query_vnc(Error
**errp
)
137 error_setg(errp
, QERR_FEATURE_DISABLED
, "vnc");
141 VncInfo2List
*qmp_query_vnc_servers(Error
**errp
)
143 error_setg(errp
, QERR_FEATURE_DISABLED
, "vnc");
150 * qmp_unregister_commands_hack() ensures that QMP command query-spice
151 * exists only #ifdef CONFIG_SPICE. Necessary for an accurate
152 * query-commands result. However, the QAPI schema is blissfully
153 * unaware of that, and the QAPI code generator happily generates a
154 * dead qmp_marshal_query_spice() that calls qmp_query_spice().
155 * Provide it one, or else linking fails. FIXME Educate the QAPI
156 * schema on CONFIG_SPICE.
158 SpiceInfo
*qmp_query_spice(Error
**errp
)
164 void qmp_cont(Error
**errp
)
167 Error
*local_err
= NULL
;
169 /* if there is a dump in background, we should wait until the dump
171 if (dump_in_progress()) {
172 error_setg(errp
, "There is a dump in process, please wait.");
176 if (runstate_needs_reset()) {
177 error_setg(errp
, "Resetting the Virtual Machine is required");
179 } else if (runstate_check(RUN_STATE_SUSPENDED
)) {
183 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
184 blk_iostatus_reset(blk
);
187 /* Continuing after completed migration. Images have been inactivated to
188 * allow the destination to take control. Need to get control back now.
190 * If there are no inactive block nodes (e.g. because the VM was just
191 * paused rather than completing a migration), bdrv_inactivate_all() simply
192 * doesn't do anything. */
193 bdrv_invalidate_cache_all(&local_err
);
195 error_propagate(errp
, local_err
);
199 if (runstate_check(RUN_STATE_INMIGRATE
)) {
206 void qmp_system_wakeup(Error
**errp
)
208 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_OTHER
);
211 ObjectPropertyInfoList
*qmp_qom_list(const char *path
, Error
**errp
)
214 bool ambiguous
= false;
215 ObjectPropertyInfoList
*props
= NULL
;
216 ObjectProperty
*prop
;
217 ObjectPropertyIterator iter
;
219 obj
= object_resolve_path(path
, &ambiguous
);
222 error_setg(errp
, "Path '%s' is ambiguous", path
);
224 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
225 "Device '%s' not found", path
);
230 object_property_iter_init(&iter
, obj
);
231 while ((prop
= object_property_iter_next(&iter
))) {
232 ObjectPropertyInfoList
*entry
= g_malloc0(sizeof(*entry
));
234 entry
->value
= g_malloc0(sizeof(ObjectPropertyInfo
));
238 entry
->value
->name
= g_strdup(prop
->name
);
239 entry
->value
->type
= g_strdup(prop
->type
);
245 void qmp_qom_set(const char *path
, const char *property
, QObject
*value
,
250 obj
= object_resolve_path(path
, NULL
);
252 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
253 "Device '%s' not found", path
);
257 object_property_set_qobject(obj
, value
, property
, errp
);
260 QObject
*qmp_qom_get(const char *path
, const char *property
, Error
**errp
)
264 obj
= object_resolve_path(path
, NULL
);
266 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
267 "Device '%s' not found", path
);
271 return object_property_get_qobject(obj
, property
, errp
);
274 void qmp_set_password(const char *protocol
, const char *password
,
275 bool has_connected
, const char *connected
, Error
**errp
)
277 int disconnect_if_connected
= 0;
278 int fail_if_connected
= 0;
282 if (strcmp(connected
, "fail") == 0) {
283 fail_if_connected
= 1;
284 } else if (strcmp(connected
, "disconnect") == 0) {
285 disconnect_if_connected
= 1;
286 } else if (strcmp(connected
, "keep") == 0) {
289 error_setg(errp
, QERR_INVALID_PARAMETER
, "connected");
294 if (strcmp(protocol
, "spice") == 0) {
295 if (!qemu_using_spice(errp
)) {
298 rc
= qemu_spice_set_passwd(password
, fail_if_connected
,
299 disconnect_if_connected
);
301 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
306 if (strcmp(protocol
, "vnc") == 0) {
307 if (fail_if_connected
|| disconnect_if_connected
) {
308 /* vnc supports "connected=keep" only */
309 error_setg(errp
, QERR_INVALID_PARAMETER
, "connected");
312 /* Note that setting an empty password will not disable login through
314 rc
= vnc_display_password(NULL
, password
);
316 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
321 error_setg(errp
, QERR_INVALID_PARAMETER
, "protocol");
324 void qmp_expire_password(const char *protocol
, const char *whenstr
,
330 if (strcmp(whenstr
, "now") == 0) {
332 } else if (strcmp(whenstr
, "never") == 0) {
334 } else if (whenstr
[0] == '+') {
335 when
= time(NULL
) + strtoull(whenstr
+1, NULL
, 10);
337 when
= strtoull(whenstr
, NULL
, 10);
340 if (strcmp(protocol
, "spice") == 0) {
341 if (!qemu_using_spice(errp
)) {
344 rc
= qemu_spice_set_pw_expire(when
);
346 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
351 if (strcmp(protocol
, "vnc") == 0) {
352 rc
= vnc_display_pw_expire(NULL
, when
);
354 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
359 error_setg(errp
, QERR_INVALID_PARAMETER
, "protocol");
363 void qmp_change_vnc_password(const char *password
, Error
**errp
)
365 if (vnc_display_password(NULL
, password
) < 0) {
366 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
370 static void qmp_change_vnc_listen(const char *target
, Error
**errp
)
372 QemuOptsList
*olist
= qemu_find_opts("vnc");
375 if (strstr(target
, "id=")) {
376 error_setg(errp
, "id not supported");
380 opts
= qemu_opts_find(olist
, "default");
384 opts
= vnc_parse(target
, errp
);
389 vnc_display_open("default", errp
);
392 static void qmp_change_vnc(const char *target
, bool has_arg
, const char *arg
,
395 if (strcmp(target
, "passwd") == 0 || strcmp(target
, "password") == 0) {
397 error_setg(errp
, QERR_MISSING_PARAMETER
, "password");
399 qmp_change_vnc_password(arg
, errp
);
402 qmp_change_vnc_listen(target
, errp
);
406 void qmp_change_vnc_password(const char *password
, Error
**errp
)
408 error_setg(errp
, QERR_FEATURE_DISABLED
, "vnc");
410 static void qmp_change_vnc(const char *target
, bool has_arg
, const char *arg
,
413 error_setg(errp
, QERR_FEATURE_DISABLED
, "vnc");
415 #endif /* !CONFIG_VNC */
417 void qmp_change(const char *device
, const char *target
,
418 bool has_arg
, const char *arg
, Error
**errp
)
420 if (strcmp(device
, "vnc") == 0) {
421 qmp_change_vnc(target
, has_arg
, arg
, errp
);
423 qmp_blockdev_change_medium(true, device
, false, NULL
, target
,
424 has_arg
, arg
, false, 0, errp
);
428 static void qom_list_types_tramp(ObjectClass
*klass
, void *data
)
430 ObjectTypeInfoList
*e
, **pret
= data
;
431 ObjectTypeInfo
*info
;
432 ObjectClass
*parent
= object_class_get_parent(klass
);
434 info
= g_malloc0(sizeof(*info
));
435 info
->name
= g_strdup(object_class_get_name(klass
));
436 info
->has_abstract
= info
->abstract
= object_class_is_abstract(klass
);
438 info
->has_parent
= true;
439 info
->parent
= g_strdup(object_class_get_name(parent
));
442 e
= g_malloc0(sizeof(*e
));
448 ObjectTypeInfoList
*qmp_qom_list_types(bool has_implements
,
449 const char *implements
,
454 ObjectTypeInfoList
*ret
= NULL
;
456 object_class_foreach(qom_list_types_tramp
, implements
, abstract
, &ret
);
461 /* Return a DevicePropertyInfo for a qdev property.
463 * If a qdev property with the given name does not exist, use the given default
464 * type. If the qdev property info should not be shown, return NULL.
466 * The caller must free the return value.
468 static ObjectPropertyInfo
*make_device_property_info(ObjectClass
*klass
,
470 const char *default_type
,
471 const char *description
)
473 ObjectPropertyInfo
*info
;
477 for (prop
= DEVICE_CLASS(klass
)->props
; prop
&& prop
->name
; prop
++) {
478 if (strcmp(name
, prop
->name
) != 0) {
483 * TODO Properties without a parser are just for dirty hacks.
484 * qdev_prop_ptr is the only such PropertyInfo. It's marked
485 * for removal. This conditional should be removed along with
488 if (!prop
->info
->set
&& !prop
->info
->create
) {
489 return NULL
; /* no way to set it, don't show */
492 info
= g_malloc0(sizeof(*info
));
493 info
->name
= g_strdup(prop
->name
);
494 info
->type
= default_type
? g_strdup(default_type
)
495 : g_strdup(prop
->info
->name
);
496 info
->has_description
= !!prop
->info
->description
;
497 info
->description
= g_strdup(prop
->info
->description
);
500 klass
= object_class_get_parent(klass
);
501 } while (klass
!= object_class_by_name(TYPE_DEVICE
));
503 /* Not a qdev property, use the default type */
504 info
= g_malloc0(sizeof(*info
));
505 info
->name
= g_strdup(name
);
506 info
->type
= g_strdup(default_type
);
507 info
->has_description
= !!description
;
508 info
->description
= g_strdup(description
);
513 ObjectPropertyInfoList
*qmp_device_list_properties(const char *typename
,
518 ObjectProperty
*prop
;
519 ObjectPropertyIterator iter
;
520 ObjectPropertyInfoList
*prop_list
= NULL
;
522 klass
= object_class_by_name(typename
);
524 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
525 "Device '%s' not found", typename
);
529 klass
= object_class_dynamic_cast(klass
, TYPE_DEVICE
);
531 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "typename", TYPE_DEVICE
);
535 if (object_class_is_abstract(klass
)) {
536 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "typename",
537 "non-abstract device type");
541 obj
= object_new(typename
);
543 object_property_iter_init(&iter
, obj
);
544 while ((prop
= object_property_iter_next(&iter
))) {
545 ObjectPropertyInfo
*info
;
546 ObjectPropertyInfoList
*entry
;
548 /* Skip Object and DeviceState properties */
549 if (strcmp(prop
->name
, "type") == 0 ||
550 strcmp(prop
->name
, "realized") == 0 ||
551 strcmp(prop
->name
, "hotpluggable") == 0 ||
552 strcmp(prop
->name
, "hotplugged") == 0 ||
553 strcmp(prop
->name
, "parent_bus") == 0) {
557 /* Skip legacy properties since they are just string versions of
558 * properties that we already list.
560 if (strstart(prop
->name
, "legacy-", NULL
)) {
564 info
= make_device_property_info(klass
, prop
->name
, prop
->type
,
570 entry
= g_malloc0(sizeof(*entry
));
572 entry
->next
= prop_list
;
581 ObjectPropertyInfoList
*qmp_qom_list_properties(const char *typename
,
586 ObjectProperty
*prop
;
587 ObjectPropertyIterator iter
;
588 ObjectPropertyInfoList
*prop_list
= NULL
;
590 klass
= object_class_by_name(typename
);
592 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
593 "Class '%s' not found", typename
);
597 klass
= object_class_dynamic_cast(klass
, TYPE_OBJECT
);
599 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "typename", TYPE_OBJECT
);
603 if (object_class_is_abstract(klass
)) {
604 object_class_property_iter_init(&iter
, klass
);
606 obj
= object_new(typename
);
607 object_property_iter_init(&iter
, obj
);
609 while ((prop
= object_property_iter_next(&iter
))) {
610 ObjectPropertyInfo
*info
;
611 ObjectPropertyInfoList
*entry
;
613 info
= g_malloc0(sizeof(*info
));
614 info
->name
= g_strdup(prop
->name
);
615 info
->type
= g_strdup(prop
->type
);
616 info
->has_description
= !!prop
->description
;
617 info
->description
= g_strdup(prop
->description
);
619 entry
= g_malloc0(sizeof(*entry
));
621 entry
->next
= prop_list
;
630 CpuDefinitionInfoList
*qmp_query_cpu_definitions(Error
**errp
)
632 return arch_query_cpu_definitions(errp
);
635 CpuModelExpansionInfo
*qmp_query_cpu_model_expansion(CpuModelExpansionType type
,
639 return arch_query_cpu_model_expansion(type
, model
, errp
);
642 CpuModelCompareInfo
*qmp_query_cpu_model_comparison(CpuModelInfo
*modela
,
643 CpuModelInfo
*modelb
,
646 return arch_query_cpu_model_comparison(modela
, modelb
, errp
);
649 CpuModelBaselineInfo
*qmp_query_cpu_model_baseline(CpuModelInfo
*modela
,
650 CpuModelInfo
*modelb
,
653 return arch_query_cpu_model_baseline(modela
, modelb
, errp
);
656 void qmp_add_client(const char *protocol
, const char *fdname
,
657 bool has_skipauth
, bool skipauth
, bool has_tls
, bool tls
,
663 fd
= monitor_get_fd(cur_mon
, fdname
, errp
);
668 if (strcmp(protocol
, "spice") == 0) {
669 if (!qemu_using_spice(errp
)) {
673 skipauth
= has_skipauth
? skipauth
: false;
674 tls
= has_tls
? tls
: false;
675 if (qemu_spice_display_add_client(fd
, skipauth
, tls
) < 0) {
676 error_setg(errp
, "spice failed to add client");
681 } else if (strcmp(protocol
, "vnc") == 0) {
682 skipauth
= has_skipauth
? skipauth
: false;
683 vnc_display_add_client(NULL
, fd
, skipauth
);
686 } else if ((s
= qemu_chr_find(protocol
)) != NULL
) {
687 if (qemu_chr_add_client(s
, fd
) < 0) {
688 error_setg(errp
, "failed to add client");
695 error_setg(errp
, "protocol '%s' is invalid", protocol
);
700 void qmp_object_add(const char *type
, const char *id
,
701 bool has_props
, QObject
*props
, Error
**errp
)
708 pdict
= qobject_to(QDict
, props
);
710 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, "props", "dict");
718 v
= qobject_input_visitor_new(QOBJECT(pdict
));
719 obj
= user_creatable_add_type(type
, id
, pdict
, v
, errp
);
727 void qmp_object_del(const char *id
, Error
**errp
)
729 user_creatable_del(id
, errp
);
732 MemoryDeviceInfoList
*qmp_query_memory_devices(Error
**errp
)
734 return qmp_pc_dimm_device_list();
737 ACPIOSTInfoList
*qmp_query_acpi_ospm_status(Error
**errp
)
740 ACPIOSTInfoList
*head
= NULL
;
741 ACPIOSTInfoList
**prev
= &head
;
742 Object
*obj
= object_resolve_path_type("", TYPE_ACPI_DEVICE_IF
, &ambig
);
745 AcpiDeviceIfClass
*adevc
= ACPI_DEVICE_IF_GET_CLASS(obj
);
746 AcpiDeviceIf
*adev
= ACPI_DEVICE_IF(obj
);
748 adevc
->ospm_status(adev
, &prev
);
750 error_setg(errp
, "command is not supported, missing ACPI device");
756 MemoryInfo
*qmp_query_memory_size_summary(Error
**errp
)
758 MemoryInfo
*mem_info
= g_malloc0(sizeof(MemoryInfo
));
760 mem_info
->base_memory
= ram_size
;
762 mem_info
->plugged_memory
= get_plugged_memory_size();
763 mem_info
->has_plugged_memory
=
764 mem_info
->plugged_memory
!= (uint64_t)-1;
769 static QemuSemaphore x_oob_test_sem
;
771 static void __attribute__((constructor
)) x_oob_test_init(void)
773 qemu_sem_init(&x_oob_test_sem
, 0);
776 void qmp_x_oob_test(bool lock
, Error
**errp
)
779 qemu_sem_wait(&x_oob_test_sem
);
781 qemu_sem_post(&x_oob_test_sem
);