block: User BdrvChild callback for device name
[qemu.git] / qmp.c
1 /*
2 * QEMU Management Protocol
3 *
4 * Copyright IBM, Corp. 2011
5 *
6 * Authors:
7 * Anthony Liguori <aliguori@us.ibm.com>
8 *
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
11 *
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.
14 */
15
16 #include "qemu/osdep.h"
17 #include "qemu/cutils.h"
18 #include "monitor/monitor.h"
19 #include "sysemu/sysemu.h"
20 #include "qmp-commands.h"
21 #include "sysemu/char.h"
22 #include "ui/qemu-spice.h"
23 #include "ui/vnc.h"
24 #include "sysemu/kvm.h"
25 #include "sysemu/arch_init.h"
26 #include "hw/qdev.h"
27 #include "sysemu/blockdev.h"
28 #include "sysemu/block-backend.h"
29 #include "qom/qom-qobject.h"
30 #include "qapi/qmp/qerror.h"
31 #include "qapi/qmp/qobject.h"
32 #include "qapi/qmp-input-visitor.h"
33 #include "hw/boards.h"
34 #include "qom/object_interfaces.h"
35 #include "hw/mem/pc-dimm.h"
36 #include "hw/acpi/acpi_dev_interface.h"
37
38 NameInfo *qmp_query_name(Error **errp)
39 {
40 NameInfo *info = g_malloc0(sizeof(*info));
41
42 if (qemu_name) {
43 info->has_name = true;
44 info->name = g_strdup(qemu_name);
45 }
46
47 return info;
48 }
49
50 VersionInfo *qmp_query_version(Error **errp)
51 {
52 VersionInfo *info = g_new0(VersionInfo, 1);
53 const char *version = QEMU_VERSION;
54 const char *tmp;
55 int err;
56
57 info->qemu = g_new0(VersionTriple, 1);
58 err = qemu_strtoll(version, &tmp, 10, &info->qemu->major);
59 assert(err == 0);
60 tmp++;
61
62 err = qemu_strtoll(tmp, &tmp, 10, &info->qemu->minor);
63 assert(err == 0);
64 tmp++;
65
66 err = qemu_strtoll(tmp, &tmp, 10, &info->qemu->micro);
67 assert(err == 0);
68 info->package = g_strdup(QEMU_PKGVERSION);
69
70 return info;
71 }
72
73 KvmInfo *qmp_query_kvm(Error **errp)
74 {
75 KvmInfo *info = g_malloc0(sizeof(*info));
76
77 info->enabled = kvm_enabled();
78 info->present = kvm_available();
79
80 return info;
81 }
82
83 UuidInfo *qmp_query_uuid(Error **errp)
84 {
85 UuidInfo *info = g_malloc0(sizeof(*info));
86 char uuid[64];
87
88 snprintf(uuid, sizeof(uuid), UUID_FMT, qemu_uuid[0], qemu_uuid[1],
89 qemu_uuid[2], qemu_uuid[3], qemu_uuid[4], qemu_uuid[5],
90 qemu_uuid[6], qemu_uuid[7], qemu_uuid[8], qemu_uuid[9],
91 qemu_uuid[10], qemu_uuid[11], qemu_uuid[12], qemu_uuid[13],
92 qemu_uuid[14], qemu_uuid[15]);
93
94 info->UUID = g_strdup(uuid);
95 return info;
96 }
97
98 void qmp_quit(Error **errp)
99 {
100 no_shutdown = 0;
101 qemu_system_shutdown_request();
102 }
103
104 void qmp_stop(Error **errp)
105 {
106 /* if there is a dump in background, we should wait until the dump
107 * finished */
108 if (dump_in_progress()) {
109 error_setg(errp, "There is a dump in process, please wait.");
110 return;
111 }
112
113 if (runstate_check(RUN_STATE_INMIGRATE)) {
114 autostart = 0;
115 } else {
116 vm_stop(RUN_STATE_PAUSED);
117 }
118 }
119
120 void qmp_system_reset(Error **errp)
121 {
122 qemu_system_reset_request();
123 }
124
125 void qmp_system_powerdown(Error **erp)
126 {
127 qemu_system_powerdown_request();
128 }
129
130 void qmp_cpu(int64_t index, Error **errp)
131 {
132 /* Just do nothing */
133 }
134
135 void qmp_cpu_add(int64_t id, Error **errp)
136 {
137 MachineClass *mc;
138
139 mc = MACHINE_GET_CLASS(current_machine);
140 if (mc->hot_add_cpu) {
141 mc->hot_add_cpu(id, errp);
142 } else {
143 error_setg(errp, "Not supported");
144 }
145 }
146
147 #ifndef CONFIG_VNC
148 /* If VNC support is enabled, the "true" query-vnc command is
149 defined in the VNC subsystem */
150 VncInfo *qmp_query_vnc(Error **errp)
151 {
152 error_setg(errp, QERR_FEATURE_DISABLED, "vnc");
153 return NULL;
154 };
155
156 VncInfo2List *qmp_query_vnc_servers(Error **errp)
157 {
158 error_setg(errp, QERR_FEATURE_DISABLED, "vnc");
159 return NULL;
160 };
161 #endif
162
163 #ifndef CONFIG_SPICE
164 /*
165 * qmp-commands.hx ensures that QMP command query-spice exists only
166 * #ifdef CONFIG_SPICE. Necessary for an accurate query-commands
167 * result. However, the QAPI schema is blissfully unaware of that,
168 * and the QAPI code generator happily generates a dead
169 * qmp_marshal_query_spice() that calls qmp_query_spice(). Provide it
170 * one, or else linking fails. FIXME Educate the QAPI schema on
171 * CONFIG_SPICE.
172 */
173 SpiceInfo *qmp_query_spice(Error **errp)
174 {
175 abort();
176 };
177 #endif
178
179 void qmp_cont(Error **errp)
180 {
181 Error *local_err = NULL;
182 BlockBackend *blk;
183 BlockDriverState *bs;
184
185 /* if there is a dump in background, we should wait until the dump
186 * finished */
187 if (dump_in_progress()) {
188 error_setg(errp, "There is a dump in process, please wait.");
189 return;
190 }
191
192 if (runstate_needs_reset()) {
193 error_setg(errp, "Resetting the Virtual Machine is required");
194 return;
195 } else if (runstate_check(RUN_STATE_SUSPENDED)) {
196 return;
197 }
198
199 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
200 blk_iostatus_reset(blk);
201 }
202 for (bs = bdrv_next(NULL); bs; bs = bdrv_next(bs)) {
203 bdrv_add_key(bs, NULL, &local_err);
204 if (local_err) {
205 error_propagate(errp, local_err);
206 return;
207 }
208 }
209
210 /* Continuing after completed migration. Images have been inactivated to
211 * allow the destination to take control. Need to get control back now. */
212 if (runstate_check(RUN_STATE_FINISH_MIGRATE) ||
213 runstate_check(RUN_STATE_POSTMIGRATE))
214 {
215 bdrv_invalidate_cache_all(&local_err);
216 if (local_err) {
217 error_propagate(errp, local_err);
218 return;
219 }
220 }
221
222 if (runstate_check(RUN_STATE_INMIGRATE)) {
223 autostart = 1;
224 } else {
225 vm_start();
226 }
227 }
228
229 void qmp_system_wakeup(Error **errp)
230 {
231 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_OTHER);
232 }
233
234 ObjectPropertyInfoList *qmp_qom_list(const char *path, Error **errp)
235 {
236 Object *obj;
237 bool ambiguous = false;
238 ObjectPropertyInfoList *props = NULL;
239 ObjectProperty *prop;
240 ObjectPropertyIterator iter;
241
242 obj = object_resolve_path(path, &ambiguous);
243 if (obj == NULL) {
244 if (ambiguous) {
245 error_setg(errp, "Path '%s' is ambiguous", path);
246 } else {
247 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
248 "Device '%s' not found", path);
249 }
250 return NULL;
251 }
252
253 object_property_iter_init(&iter, obj);
254 while ((prop = object_property_iter_next(&iter))) {
255 ObjectPropertyInfoList *entry = g_malloc0(sizeof(*entry));
256
257 entry->value = g_malloc0(sizeof(ObjectPropertyInfo));
258 entry->next = props;
259 props = entry;
260
261 entry->value->name = g_strdup(prop->name);
262 entry->value->type = g_strdup(prop->type);
263 }
264
265 return props;
266 }
267
268 void qmp_qom_set(const char *path, const char *property, QObject *value,
269 Error **errp)
270 {
271 Object *obj;
272
273 obj = object_resolve_path(path, NULL);
274 if (!obj) {
275 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
276 "Device '%s' not found", path);
277 return;
278 }
279
280 object_property_set_qobject(obj, value, property, errp);
281 }
282
283 QObject *qmp_qom_get(const char *path, const char *property, Error **errp)
284 {
285 Object *obj;
286
287 obj = object_resolve_path(path, NULL);
288 if (!obj) {
289 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
290 "Device '%s' not found", path);
291 return NULL;
292 }
293
294 return object_property_get_qobject(obj, property, errp);
295 }
296
297 void qmp_set_password(const char *protocol, const char *password,
298 bool has_connected, const char *connected, Error **errp)
299 {
300 int disconnect_if_connected = 0;
301 int fail_if_connected = 0;
302 int rc;
303
304 if (has_connected) {
305 if (strcmp(connected, "fail") == 0) {
306 fail_if_connected = 1;
307 } else if (strcmp(connected, "disconnect") == 0) {
308 disconnect_if_connected = 1;
309 } else if (strcmp(connected, "keep") == 0) {
310 /* nothing */
311 } else {
312 error_setg(errp, QERR_INVALID_PARAMETER, "connected");
313 return;
314 }
315 }
316
317 if (strcmp(protocol, "spice") == 0) {
318 if (!qemu_using_spice(errp)) {
319 return;
320 }
321 rc = qemu_spice_set_passwd(password, fail_if_connected,
322 disconnect_if_connected);
323 if (rc != 0) {
324 error_setg(errp, QERR_SET_PASSWD_FAILED);
325 }
326 return;
327 }
328
329 if (strcmp(protocol, "vnc") == 0) {
330 if (fail_if_connected || disconnect_if_connected) {
331 /* vnc supports "connected=keep" only */
332 error_setg(errp, QERR_INVALID_PARAMETER, "connected");
333 return;
334 }
335 /* Note that setting an empty password will not disable login through
336 * this interface. */
337 rc = vnc_display_password(NULL, password);
338 if (rc < 0) {
339 error_setg(errp, QERR_SET_PASSWD_FAILED);
340 }
341 return;
342 }
343
344 error_setg(errp, QERR_INVALID_PARAMETER, "protocol");
345 }
346
347 void qmp_expire_password(const char *protocol, const char *whenstr,
348 Error **errp)
349 {
350 time_t when;
351 int rc;
352
353 if (strcmp(whenstr, "now") == 0) {
354 when = 0;
355 } else if (strcmp(whenstr, "never") == 0) {
356 when = TIME_MAX;
357 } else if (whenstr[0] == '+') {
358 when = time(NULL) + strtoull(whenstr+1, NULL, 10);
359 } else {
360 when = strtoull(whenstr, NULL, 10);
361 }
362
363 if (strcmp(protocol, "spice") == 0) {
364 if (!qemu_using_spice(errp)) {
365 return;
366 }
367 rc = qemu_spice_set_pw_expire(when);
368 if (rc != 0) {
369 error_setg(errp, QERR_SET_PASSWD_FAILED);
370 }
371 return;
372 }
373
374 if (strcmp(protocol, "vnc") == 0) {
375 rc = vnc_display_pw_expire(NULL, when);
376 if (rc != 0) {
377 error_setg(errp, QERR_SET_PASSWD_FAILED);
378 }
379 return;
380 }
381
382 error_setg(errp, QERR_INVALID_PARAMETER, "protocol");
383 }
384
385 #ifdef CONFIG_VNC
386 void qmp_change_vnc_password(const char *password, Error **errp)
387 {
388 if (vnc_display_password(NULL, password) < 0) {
389 error_setg(errp, QERR_SET_PASSWD_FAILED);
390 }
391 }
392
393 static void qmp_change_vnc_listen(const char *target, Error **errp)
394 {
395 QemuOptsList *olist = qemu_find_opts("vnc");
396 QemuOpts *opts;
397
398 if (strstr(target, "id=")) {
399 error_setg(errp, "id not supported");
400 return;
401 }
402
403 opts = qemu_opts_find(olist, "default");
404 if (opts) {
405 qemu_opts_del(opts);
406 }
407 opts = vnc_parse(target, errp);
408 if (!opts) {
409 return;
410 }
411
412 vnc_display_open("default", errp);
413 }
414
415 static void qmp_change_vnc(const char *target, bool has_arg, const char *arg,
416 Error **errp)
417 {
418 if (strcmp(target, "passwd") == 0 || strcmp(target, "password") == 0) {
419 if (!has_arg) {
420 error_setg(errp, QERR_MISSING_PARAMETER, "password");
421 } else {
422 qmp_change_vnc_password(arg, errp);
423 }
424 } else {
425 qmp_change_vnc_listen(target, errp);
426 }
427 }
428 #else
429 void qmp_change_vnc_password(const char *password, Error **errp)
430 {
431 error_setg(errp, QERR_FEATURE_DISABLED, "vnc");
432 }
433 static void qmp_change_vnc(const char *target, bool has_arg, const char *arg,
434 Error **errp)
435 {
436 error_setg(errp, QERR_FEATURE_DISABLED, "vnc");
437 }
438 #endif /* !CONFIG_VNC */
439
440 void qmp_change(const char *device, const char *target,
441 bool has_arg, const char *arg, Error **errp)
442 {
443 if (strcmp(device, "vnc") == 0) {
444 qmp_change_vnc(target, has_arg, arg, errp);
445 } else {
446 qmp_blockdev_change_medium(device, target, has_arg, arg, false, 0,
447 errp);
448 }
449 }
450
451 static void qom_list_types_tramp(ObjectClass *klass, void *data)
452 {
453 ObjectTypeInfoList *e, **pret = data;
454 ObjectTypeInfo *info;
455
456 info = g_malloc0(sizeof(*info));
457 info->name = g_strdup(object_class_get_name(klass));
458
459 e = g_malloc0(sizeof(*e));
460 e->value = info;
461 e->next = *pret;
462 *pret = e;
463 }
464
465 ObjectTypeInfoList *qmp_qom_list_types(bool has_implements,
466 const char *implements,
467 bool has_abstract,
468 bool abstract,
469 Error **errp)
470 {
471 ObjectTypeInfoList *ret = NULL;
472
473 object_class_foreach(qom_list_types_tramp, implements, abstract, &ret);
474
475 return ret;
476 }
477
478 /* Return a DevicePropertyInfo for a qdev property.
479 *
480 * If a qdev property with the given name does not exist, use the given default
481 * type. If the qdev property info should not be shown, return NULL.
482 *
483 * The caller must free the return value.
484 */
485 static DevicePropertyInfo *make_device_property_info(ObjectClass *klass,
486 const char *name,
487 const char *default_type,
488 const char *description)
489 {
490 DevicePropertyInfo *info;
491 Property *prop;
492
493 do {
494 for (prop = DEVICE_CLASS(klass)->props; prop && prop->name; prop++) {
495 if (strcmp(name, prop->name) != 0) {
496 continue;
497 }
498
499 /*
500 * TODO Properties without a parser are just for dirty hacks.
501 * qdev_prop_ptr is the only such PropertyInfo. It's marked
502 * for removal. This conditional should be removed along with
503 * it.
504 */
505 if (!prop->info->set) {
506 return NULL; /* no way to set it, don't show */
507 }
508
509 info = g_malloc0(sizeof(*info));
510 info->name = g_strdup(prop->name);
511 info->type = g_strdup(prop->info->name);
512 info->has_description = !!prop->info->description;
513 info->description = g_strdup(prop->info->description);
514 return info;
515 }
516 klass = object_class_get_parent(klass);
517 } while (klass != object_class_by_name(TYPE_DEVICE));
518
519 /* Not a qdev property, use the default type */
520 info = g_malloc0(sizeof(*info));
521 info->name = g_strdup(name);
522 info->type = g_strdup(default_type);
523 info->has_description = !!description;
524 info->description = g_strdup(description);
525
526 return info;
527 }
528
529 DevicePropertyInfoList *qmp_device_list_properties(const char *typename,
530 Error **errp)
531 {
532 ObjectClass *klass;
533 Object *obj;
534 ObjectProperty *prop;
535 ObjectPropertyIterator iter;
536 DevicePropertyInfoList *prop_list = NULL;
537
538 klass = object_class_by_name(typename);
539 if (klass == NULL) {
540 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
541 "Device '%s' not found", typename);
542 return NULL;
543 }
544
545 klass = object_class_dynamic_cast(klass, TYPE_DEVICE);
546 if (klass == NULL) {
547 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "name", TYPE_DEVICE);
548 return NULL;
549 }
550
551 if (object_class_is_abstract(klass)) {
552 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "name",
553 "non-abstract device type");
554 return NULL;
555 }
556
557 if (DEVICE_CLASS(klass)->cannot_destroy_with_object_finalize_yet) {
558 error_setg(errp, "Can't list properties of device '%s'", typename);
559 return NULL;
560 }
561
562 obj = object_new(typename);
563
564 object_property_iter_init(&iter, obj);
565 while ((prop = object_property_iter_next(&iter))) {
566 DevicePropertyInfo *info;
567 DevicePropertyInfoList *entry;
568
569 /* Skip Object and DeviceState properties */
570 if (strcmp(prop->name, "type") == 0 ||
571 strcmp(prop->name, "realized") == 0 ||
572 strcmp(prop->name, "hotpluggable") == 0 ||
573 strcmp(prop->name, "hotplugged") == 0 ||
574 strcmp(prop->name, "parent_bus") == 0) {
575 continue;
576 }
577
578 /* Skip legacy properties since they are just string versions of
579 * properties that we already list.
580 */
581 if (strstart(prop->name, "legacy-", NULL)) {
582 continue;
583 }
584
585 info = make_device_property_info(klass, prop->name, prop->type,
586 prop->description);
587 if (!info) {
588 continue;
589 }
590
591 entry = g_malloc0(sizeof(*entry));
592 entry->value = info;
593 entry->next = prop_list;
594 prop_list = entry;
595 }
596
597 object_unref(obj);
598
599 return prop_list;
600 }
601
602 CpuDefinitionInfoList *qmp_query_cpu_definitions(Error **errp)
603 {
604 return arch_query_cpu_definitions(errp);
605 }
606
607 void qmp_add_client(const char *protocol, const char *fdname,
608 bool has_skipauth, bool skipauth, bool has_tls, bool tls,
609 Error **errp)
610 {
611 CharDriverState *s;
612 int fd;
613
614 fd = monitor_get_fd(cur_mon, fdname, errp);
615 if (fd < 0) {
616 return;
617 }
618
619 if (strcmp(protocol, "spice") == 0) {
620 if (!qemu_using_spice(errp)) {
621 close(fd);
622 return;
623 }
624 skipauth = has_skipauth ? skipauth : false;
625 tls = has_tls ? tls : false;
626 if (qemu_spice_display_add_client(fd, skipauth, tls) < 0) {
627 error_setg(errp, "spice failed to add client");
628 close(fd);
629 }
630 return;
631 #ifdef CONFIG_VNC
632 } else if (strcmp(protocol, "vnc") == 0) {
633 skipauth = has_skipauth ? skipauth : false;
634 vnc_display_add_client(NULL, fd, skipauth);
635 return;
636 #endif
637 } else if ((s = qemu_chr_find(protocol)) != NULL) {
638 if (qemu_chr_add_client(s, fd) < 0) {
639 error_setg(errp, "failed to add client");
640 close(fd);
641 return;
642 }
643 return;
644 }
645
646 error_setg(errp, "protocol '%s' is invalid", protocol);
647 close(fd);
648 }
649
650
651 void qmp_object_add(const char *type, const char *id,
652 bool has_props, QObject *props, Error **errp)
653 {
654 const QDict *pdict = NULL;
655 QmpInputVisitor *qiv;
656 Object *obj;
657
658 if (props) {
659 pdict = qobject_to_qdict(props);
660 if (!pdict) {
661 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, "props", "dict");
662 return;
663 }
664 }
665
666 qiv = qmp_input_visitor_new(props, true);
667 obj = user_creatable_add_type(type, id, pdict,
668 qmp_input_get_visitor(qiv), errp);
669 qmp_input_visitor_cleanup(qiv);
670 if (obj) {
671 object_unref(obj);
672 }
673 }
674
675 void qmp_object_del(const char *id, Error **errp)
676 {
677 user_creatable_del(id, errp);
678 }
679
680 MemoryDeviceInfoList *qmp_query_memory_devices(Error **errp)
681 {
682 MemoryDeviceInfoList *head = NULL;
683 MemoryDeviceInfoList **prev = &head;
684
685 qmp_pc_dimm_device_list(qdev_get_machine(), &prev);
686
687 return head;
688 }
689
690 ACPIOSTInfoList *qmp_query_acpi_ospm_status(Error **errp)
691 {
692 bool ambig;
693 ACPIOSTInfoList *head = NULL;
694 ACPIOSTInfoList **prev = &head;
695 Object *obj = object_resolve_path_type("", TYPE_ACPI_DEVICE_IF, &ambig);
696
697 if (obj) {
698 AcpiDeviceIfClass *adevc = ACPI_DEVICE_IF_GET_CLASS(obj);
699 AcpiDeviceIf *adev = ACPI_DEVICE_IF(obj);
700
701 adevc->ospm_status(adev, &prev);
702 } else {
703 error_setg(errp, "command is not supported, missing ACPI device");
704 }
705
706 return head;
707 }