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