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
);
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_exit_preconfig(Error
**errp
)
166 if (!runstate_check(RUN_STATE_PRECONFIG
)) {
167 error_setg(errp
, "The command is permitted only in '%s' state",
168 RunState_str(RUN_STATE_PRECONFIG
));
171 qemu_exit_preconfig_request();
174 void qmp_cont(Error
**errp
)
177 Error
*local_err
= NULL
;
179 /* if there is a dump in background, we should wait until the dump
181 if (dump_in_progress()) {
182 error_setg(errp
, "There is a dump in process, please wait.");
186 if (runstate_needs_reset()) {
187 error_setg(errp
, "Resetting the Virtual Machine is required");
189 } else if (runstate_check(RUN_STATE_SUSPENDED
)) {
193 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
194 blk_iostatus_reset(blk
);
197 /* Continuing after completed migration. Images have been inactivated to
198 * allow the destination to take control. Need to get control back now.
200 * If there are no inactive block nodes (e.g. because the VM was just
201 * paused rather than completing a migration), bdrv_inactivate_all() simply
202 * doesn't do anything. */
203 bdrv_invalidate_cache_all(&local_err
);
205 error_propagate(errp
, local_err
);
209 if (runstate_check(RUN_STATE_INMIGRATE
)) {
216 void qmp_system_wakeup(Error
**errp
)
218 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_OTHER
);
221 ObjectPropertyInfoList
*qmp_qom_list(const char *path
, Error
**errp
)
224 bool ambiguous
= false;
225 ObjectPropertyInfoList
*props
= NULL
;
226 ObjectProperty
*prop
;
227 ObjectPropertyIterator iter
;
229 obj
= object_resolve_path(path
, &ambiguous
);
232 error_setg(errp
, "Path '%s' is ambiguous", path
);
234 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
235 "Device '%s' not found", path
);
240 object_property_iter_init(&iter
, obj
);
241 while ((prop
= object_property_iter_next(&iter
))) {
242 ObjectPropertyInfoList
*entry
= g_malloc0(sizeof(*entry
));
244 entry
->value
= g_malloc0(sizeof(ObjectPropertyInfo
));
248 entry
->value
->name
= g_strdup(prop
->name
);
249 entry
->value
->type
= g_strdup(prop
->type
);
255 void qmp_qom_set(const char *path
, const char *property
, QObject
*value
,
260 obj
= object_resolve_path(path
, NULL
);
262 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
263 "Device '%s' not found", path
);
267 object_property_set_qobject(obj
, value
, property
, errp
);
270 QObject
*qmp_qom_get(const char *path
, const char *property
, Error
**errp
)
274 obj
= object_resolve_path(path
, NULL
);
276 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
277 "Device '%s' not found", path
);
281 return object_property_get_qobject(obj
, property
, errp
);
284 void qmp_set_password(const char *protocol
, const char *password
,
285 bool has_connected
, const char *connected
, Error
**errp
)
287 int disconnect_if_connected
= 0;
288 int fail_if_connected
= 0;
292 if (strcmp(connected
, "fail") == 0) {
293 fail_if_connected
= 1;
294 } else if (strcmp(connected
, "disconnect") == 0) {
295 disconnect_if_connected
= 1;
296 } else if (strcmp(connected
, "keep") == 0) {
299 error_setg(errp
, QERR_INVALID_PARAMETER
, "connected");
304 if (strcmp(protocol
, "spice") == 0) {
305 if (!qemu_using_spice(errp
)) {
308 rc
= qemu_spice_set_passwd(password
, fail_if_connected
,
309 disconnect_if_connected
);
311 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
316 if (strcmp(protocol
, "vnc") == 0) {
317 if (fail_if_connected
|| disconnect_if_connected
) {
318 /* vnc supports "connected=keep" only */
319 error_setg(errp
, QERR_INVALID_PARAMETER
, "connected");
322 /* Note that setting an empty password will not disable login through
324 rc
= vnc_display_password(NULL
, password
);
326 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
331 error_setg(errp
, QERR_INVALID_PARAMETER
, "protocol");
334 void qmp_expire_password(const char *protocol
, const char *whenstr
,
340 if (strcmp(whenstr
, "now") == 0) {
342 } else if (strcmp(whenstr
, "never") == 0) {
344 } else if (whenstr
[0] == '+') {
345 when
= time(NULL
) + strtoull(whenstr
+1, NULL
, 10);
347 when
= strtoull(whenstr
, NULL
, 10);
350 if (strcmp(protocol
, "spice") == 0) {
351 if (!qemu_using_spice(errp
)) {
354 rc
= qemu_spice_set_pw_expire(when
);
356 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
361 if (strcmp(protocol
, "vnc") == 0) {
362 rc
= vnc_display_pw_expire(NULL
, when
);
364 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
369 error_setg(errp
, QERR_INVALID_PARAMETER
, "protocol");
373 void qmp_change_vnc_password(const char *password
, Error
**errp
)
375 if (vnc_display_password(NULL
, password
) < 0) {
376 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
380 static void qmp_change_vnc_listen(const char *target
, Error
**errp
)
382 QemuOptsList
*olist
= qemu_find_opts("vnc");
385 if (strstr(target
, "id=")) {
386 error_setg(errp
, "id not supported");
390 opts
= qemu_opts_find(olist
, "default");
394 opts
= vnc_parse(target
, errp
);
399 vnc_display_open("default", errp
);
402 static void qmp_change_vnc(const char *target
, bool has_arg
, const char *arg
,
405 if (strcmp(target
, "passwd") == 0 || strcmp(target
, "password") == 0) {
407 error_setg(errp
, QERR_MISSING_PARAMETER
, "password");
409 qmp_change_vnc_password(arg
, errp
);
412 qmp_change_vnc_listen(target
, errp
);
416 void qmp_change_vnc_password(const char *password
, Error
**errp
)
418 error_setg(errp
, QERR_FEATURE_DISABLED
, "vnc");
420 static void qmp_change_vnc(const char *target
, bool has_arg
, const char *arg
,
423 error_setg(errp
, QERR_FEATURE_DISABLED
, "vnc");
425 #endif /* !CONFIG_VNC */
427 void qmp_change(const char *device
, const char *target
,
428 bool has_arg
, const char *arg
, Error
**errp
)
430 if (strcmp(device
, "vnc") == 0) {
431 qmp_change_vnc(target
, has_arg
, arg
, errp
);
433 qmp_blockdev_change_medium(true, device
, false, NULL
, target
,
434 has_arg
, arg
, false, 0, errp
);
438 static void qom_list_types_tramp(ObjectClass
*klass
, void *data
)
440 ObjectTypeInfoList
*e
, **pret
= data
;
441 ObjectTypeInfo
*info
;
442 ObjectClass
*parent
= object_class_get_parent(klass
);
444 info
= g_malloc0(sizeof(*info
));
445 info
->name
= g_strdup(object_class_get_name(klass
));
446 info
->has_abstract
= info
->abstract
= object_class_is_abstract(klass
);
448 info
->has_parent
= true;
449 info
->parent
= g_strdup(object_class_get_name(parent
));
452 e
= g_malloc0(sizeof(*e
));
458 ObjectTypeInfoList
*qmp_qom_list_types(bool has_implements
,
459 const char *implements
,
464 ObjectTypeInfoList
*ret
= NULL
;
466 object_class_foreach(qom_list_types_tramp
, implements
, abstract
, &ret
);
471 /* Return a DevicePropertyInfo for a qdev property.
473 * If a qdev property with the given name does not exist, use the given default
474 * type. If the qdev property info should not be shown, return NULL.
476 * The caller must free the return value.
478 static ObjectPropertyInfo
*make_device_property_info(ObjectClass
*klass
,
480 const char *default_type
,
481 const char *description
)
483 ObjectPropertyInfo
*info
;
487 for (prop
= DEVICE_CLASS(klass
)->props
; prop
&& prop
->name
; prop
++) {
488 if (strcmp(name
, prop
->name
) != 0) {
493 * TODO Properties without a parser are just for dirty hacks.
494 * qdev_prop_ptr is the only such PropertyInfo. It's marked
495 * for removal. This conditional should be removed along with
498 if (!prop
->info
->set
&& !prop
->info
->create
) {
499 return NULL
; /* no way to set it, don't show */
502 info
= g_malloc0(sizeof(*info
));
503 info
->name
= g_strdup(prop
->name
);
504 info
->type
= default_type
? g_strdup(default_type
)
505 : g_strdup(prop
->info
->name
);
506 info
->has_description
= !!prop
->info
->description
;
507 info
->description
= g_strdup(prop
->info
->description
);
510 klass
= object_class_get_parent(klass
);
511 } while (klass
!= object_class_by_name(TYPE_DEVICE
));
513 /* Not a qdev property, use the default type */
514 info
= g_malloc0(sizeof(*info
));
515 info
->name
= g_strdup(name
);
516 info
->type
= g_strdup(default_type
);
517 info
->has_description
= !!description
;
518 info
->description
= g_strdup(description
);
523 ObjectPropertyInfoList
*qmp_device_list_properties(const char *typename
,
528 ObjectProperty
*prop
;
529 ObjectPropertyIterator iter
;
530 ObjectPropertyInfoList
*prop_list
= NULL
;
532 klass
= object_class_by_name(typename
);
534 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
535 "Device '%s' not found", typename
);
539 klass
= object_class_dynamic_cast(klass
, TYPE_DEVICE
);
541 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "typename", TYPE_DEVICE
);
545 if (object_class_is_abstract(klass
)) {
546 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "typename",
547 "non-abstract device type");
551 obj
= object_new(typename
);
553 object_property_iter_init(&iter
, obj
);
554 while ((prop
= object_property_iter_next(&iter
))) {
555 ObjectPropertyInfo
*info
;
556 ObjectPropertyInfoList
*entry
;
558 /* Skip Object and DeviceState properties */
559 if (strcmp(prop
->name
, "type") == 0 ||
560 strcmp(prop
->name
, "realized") == 0 ||
561 strcmp(prop
->name
, "hotpluggable") == 0 ||
562 strcmp(prop
->name
, "hotplugged") == 0 ||
563 strcmp(prop
->name
, "parent_bus") == 0) {
567 /* Skip legacy properties since they are just string versions of
568 * properties that we already list.
570 if (strstart(prop
->name
, "legacy-", NULL
)) {
574 info
= make_device_property_info(klass
, prop
->name
, prop
->type
,
580 entry
= g_malloc0(sizeof(*entry
));
582 entry
->next
= prop_list
;
591 ObjectPropertyInfoList
*qmp_qom_list_properties(const char *typename
,
596 ObjectProperty
*prop
;
597 ObjectPropertyIterator iter
;
598 ObjectPropertyInfoList
*prop_list
= NULL
;
600 klass
= object_class_by_name(typename
);
602 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
603 "Class '%s' not found", typename
);
607 klass
= object_class_dynamic_cast(klass
, TYPE_OBJECT
);
609 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "typename", TYPE_OBJECT
);
613 if (object_class_is_abstract(klass
)) {
614 object_class_property_iter_init(&iter
, klass
);
616 obj
= object_new(typename
);
617 object_property_iter_init(&iter
, obj
);
619 while ((prop
= object_property_iter_next(&iter
))) {
620 ObjectPropertyInfo
*info
;
621 ObjectPropertyInfoList
*entry
;
623 info
= g_malloc0(sizeof(*info
));
624 info
->name
= g_strdup(prop
->name
);
625 info
->type
= g_strdup(prop
->type
);
626 info
->has_description
= !!prop
->description
;
627 info
->description
= g_strdup(prop
->description
);
629 entry
= g_malloc0(sizeof(*entry
));
631 entry
->next
= prop_list
;
640 CpuDefinitionInfoList
*qmp_query_cpu_definitions(Error
**errp
)
642 return arch_query_cpu_definitions(errp
);
645 CpuModelExpansionInfo
*qmp_query_cpu_model_expansion(CpuModelExpansionType type
,
649 return arch_query_cpu_model_expansion(type
, model
, errp
);
652 CpuModelCompareInfo
*qmp_query_cpu_model_comparison(CpuModelInfo
*modela
,
653 CpuModelInfo
*modelb
,
656 return arch_query_cpu_model_comparison(modela
, modelb
, errp
);
659 CpuModelBaselineInfo
*qmp_query_cpu_model_baseline(CpuModelInfo
*modela
,
660 CpuModelInfo
*modelb
,
663 return arch_query_cpu_model_baseline(modela
, modelb
, errp
);
666 void qmp_add_client(const char *protocol
, const char *fdname
,
667 bool has_skipauth
, bool skipauth
, bool has_tls
, bool tls
,
673 fd
= monitor_get_fd(cur_mon
, fdname
, errp
);
678 if (strcmp(protocol
, "spice") == 0) {
679 if (!qemu_using_spice(errp
)) {
683 skipauth
= has_skipauth
? skipauth
: false;
684 tls
= has_tls
? tls
: false;
685 if (qemu_spice_display_add_client(fd
, skipauth
, tls
) < 0) {
686 error_setg(errp
, "spice failed to add client");
691 } else if (strcmp(protocol
, "vnc") == 0) {
692 skipauth
= has_skipauth
? skipauth
: false;
693 vnc_display_add_client(NULL
, fd
, skipauth
);
696 } else if ((s
= qemu_chr_find(protocol
)) != NULL
) {
697 if (qemu_chr_add_client(s
, fd
) < 0) {
698 error_setg(errp
, "failed to add client");
705 error_setg(errp
, "protocol '%s' is invalid", protocol
);
710 void qmp_object_add(const char *type
, const char *id
,
711 bool has_props
, QObject
*props
, Error
**errp
)
718 pdict
= qobject_to(QDict
, props
);
720 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, "props", "dict");
728 v
= qobject_input_visitor_new(QOBJECT(pdict
));
729 obj
= user_creatable_add_type(type
, id
, pdict
, v
, errp
);
734 qobject_unref(pdict
);
737 void qmp_object_del(const char *id
, Error
**errp
)
739 user_creatable_del(id
, errp
);
742 MemoryDeviceInfoList
*qmp_query_memory_devices(Error
**errp
)
744 return qmp_memory_device_list();
747 ACPIOSTInfoList
*qmp_query_acpi_ospm_status(Error
**errp
)
750 ACPIOSTInfoList
*head
= NULL
;
751 ACPIOSTInfoList
**prev
= &head
;
752 Object
*obj
= object_resolve_path_type("", TYPE_ACPI_DEVICE_IF
, &ambig
);
755 AcpiDeviceIfClass
*adevc
= ACPI_DEVICE_IF_GET_CLASS(obj
);
756 AcpiDeviceIf
*adev
= ACPI_DEVICE_IF(obj
);
758 adevc
->ospm_status(adev
, &prev
);
760 error_setg(errp
, "command is not supported, missing ACPI device");
766 MemoryInfo
*qmp_query_memory_size_summary(Error
**errp
)
768 MemoryInfo
*mem_info
= g_malloc0(sizeof(MemoryInfo
));
770 mem_info
->base_memory
= ram_size
;
772 mem_info
->plugged_memory
= get_plugged_memory_size();
773 mem_info
->has_plugged_memory
=
774 mem_info
->plugged_memory
!= (uint64_t)-1;
779 static QemuSemaphore x_oob_test_sem
;
781 static void __attribute__((constructor
)) x_oob_test_init(void)
783 qemu_sem_init(&x_oob_test_sem
, 0);
786 void qmp_x_oob_test(bool lock
, Error
**errp
)
789 qemu_sem_wait(&x_oob_test_sem
);
791 qemu_sem_post(&x_oob_test_sem
);