qmp.c

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