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