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