migration: new state "postcopy-recover"
[qemu/ar7.git] / qmp.c
blob25fdc9a5b2df12fa37c49f45ec6f0aaae4eb74f1
1 /*
2 * QEMU Management Protocol
4 * Copyright IBM, Corp. 2011
6 * Authors:
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"
26 #include "ui/vnc.h"
27 #include "sysemu/kvm.h"
28 #include "sysemu/arch_init.h"
29 #include "hw/qdev.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));
49 if (qemu_name) {
50 info->has_name = true;
51 info->name = g_strdup(qemu_name);
54 return info;
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);
67 return info;
70 KvmInfo *qmp_query_kvm(Error **errp)
72 KvmInfo *info = g_malloc0(sizeof(*info));
74 info->enabled = kvm_enabled();
75 info->present = kvm_available();
77 return info;
80 UuidInfo *qmp_query_uuid(Error **errp)
82 UuidInfo *info = g_malloc0(sizeof(*info));
84 info->UUID = qemu_uuid_unparse_strdup(&qemu_uuid);
85 return info;
88 void qmp_quit(Error **errp)
90 no_shutdown = 0;
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
97 * finished */
98 if (dump_in_progress()) {
99 error_setg(errp, "There is a dump in process, please wait.");
100 return;
103 if (runstate_check(RUN_STATE_INMIGRATE)) {
104 autostart = 0;
105 } else {
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)
122 MachineClass *mc;
124 mc = MACHINE_GET_CLASS(current_machine);
125 if (mc->hot_add_cpu) {
126 mc->hot_add_cpu(id, errp);
127 } else {
128 error_setg(errp, "Not supported");
132 #ifndef CONFIG_VNC
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");
138 return NULL;
141 VncInfo2List *qmp_query_vnc_servers(Error **errp)
143 error_setg(errp, QERR_FEATURE_DISABLED, "vnc");
144 return NULL;
146 #endif
148 #ifndef CONFIG_SPICE
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)
160 abort();
162 #endif
164 void qmp_cont(Error **errp)
166 BlockBackend *blk;
167 Error *local_err = NULL;
169 /* if there is a dump in background, we should wait until the dump
170 * finished */
171 if (dump_in_progress()) {
172 error_setg(errp, "There is a dump in process, please wait.");
173 return;
176 if (runstate_needs_reset()) {
177 error_setg(errp, "Resetting the Virtual Machine is required");
178 return;
179 } else if (runstate_check(RUN_STATE_SUSPENDED)) {
180 return;
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);
194 if (local_err) {
195 error_propagate(errp, local_err);
196 return;
199 if (runstate_check(RUN_STATE_INMIGRATE)) {
200 autostart = 1;
201 } else {
202 vm_start();
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)
213 Object *obj;
214 bool ambiguous = false;
215 ObjectPropertyInfoList *props = NULL;
216 ObjectProperty *prop;
217 ObjectPropertyIterator iter;
219 obj = object_resolve_path(path, &ambiguous);
220 if (obj == NULL) {
221 if (ambiguous) {
222 error_setg(errp, "Path '%s' is ambiguous", path);
223 } else {
224 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
225 "Device '%s' not found", path);
227 return NULL;
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));
235 entry->next = props;
236 props = entry;
238 entry->value->name = g_strdup(prop->name);
239 entry->value->type = g_strdup(prop->type);
242 return props;
245 void qmp_qom_set(const char *path, const char *property, QObject *value,
246 Error **errp)
248 Object *obj;
250 obj = object_resolve_path(path, NULL);
251 if (!obj) {
252 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
253 "Device '%s' not found", path);
254 return;
257 object_property_set_qobject(obj, value, property, errp);
260 QObject *qmp_qom_get(const char *path, const char *property, Error **errp)
262 Object *obj;
264 obj = object_resolve_path(path, NULL);
265 if (!obj) {
266 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
267 "Device '%s' not found", path);
268 return NULL;
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;
279 int rc;
281 if (has_connected) {
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) {
287 /* nothing */
288 } else {
289 error_setg(errp, QERR_INVALID_PARAMETER, "connected");
290 return;
294 if (strcmp(protocol, "spice") == 0) {
295 if (!qemu_using_spice(errp)) {
296 return;
298 rc = qemu_spice_set_passwd(password, fail_if_connected,
299 disconnect_if_connected);
300 if (rc != 0) {
301 error_setg(errp, QERR_SET_PASSWD_FAILED);
303 return;
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");
310 return;
312 /* Note that setting an empty password will not disable login through
313 * this interface. */
314 rc = vnc_display_password(NULL, password);
315 if (rc < 0) {
316 error_setg(errp, QERR_SET_PASSWD_FAILED);
318 return;
321 error_setg(errp, QERR_INVALID_PARAMETER, "protocol");
324 void qmp_expire_password(const char *protocol, const char *whenstr,
325 Error **errp)
327 time_t when;
328 int rc;
330 if (strcmp(whenstr, "now") == 0) {
331 when = 0;
332 } else if (strcmp(whenstr, "never") == 0) {
333 when = TIME_MAX;
334 } else if (whenstr[0] == '+') {
335 when = time(NULL) + strtoull(whenstr+1, NULL, 10);
336 } else {
337 when = strtoull(whenstr, NULL, 10);
340 if (strcmp(protocol, "spice") == 0) {
341 if (!qemu_using_spice(errp)) {
342 return;
344 rc = qemu_spice_set_pw_expire(when);
345 if (rc != 0) {
346 error_setg(errp, QERR_SET_PASSWD_FAILED);
348 return;
351 if (strcmp(protocol, "vnc") == 0) {
352 rc = vnc_display_pw_expire(NULL, when);
353 if (rc != 0) {
354 error_setg(errp, QERR_SET_PASSWD_FAILED);
356 return;
359 error_setg(errp, QERR_INVALID_PARAMETER, "protocol");
362 #ifdef CONFIG_VNC
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");
373 QemuOpts *opts;
375 if (strstr(target, "id=")) {
376 error_setg(errp, "id not supported");
377 return;
380 opts = qemu_opts_find(olist, "default");
381 if (opts) {
382 qemu_opts_del(opts);
384 opts = vnc_parse(target, errp);
385 if (!opts) {
386 return;
389 vnc_display_open("default", errp);
392 static void qmp_change_vnc(const char *target, bool has_arg, const char *arg,
393 Error **errp)
395 if (strcmp(target, "passwd") == 0 || strcmp(target, "password") == 0) {
396 if (!has_arg) {
397 error_setg(errp, QERR_MISSING_PARAMETER, "password");
398 } else {
399 qmp_change_vnc_password(arg, errp);
401 } else {
402 qmp_change_vnc_listen(target, errp);
405 #else
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,
411 Error **errp)
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);
422 } else {
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);
437 if (parent) {
438 info->has_parent = true;
439 info->parent = g_strdup(object_class_get_name(parent));
442 e = g_malloc0(sizeof(*e));
443 e->value = info;
444 e->next = *pret;
445 *pret = e;
448 ObjectTypeInfoList *qmp_qom_list_types(bool has_implements,
449 const char *implements,
450 bool has_abstract,
451 bool abstract,
452 Error **errp)
454 ObjectTypeInfoList *ret = NULL;
456 object_class_foreach(qom_list_types_tramp, implements, abstract, &ret);
458 return 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,
469 const char *name,
470 const char *default_type,
471 const char *description)
473 ObjectPropertyInfo *info;
474 Property *prop;
476 do {
477 for (prop = DEVICE_CLASS(klass)->props; prop && prop->name; prop++) {
478 if (strcmp(name, prop->name) != 0) {
479 continue;
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
486 * it.
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);
498 return info;
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);
510 return info;
513 ObjectPropertyInfoList *qmp_device_list_properties(const char *typename,
514 Error **errp)
516 ObjectClass *klass;
517 Object *obj;
518 ObjectProperty *prop;
519 ObjectPropertyIterator iter;
520 ObjectPropertyInfoList *prop_list = NULL;
522 klass = object_class_by_name(typename);
523 if (klass == NULL) {
524 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
525 "Device '%s' not found", typename);
526 return NULL;
529 klass = object_class_dynamic_cast(klass, TYPE_DEVICE);
530 if (klass == NULL) {
531 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "typename", TYPE_DEVICE);
532 return NULL;
535 if (object_class_is_abstract(klass)) {
536 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "typename",
537 "non-abstract device type");
538 return NULL;
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) {
554 continue;
557 /* Skip legacy properties since they are just string versions of
558 * properties that we already list.
560 if (strstart(prop->name, "legacy-", NULL)) {
561 continue;
564 info = make_device_property_info(klass, prop->name, prop->type,
565 prop->description);
566 if (!info) {
567 continue;
570 entry = g_malloc0(sizeof(*entry));
571 entry->value = info;
572 entry->next = prop_list;
573 prop_list = entry;
576 object_unref(obj);
578 return prop_list;
581 ObjectPropertyInfoList *qmp_qom_list_properties(const char *typename,
582 Error **errp)
584 ObjectClass *klass;
585 Object *obj = NULL;
586 ObjectProperty *prop;
587 ObjectPropertyIterator iter;
588 ObjectPropertyInfoList *prop_list = NULL;
590 klass = object_class_by_name(typename);
591 if (klass == NULL) {
592 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
593 "Class '%s' not found", typename);
594 return NULL;
597 klass = object_class_dynamic_cast(klass, TYPE_OBJECT);
598 if (klass == NULL) {
599 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "typename", TYPE_OBJECT);
600 return NULL;
603 if (object_class_is_abstract(klass)) {
604 object_class_property_iter_init(&iter, klass);
605 } else {
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));
620 entry->value = info;
621 entry->next = prop_list;
622 prop_list = entry;
625 object_unref(obj);
627 return 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,
636 CpuModelInfo *model,
637 Error **errp)
639 return arch_query_cpu_model_expansion(type, model, errp);
642 CpuModelCompareInfo *qmp_query_cpu_model_comparison(CpuModelInfo *modela,
643 CpuModelInfo *modelb,
644 Error **errp)
646 return arch_query_cpu_model_comparison(modela, modelb, errp);
649 CpuModelBaselineInfo *qmp_query_cpu_model_baseline(CpuModelInfo *modela,
650 CpuModelInfo *modelb,
651 Error **errp)
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,
658 Error **errp)
660 Chardev *s;
661 int fd;
663 fd = monitor_get_fd(cur_mon, fdname, errp);
664 if (fd < 0) {
665 return;
668 if (strcmp(protocol, "spice") == 0) {
669 if (!qemu_using_spice(errp)) {
670 close(fd);
671 return;
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");
677 close(fd);
679 return;
680 #ifdef CONFIG_VNC
681 } else if (strcmp(protocol, "vnc") == 0) {
682 skipauth = has_skipauth ? skipauth : false;
683 vnc_display_add_client(NULL, fd, skipauth);
684 return;
685 #endif
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");
689 close(fd);
690 return;
692 return;
695 error_setg(errp, "protocol '%s' is invalid", protocol);
696 close(fd);
700 void qmp_object_add(const char *type, const char *id,
701 bool has_props, QObject *props, Error **errp)
703 QDict *pdict;
704 Visitor *v;
705 Object *obj;
707 if (props) {
708 pdict = qobject_to(QDict, props);
709 if (!pdict) {
710 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, "props", "dict");
711 return;
713 qobject_ref(pdict);
714 } else {
715 pdict = qdict_new();
718 v = qobject_input_visitor_new(QOBJECT(pdict));
719 obj = user_creatable_add_type(type, id, pdict, v, errp);
720 visit_free(v);
721 if (obj) {
722 object_unref(obj);
724 qobject_unref(pdict);
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_memory_device_list();
737 ACPIOSTInfoList *qmp_query_acpi_ospm_status(Error **errp)
739 bool ambig;
740 ACPIOSTInfoList *head = NULL;
741 ACPIOSTInfoList **prev = &head;
742 Object *obj = object_resolve_path_type("", TYPE_ACPI_DEVICE_IF, &ambig);
744 if (obj) {
745 AcpiDeviceIfClass *adevc = ACPI_DEVICE_IF_GET_CLASS(obj);
746 AcpiDeviceIf *adev = ACPI_DEVICE_IF(obj);
748 adevc->ospm_status(adev, &prev);
749 } else {
750 error_setg(errp, "command is not supported, missing ACPI device");
753 return head;
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;
766 return mem_info;
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)
778 if (lock) {
779 qemu_sem_wait(&x_oob_test_sem);
780 } else {
781 qemu_sem_post(&x_oob_test_sem);