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 object_property_iter_init(&iter
, 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
);
241 void qmp_qom_set(const char *path
, const char *property
, QObject
*value
,
246 obj
= object_resolve_path(path
, NULL
);
248 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
249 "Device '%s' not found", path
);
253 object_property_set_qobject(obj
, value
, property
, errp
);
256 QObject
*qmp_qom_get(const char *path
, const char *property
, Error
**errp
)
260 obj
= object_resolve_path(path
, NULL
);
262 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
263 "Device '%s' not found", path
);
267 return object_property_get_qobject(obj
, property
, errp
);
270 void qmp_set_password(const char *protocol
, const char *password
,
271 bool has_connected
, const char *connected
, Error
**errp
)
273 int disconnect_if_connected
= 0;
274 int fail_if_connected
= 0;
278 if (strcmp(connected
, "fail") == 0) {
279 fail_if_connected
= 1;
280 } else if (strcmp(connected
, "disconnect") == 0) {
281 disconnect_if_connected
= 1;
282 } else if (strcmp(connected
, "keep") == 0) {
285 error_setg(errp
, QERR_INVALID_PARAMETER
, "connected");
290 if (strcmp(protocol
, "spice") == 0) {
291 if (!qemu_using_spice(errp
)) {
294 rc
= qemu_spice_set_passwd(password
, fail_if_connected
,
295 disconnect_if_connected
);
297 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
302 if (strcmp(protocol
, "vnc") == 0) {
303 if (fail_if_connected
|| disconnect_if_connected
) {
304 /* vnc supports "connected=keep" only */
305 error_setg(errp
, QERR_INVALID_PARAMETER
, "connected");
308 /* Note that setting an empty password will not disable login through
310 rc
= vnc_display_password(NULL
, password
);
312 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
317 error_setg(errp
, QERR_INVALID_PARAMETER
, "protocol");
320 void qmp_expire_password(const char *protocol
, const char *whenstr
,
326 if (strcmp(whenstr
, "now") == 0) {
328 } else if (strcmp(whenstr
, "never") == 0) {
330 } else if (whenstr
[0] == '+') {
331 when
= time(NULL
) + strtoull(whenstr
+1, NULL
, 10);
333 when
= strtoull(whenstr
, NULL
, 10);
336 if (strcmp(protocol
, "spice") == 0) {
337 if (!qemu_using_spice(errp
)) {
340 rc
= qemu_spice_set_pw_expire(when
);
342 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
347 if (strcmp(protocol
, "vnc") == 0) {
348 rc
= vnc_display_pw_expire(NULL
, when
);
350 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
355 error_setg(errp
, QERR_INVALID_PARAMETER
, "protocol");
359 void qmp_change_vnc_password(const char *password
, Error
**errp
)
361 if (vnc_display_password(NULL
, password
) < 0) {
362 error_setg(errp
, QERR_SET_PASSWD_FAILED
);
366 static void qmp_change_vnc_listen(const char *target
, Error
**errp
)
368 QemuOptsList
*olist
= qemu_find_opts("vnc");
371 if (strstr(target
, "id=")) {
372 error_setg(errp
, "id not supported");
376 opts
= qemu_opts_find(olist
, "default");
380 opts
= vnc_parse(target
, errp
);
385 vnc_display_open("default", errp
);
388 static void qmp_change_vnc(const char *target
, bool has_arg
, const char *arg
,
391 if (strcmp(target
, "passwd") == 0 || strcmp(target
, "password") == 0) {
393 error_setg(errp
, QERR_MISSING_PARAMETER
, "password");
395 qmp_change_vnc_password(arg
, errp
);
398 qmp_change_vnc_listen(target
, errp
);
402 void qmp_change_vnc_password(const char *password
, Error
**errp
)
404 error_setg(errp
, QERR_FEATURE_DISABLED
, "vnc");
406 static void qmp_change_vnc(const char *target
, bool has_arg
, const char *arg
,
409 error_setg(errp
, QERR_FEATURE_DISABLED
, "vnc");
411 #endif /* !CONFIG_VNC */
413 void qmp_change(const char *device
, const char *target
,
414 bool has_arg
, const char *arg
, Error
**errp
)
416 if (strcmp(device
, "vnc") == 0) {
417 qmp_change_vnc(target
, has_arg
, arg
, errp
);
419 qmp_blockdev_change_medium(device
, target
, has_arg
, arg
, false, 0,
424 static void qom_list_types_tramp(ObjectClass
*klass
, void *data
)
426 ObjectTypeInfoList
*e
, **pret
= data
;
427 ObjectTypeInfo
*info
;
429 info
= g_malloc0(sizeof(*info
));
430 info
->name
= g_strdup(object_class_get_name(klass
));
432 e
= g_malloc0(sizeof(*e
));
438 ObjectTypeInfoList
*qmp_qom_list_types(bool has_implements
,
439 const char *implements
,
444 ObjectTypeInfoList
*ret
= NULL
;
446 object_class_foreach(qom_list_types_tramp
, implements
, abstract
, &ret
);
451 /* Return a DevicePropertyInfo for a qdev property.
453 * If a qdev property with the given name does not exist, use the given default
454 * type. If the qdev property info should not be shown, return NULL.
456 * The caller must free the return value.
458 static DevicePropertyInfo
*make_device_property_info(ObjectClass
*klass
,
460 const char *default_type
,
461 const char *description
)
463 DevicePropertyInfo
*info
;
467 for (prop
= DEVICE_CLASS(klass
)->props
; prop
&& prop
->name
; prop
++) {
468 if (strcmp(name
, prop
->name
) != 0) {
473 * TODO Properties without a parser are just for dirty hacks.
474 * qdev_prop_ptr is the only such PropertyInfo. It's marked
475 * for removal. This conditional should be removed along with
478 if (!prop
->info
->set
) {
479 return NULL
; /* no way to set it, don't show */
482 info
= g_malloc0(sizeof(*info
));
483 info
->name
= g_strdup(prop
->name
);
484 info
->type
= g_strdup(prop
->info
->name
);
485 info
->has_description
= !!prop
->info
->description
;
486 info
->description
= g_strdup(prop
->info
->description
);
489 klass
= object_class_get_parent(klass
);
490 } while (klass
!= object_class_by_name(TYPE_DEVICE
));
492 /* Not a qdev property, use the default type */
493 info
= g_malloc0(sizeof(*info
));
494 info
->name
= g_strdup(name
);
495 info
->type
= g_strdup(default_type
);
496 info
->has_description
= !!description
;
497 info
->description
= g_strdup(description
);
502 DevicePropertyInfoList
*qmp_device_list_properties(const char *typename
,
507 ObjectProperty
*prop
;
508 ObjectPropertyIterator iter
;
509 DevicePropertyInfoList
*prop_list
= NULL
;
511 klass
= object_class_by_name(typename
);
513 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
514 "Device '%s' not found", typename
);
518 klass
= object_class_dynamic_cast(klass
, TYPE_DEVICE
);
520 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "name", TYPE_DEVICE
);
524 if (object_class_is_abstract(klass
)) {
525 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "name",
526 "non-abstract device type");
530 if (DEVICE_CLASS(klass
)->cannot_destroy_with_object_finalize_yet
) {
531 error_setg(errp
, "Can't list properties of device '%s'", typename
);
535 obj
= object_new(typename
);
537 object_property_iter_init(&iter
, obj
);
538 while ((prop
= object_property_iter_next(&iter
))) {
539 DevicePropertyInfo
*info
;
540 DevicePropertyInfoList
*entry
;
542 /* Skip Object and DeviceState properties */
543 if (strcmp(prop
->name
, "type") == 0 ||
544 strcmp(prop
->name
, "realized") == 0 ||
545 strcmp(prop
->name
, "hotpluggable") == 0 ||
546 strcmp(prop
->name
, "hotplugged") == 0 ||
547 strcmp(prop
->name
, "parent_bus") == 0) {
551 /* Skip legacy properties since they are just string versions of
552 * properties that we already list.
554 if (strstart(prop
->name
, "legacy-", NULL
)) {
558 info
= make_device_property_info(klass
, prop
->name
, prop
->type
,
564 entry
= g_malloc0(sizeof(*entry
));
566 entry
->next
= prop_list
;
575 CpuDefinitionInfoList
*qmp_query_cpu_definitions(Error
**errp
)
577 return arch_query_cpu_definitions(errp
);
580 void qmp_add_client(const char *protocol
, const char *fdname
,
581 bool has_skipauth
, bool skipauth
, bool has_tls
, bool tls
,
587 fd
= monitor_get_fd(cur_mon
, fdname
, errp
);
592 if (strcmp(protocol
, "spice") == 0) {
593 if (!qemu_using_spice(errp
)) {
597 skipauth
= has_skipauth
? skipauth
: false;
598 tls
= has_tls
? tls
: false;
599 if (qemu_spice_display_add_client(fd
, skipauth
, tls
) < 0) {
600 error_setg(errp
, "spice failed to add client");
605 } else if (strcmp(protocol
, "vnc") == 0) {
606 skipauth
= has_skipauth
? skipauth
: false;
607 vnc_display_add_client(NULL
, fd
, skipauth
);
610 } else if ((s
= qemu_chr_find(protocol
)) != NULL
) {
611 if (qemu_chr_add_client(s
, fd
) < 0) {
612 error_setg(errp
, "failed to add client");
619 error_setg(errp
, "protocol '%s' is invalid", protocol
);
623 void object_add(const char *type
, const char *id
, const QDict
*qdict
,
624 Visitor
*v
, Error
**errp
)
629 Error
*local_err
= NULL
;
631 klass
= object_class_by_name(type
);
633 error_setg(errp
, "invalid object type: %s", type
);
637 if (!object_class_dynamic_cast(klass
, TYPE_USER_CREATABLE
)) {
638 error_setg(errp
, "object type '%s' isn't supported by object-add",
643 if (object_class_is_abstract(klass
)) {
644 error_setg(errp
, "object type '%s' is abstract", type
);
648 obj
= object_new(type
);
650 for (e
= qdict_first(qdict
); e
; e
= qdict_next(qdict
, e
)) {
651 object_property_set(obj
, v
, e
->key
, &local_err
);
658 object_property_add_child(object_get_objects_root(),
659 id
, obj
, &local_err
);
664 user_creatable_complete(obj
, &local_err
);
666 object_property_del(object_get_objects_root(),
672 error_propagate(errp
, local_err
);
677 void qmp_object_add(const char *type
, const char *id
,
678 bool has_props
, QObject
*props
, Error
**errp
)
680 const QDict
*pdict
= NULL
;
681 QmpInputVisitor
*qiv
;
684 pdict
= qobject_to_qdict(props
);
686 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, "props", "dict");
691 qiv
= qmp_input_visitor_new(props
);
692 object_add(type
, id
, pdict
, qmp_input_get_visitor(qiv
), errp
);
693 qmp_input_visitor_cleanup(qiv
);
696 void qmp_object_del(const char *id
, Error
**errp
)
701 container
= object_get_objects_root();
702 obj
= object_resolve_path_component(container
, id
);
704 error_setg(errp
, "object id not found");
708 if (!user_creatable_can_be_deleted(USER_CREATABLE(obj
), errp
)) {
709 error_setg(errp
, "%s is in use, can not be deleted", id
);
712 object_unparent(obj
);
715 MemoryDeviceInfoList
*qmp_query_memory_devices(Error
**errp
)
717 MemoryDeviceInfoList
*head
= NULL
;
718 MemoryDeviceInfoList
**prev
= &head
;
720 qmp_pc_dimm_device_list(qdev_get_machine(), &prev
);
725 ACPIOSTInfoList
*qmp_query_acpi_ospm_status(Error
**errp
)
728 ACPIOSTInfoList
*head
= NULL
;
729 ACPIOSTInfoList
**prev
= &head
;
730 Object
*obj
= object_resolve_path_type("", TYPE_ACPI_DEVICE_IF
, &ambig
);
733 AcpiDeviceIfClass
*adevc
= ACPI_DEVICE_IF_GET_CLASS(obj
);
734 AcpiDeviceIf
*adev
= ACPI_DEVICE_IF(obj
);
736 adevc
->ospm_status(adev
, &prev
);
738 error_setg(errp
, "command is not supported, missing ACPI device");