softmmu/qdev-monitor.c

   1 /*
   2  *  Dynamic device configuration and creation.
   3  *
   4  *  Copyright (c) 2009 CodeSourcery
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include "qemu/osdep.h"
  21 #include "hw/sysbus.h"
  22 #include "monitor/hmp.h"
  23 #include "monitor/monitor.h"
  24 #include "monitor/qdev.h"
  25 #include "sysemu/arch_init.h"
  26 #include "qapi/error.h"
  27 #include "qapi/qapi-commands-qdev.h"
  28 #include "qapi/qmp/dispatch.h"
  29 #include "qapi/qmp/qdict.h"
  30 #include "qapi/qmp/qerror.h"
  31 #include "qemu/config-file.h"
  32 #include "qemu/error-report.h"
  33 #include "qemu/help_option.h"
  34 #include "qemu/option.h"
  35 #include "qemu/qemu-print.h"
  36 #include "qemu/option_int.h"
  37 #include "sysemu/block-backend.h"
  38 #include "migration/misc.h"
  39 #include "migration/migration.h"
  40 #include "qemu/cutils.h"
  41 #include "hw/qdev-properties.h"
  42 #include "hw/clock.h"
  43
  44 /*
  45  * Aliases were a bad idea from the start.  Let's keep them
  46  * from spreading further.
  47  */
  48 typedef struct QDevAlias
  49 {
  50     const char *typename;
  51     const char *alias;
  52     uint32_t arch_mask;
  53 } QDevAlias;
  54
  55 /* default virtio transport per architecture */
  56 #define QEMU_ARCH_VIRTIO_PCI (QEMU_ARCH_ALPHA | QEMU_ARCH_ARM | \
  57                               QEMU_ARCH_HPPA | QEMU_ARCH_I386 | \
  58                               QEMU_ARCH_MIPS | QEMU_ARCH_PPC |  \
  59                               QEMU_ARCH_RISCV | QEMU_ARCH_SH4 | \
  60                               QEMU_ARCH_SPARC | QEMU_ARCH_XTENSA)
  61 #define QEMU_ARCH_VIRTIO_CCW (QEMU_ARCH_S390X)
  62 #define QEMU_ARCH_VIRTIO_MMIO (QEMU_ARCH_M68K)
  63
  64 /* Please keep this table sorted by typename. */
  65 static const QDevAlias qdev_alias_table[] = {
  66     { "AC97", "ac97" }, /* -soundhw name */
  67     { "e1000", "e1000-82540em" },
  68     { "ES1370", "es1370" }, /* -soundhw name */
  69     { "ich9-ahci", "ahci" },
  70     { "lsi53c895a", "lsi" },
  71     { "virtio-9p-device", "virtio-9p", QEMU_ARCH_VIRTIO_MMIO },
  72     { "virtio-9p-ccw", "virtio-9p", QEMU_ARCH_VIRTIO_CCW },
  73     { "virtio-9p-pci", "virtio-9p", QEMU_ARCH_VIRTIO_PCI },
  74     { "virtio-balloon-device", "virtio-balloon", QEMU_ARCH_VIRTIO_MMIO },
  75     { "virtio-balloon-ccw", "virtio-balloon", QEMU_ARCH_VIRTIO_CCW },
  76     { "virtio-balloon-pci", "virtio-balloon", QEMU_ARCH_VIRTIO_PCI },
  77     { "virtio-blk-device", "virtio-blk", QEMU_ARCH_VIRTIO_MMIO },
  78     { "virtio-blk-ccw", "virtio-blk", QEMU_ARCH_VIRTIO_CCW },
  79     { "virtio-blk-pci", "virtio-blk", QEMU_ARCH_VIRTIO_PCI },
  80     { "virtio-gpu-device", "virtio-gpu", QEMU_ARCH_VIRTIO_MMIO },
  81     { "virtio-gpu-ccw", "virtio-gpu", QEMU_ARCH_VIRTIO_CCW },
  82     { "virtio-gpu-pci", "virtio-gpu", QEMU_ARCH_VIRTIO_PCI },
  83     { "virtio-input-host-device", "virtio-input-host", QEMU_ARCH_VIRTIO_MMIO },
  84     { "virtio-input-host-ccw", "virtio-input-host", QEMU_ARCH_VIRTIO_CCW },
  85     { "virtio-input-host-pci", "virtio-input-host", QEMU_ARCH_VIRTIO_PCI },
  86     { "virtio-iommu-pci", "virtio-iommu", QEMU_ARCH_VIRTIO_PCI },
  87     { "virtio-keyboard-device", "virtio-keyboard", QEMU_ARCH_VIRTIO_MMIO },
  88     { "virtio-keyboard-ccw", "virtio-keyboard", QEMU_ARCH_VIRTIO_CCW },
  89     { "virtio-keyboard-pci", "virtio-keyboard", QEMU_ARCH_VIRTIO_PCI },
  90     { "virtio-mouse-device", "virtio-mouse", QEMU_ARCH_VIRTIO_MMIO },
  91     { "virtio-mouse-ccw", "virtio-mouse", QEMU_ARCH_VIRTIO_CCW },
  92     { "virtio-mouse-pci", "virtio-mouse", QEMU_ARCH_VIRTIO_PCI },
  93     { "virtio-net-device", "virtio-net", QEMU_ARCH_VIRTIO_MMIO },
  94     { "virtio-net-ccw", "virtio-net", QEMU_ARCH_VIRTIO_CCW },
  95     { "virtio-net-pci", "virtio-net", QEMU_ARCH_VIRTIO_PCI },
  96     { "virtio-rng-device", "virtio-rng", QEMU_ARCH_VIRTIO_MMIO },
  97     { "virtio-rng-ccw", "virtio-rng", QEMU_ARCH_VIRTIO_CCW },
  98     { "virtio-rng-pci", "virtio-rng", QEMU_ARCH_VIRTIO_PCI },
  99     { "virtio-scsi-device", "virtio-scsi", QEMU_ARCH_VIRTIO_MMIO },
 100     { "virtio-scsi-ccw", "virtio-scsi", QEMU_ARCH_VIRTIO_CCW },
 101     { "virtio-scsi-pci", "virtio-scsi", QEMU_ARCH_VIRTIO_PCI },
 102     { "virtio-serial-device", "virtio-serial", QEMU_ARCH_VIRTIO_MMIO },
 103     { "virtio-serial-ccw", "virtio-serial", QEMU_ARCH_VIRTIO_CCW },
 104     { "virtio-serial-pci", "virtio-serial", QEMU_ARCH_VIRTIO_PCI},
 105     { "virtio-tablet-device", "virtio-tablet", QEMU_ARCH_VIRTIO_MMIO },
 106     { "virtio-tablet-ccw", "virtio-tablet", QEMU_ARCH_VIRTIO_CCW },
 107     { "virtio-tablet-pci", "virtio-tablet", QEMU_ARCH_VIRTIO_PCI },
 108     { }
 109 };
 110
 111 static const char *qdev_class_get_alias(DeviceClass *dc)
 112 {
 113     const char *typename = object_class_get_name(OBJECT_CLASS(dc));
 114     int i;
 115
 116     for (i = 0; qdev_alias_table[i].typename; i++) {
 117         if (qdev_alias_table[i].arch_mask &&
 118             !(qdev_alias_table[i].arch_mask & arch_type)) {
 119             continue;
 120         }
 121
 122         if (strcmp(qdev_alias_table[i].typename, typename) == 0) {
 123             return qdev_alias_table[i].alias;
 124         }
 125     }
 126
 127     return NULL;
 128 }
 129
 130 static bool qdev_class_has_alias(DeviceClass *dc)
 131 {
 132     return (qdev_class_get_alias(dc) != NULL);
 133 }
 134
 135 static void qdev_print_devinfo(DeviceClass *dc)
 136 {
 137     qemu_printf("name \"%s\"", object_class_get_name(OBJECT_CLASS(dc)));
 138     if (dc->bus_type) {
 139         qemu_printf(", bus %s", dc->bus_type);
 140     }
 141     if (qdev_class_has_alias(dc)) {
 142         qemu_printf(", alias \"%s\"", qdev_class_get_alias(dc));
 143     }
 144     if (dc->desc) {
 145         qemu_printf(", desc \"%s\"", dc->desc);
 146     }
 147     if (!dc->user_creatable) {
 148         qemu_printf(", no-user");
 149     }
 150     qemu_printf("\n");
 151 }
 152
 153 static void qdev_print_devinfos(bool show_no_user)
 154 {
 155     static const char *cat_name[DEVICE_CATEGORY_MAX + 1] = {
 156         [DEVICE_CATEGORY_BRIDGE]  = "Controller/Bridge/Hub",
 157         [DEVICE_CATEGORY_USB]     = "USB",
 158         [DEVICE_CATEGORY_STORAGE] = "Storage",
 159         [DEVICE_CATEGORY_NETWORK] = "Network",
 160         [DEVICE_CATEGORY_INPUT]   = "Input",
 161         [DEVICE_CATEGORY_DISPLAY] = "Display",
 162         [DEVICE_CATEGORY_SOUND]   = "Sound",
 163         [DEVICE_CATEGORY_MISC]    = "Misc",
 164         [DEVICE_CATEGORY_CPU]     = "CPU",
 165         [DEVICE_CATEGORY_MAX]     = "Uncategorized",
 166     };
 167     GSList *list, *elt;
 168     int i;
 169     bool cat_printed;
 170
 171     module_load_qom_all();
 172     list = object_class_get_list_sorted(TYPE_DEVICE, false);
 173
 174     for (i = 0; i <= DEVICE_CATEGORY_MAX; i++) {
 175         cat_printed = false;
 176         for (elt = list; elt; elt = elt->next) {
 177             DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
 178                                                  TYPE_DEVICE);
 179             if ((i < DEVICE_CATEGORY_MAX
 180                  ? !test_bit(i, dc->categories)
 181                  : !bitmap_empty(dc->categories, DEVICE_CATEGORY_MAX))
 182                 || (!show_no_user
 183                     && !dc->user_creatable)) {
 184                 continue;
 185             }
 186             if (!cat_printed) {
 187                 qemu_printf("%s%s devices:\n", i ? "\n" : "", cat_name[i]);
 188                 cat_printed = true;
 189             }
 190             qdev_print_devinfo(dc);
 191         }
 192     }
 193
 194     g_slist_free(list);
 195 }
 196
 197 static int set_property(void *opaque, const char *name, const char *value,
 198                         Error **errp)
 199 {
 200     Object *obj = opaque;
 201
 202     if (strcmp(name, "driver") == 0)
 203         return 0;
 204     if (strcmp(name, "bus") == 0)
 205         return 0;
 206
 207     if (!object_property_parse(obj, name, value, errp)) {
 208         return -1;
 209     }
 210     return 0;
 211 }
 212
 213 static const char *find_typename_by_alias(const char *alias)
 214 {
 215     int i;
 216
 217     for (i = 0; qdev_alias_table[i].alias; i++) {
 218         if (qdev_alias_table[i].arch_mask &&
 219             !(qdev_alias_table[i].arch_mask & arch_type)) {
 220             continue;
 221         }
 222
 223         if (strcmp(qdev_alias_table[i].alias, alias) == 0) {
 224             return qdev_alias_table[i].typename;
 225         }
 226     }
 227
 228     return NULL;
 229 }
 230
 231 static DeviceClass *qdev_get_device_class(const char **driver, Error **errp)
 232 {
 233     ObjectClass *oc;
 234     DeviceClass *dc;
 235     const char *original_name = *driver;
 236
 237     oc = module_object_class_by_name(*driver);
 238     if (!oc) {
 239         const char *typename = find_typename_by_alias(*driver);
 240
 241         if (typename) {
 242             *driver = typename;
 243             oc = module_object_class_by_name(*driver);
 244         }
 245     }
 246
 247     if (!object_class_dynamic_cast(oc, TYPE_DEVICE)) {
 248         if (*driver != original_name) {
 249             error_setg(errp, "'%s' (alias '%s') is not a valid device model"
 250                        " name", original_name, *driver);
 251         } else {
 252             error_setg(errp, "'%s' is not a valid device model name", *driver);
 253         }
 254         return NULL;
 255     }
 256
 257     if (object_class_is_abstract(oc)) {
 258         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
 259                    "a non-abstract device type");
 260         return NULL;
 261     }
 262
 263     dc = DEVICE_CLASS(oc);
 264     if (!dc->user_creatable ||
 265         (phase_check(PHASE_MACHINE_READY) && !dc->hotpluggable)) {
 266         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
 267                    "a pluggable device type");
 268         return NULL;
 269     }
 270
 271     return dc;
 272 }
 273
 274
 275 int qdev_device_help(QemuOpts *opts)
 276 {
 277     Error *local_err = NULL;
 278     const char *driver;
 279     ObjectPropertyInfoList *prop_list;
 280     ObjectPropertyInfoList *prop;
 281     GPtrArray *array;
 282     int i;
 283
 284     driver = qemu_opt_get(opts, "driver");
 285     if (driver && is_help_option(driver)) {
 286         qdev_print_devinfos(false);
 287         return 1;
 288     }
 289
 290     if (!driver || !qemu_opt_has_help_opt(opts)) {
 291         return 0;
 292     }
 293
 294     if (!object_class_by_name(driver)) {
 295         const char *typename = find_typename_by_alias(driver);
 296
 297         if (typename) {
 298             driver = typename;
 299         }
 300     }
 301
 302     prop_list = qmp_device_list_properties(driver, &local_err);
 303     if (local_err) {
 304         goto error;
 305     }
 306
 307     if (prop_list) {
 308         qemu_printf("%s options:\n", driver);
 309     } else {
 310         qemu_printf("There are no options for %s.\n", driver);
 311     }
 312     array = g_ptr_array_new();
 313     for (prop = prop_list; prop; prop = prop->next) {
 314         g_ptr_array_add(array,
 315                         object_property_help(prop->value->name,
 316                                              prop->value->type,
 317                                              prop->value->default_value,
 318                                              prop->value->description));
 319     }
 320     g_ptr_array_sort(array, (GCompareFunc)qemu_pstrcmp0);
 321     for (i = 0; i < array->len; i++) {
 322         qemu_printf("%s\n", (char *)array->pdata[i]);
 323     }
 324     g_ptr_array_set_free_func(array, g_free);
 325     g_ptr_array_free(array, true);
 326     qapi_free_ObjectPropertyInfoList(prop_list);
 327     return 1;
 328
 329 error:
 330     error_report_err(local_err);
 331     return 1;
 332 }
 333
 334 static Object *qdev_get_peripheral(void)
 335 {
 336     static Object *dev;
 337
 338     if (dev == NULL) {
 339         dev = container_get(qdev_get_machine(), "/peripheral");
 340     }
 341
 342     return dev;
 343 }
 344
 345 static Object *qdev_get_peripheral_anon(void)
 346 {
 347     static Object *dev;
 348
 349     if (dev == NULL) {
 350         dev = container_get(qdev_get_machine(), "/peripheral-anon");
 351     }
 352
 353     return dev;
 354 }
 355
 356 static void qbus_error_append_bus_list_hint(DeviceState *dev,
 357                                             Error *const *errp)
 358 {
 359     BusState *child;
 360     const char *sep = " ";
 361
 362     error_append_hint(errp, "child buses at \"%s\":",
 363                       dev->id ? dev->id : object_get_typename(OBJECT(dev)));
 364     QLIST_FOREACH(child, &dev->child_bus, sibling) {
 365         error_append_hint(errp, "%s\"%s\"", sep, child->name);
 366         sep = ", ";
 367     }
 368     error_append_hint(errp, "\n");
 369 }
 370
 371 static void qbus_error_append_dev_list_hint(BusState *bus,
 372                                             Error *const *errp)
 373 {
 374     BusChild *kid;
 375     const char *sep = " ";
 376
 377     error_append_hint(errp, "devices at \"%s\":", bus->name);
 378     QTAILQ_FOREACH(kid, &bus->children, sibling) {
 379         DeviceState *dev = kid->child;
 380         error_append_hint(errp, "%s\"%s\"", sep,
 381                           object_get_typename(OBJECT(dev)));
 382         if (dev->id) {
 383             error_append_hint(errp, "/\"%s\"", dev->id);
 384         }
 385         sep = ", ";
 386     }
 387     error_append_hint(errp, "\n");
 388 }
 389
 390 static BusState *qbus_find_bus(DeviceState *dev, char *elem)
 391 {
 392     BusState *child;
 393
 394     QLIST_FOREACH(child, &dev->child_bus, sibling) {
 395         if (strcmp(child->name, elem) == 0) {
 396             return child;
 397         }
 398     }
 399     return NULL;
 400 }
 401
 402 static DeviceState *qbus_find_dev(BusState *bus, char *elem)
 403 {
 404     BusChild *kid;
 405
 406     /*
 407      * try to match in order:
 408      *   (1) instance id, if present
 409      *   (2) driver name
 410      *   (3) driver alias, if present
 411      */
 412     QTAILQ_FOREACH(kid, &bus->children, sibling) {
 413         DeviceState *dev = kid->child;
 414         if (dev->id  &&  strcmp(dev->id, elem) == 0) {
 415             return dev;
 416         }
 417     }
 418     QTAILQ_FOREACH(kid, &bus->children, sibling) {
 419         DeviceState *dev = kid->child;
 420         if (strcmp(object_get_typename(OBJECT(dev)), elem) == 0) {
 421             return dev;
 422         }
 423     }
 424     QTAILQ_FOREACH(kid, &bus->children, sibling) {
 425         DeviceState *dev = kid->child;
 426         DeviceClass *dc = DEVICE_GET_CLASS(dev);
 427
 428         if (qdev_class_has_alias(dc) &&
 429             strcmp(qdev_class_get_alias(dc), elem) == 0) {
 430             return dev;
 431         }
 432     }
 433     return NULL;
 434 }
 435
 436 static inline bool qbus_is_full(BusState *bus)
 437 {
 438     BusClass *bus_class = BUS_GET_CLASS(bus);
 439     return bus_class->max_dev && bus->num_children >= bus_class->max_dev;
 440 }
 441
 442 /*
 443  * Search the tree rooted at @bus for a bus.
 444  * If @name, search for a bus with that name.  Note that bus names
 445  * need not be unique.  Yes, that's screwed up.
 446  * Else search for a bus that is a subtype of @bus_typename.
 447  * If more than one exists, prefer one that can take another device.
 448  * Return the bus if found, else %NULL.
 449  */
 450 static BusState *qbus_find_recursive(BusState *bus, const char *name,
 451                                      const char *bus_typename)
 452 {
 453     BusChild *kid;
 454     BusState *pick, *child, *ret;
 455     bool match;
 456
 457     assert(name || bus_typename);
 458     if (name) {
 459         match = !strcmp(bus->name, name);
 460     } else {
 461         match = !!object_dynamic_cast(OBJECT(bus), bus_typename);
 462     }
 463
 464     if (match && !qbus_is_full(bus)) {
 465         return bus;             /* root matches and isn't full */
 466     }
 467
 468     pick = match ? bus : NULL;
 469
 470     QTAILQ_FOREACH(kid, &bus->children, sibling) {
 471         DeviceState *dev = kid->child;
 472         QLIST_FOREACH(child, &dev->child_bus, sibling) {
 473             ret = qbus_find_recursive(child, name, bus_typename);
 474             if (ret && !qbus_is_full(ret)) {
 475                 return ret;     /* a descendant matches and isn't full */
 476             }
 477             if (ret && !pick) {
 478                 pick = ret;
 479             }
 480         }
 481     }
 482
 483     /* root or a descendant matches, but is full */
 484     return pick;
 485 }
 486
 487 static BusState *qbus_find(const char *path, Error **errp)
 488 {
 489     DeviceState *dev;
 490     BusState *bus;
 491     char elem[128];
 492     int pos, len;
 493
 494     /* find start element */
 495     if (path[0] == '/') {
 496         bus = sysbus_get_default();
 497         pos = 0;
 498     } else {
 499         if (sscanf(path, "%127[^/]%n", elem, &len) != 1) {
 500             assert(!path[0]);
 501             elem[0] = len = 0;
 502         }
 503         bus = qbus_find_recursive(sysbus_get_default(), elem, NULL);
 504         if (!bus) {
 505             error_setg(errp, "Bus '%s' not found", elem);
 506             return NULL;
 507         }
 508         pos = len;
 509     }
 510
 511     for (;;) {
 512         assert(path[pos] == '/' || !path[pos]);
 513         while (path[pos] == '/') {
 514             pos++;
 515         }
 516         if (path[pos] == '\0') {
 517             break;
 518         }
 519
 520         /* find device */
 521         if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
 522             g_assert_not_reached();
 523             elem[0] = len = 0;
 524         }
 525         pos += len;
 526         dev = qbus_find_dev(bus, elem);
 527         if (!dev) {
 528             error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
 529                       "Device '%s' not found", elem);
 530             qbus_error_append_dev_list_hint(bus, errp);
 531             return NULL;
 532         }
 533
 534         assert(path[pos] == '/' || !path[pos]);
 535         while (path[pos] == '/') {
 536             pos++;
 537         }
 538         if (path[pos] == '\0') {
 539             /* last specified element is a device.  If it has exactly
 540              * one child bus accept it nevertheless */
 541             if (dev->num_child_bus == 1) {
 542                 bus = QLIST_FIRST(&dev->child_bus);
 543                 break;
 544             }
 545             if (dev->num_child_bus) {
 546                 error_setg(errp, "Device '%s' has multiple child buses",
 547                            elem);
 548                 qbus_error_append_bus_list_hint(dev, errp);
 549             } else {
 550                 error_setg(errp, "Device '%s' has no child bus", elem);
 551             }
 552             return NULL;
 553         }
 554
 555         /* find bus */
 556         if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
 557             g_assert_not_reached();
 558             elem[0] = len = 0;
 559         }
 560         pos += len;
 561         bus = qbus_find_bus(dev, elem);
 562         if (!bus) {
 563             error_setg(errp, "Bus '%s' not found", elem);
 564             qbus_error_append_bus_list_hint(dev, errp);
 565             return NULL;
 566         }
 567     }
 568
 569     if (qbus_is_full(bus)) {
 570         error_setg(errp, "Bus '%s' is full", path);
 571         return NULL;
 572     }
 573     return bus;
 574 }
 575
 576 void qdev_set_id(DeviceState *dev, const char *id)
 577 {
 578     if (id) {
 579         dev->id = id;
 580     }
 581
 582     if (dev->id) {
 583         object_property_add_child(qdev_get_peripheral(), dev->id,
 584                                   OBJECT(dev));
 585     } else {
 586         static int anon_count;
 587         gchar *name = g_strdup_printf("device[%d]", anon_count++);
 588         object_property_add_child(qdev_get_peripheral_anon(), name,
 589                                   OBJECT(dev));
 590         g_free(name);
 591     }
 592 }
 593
 594 DeviceState *qdev_device_add(QemuOpts *opts, Error **errp)
 595 {
 596     DeviceClass *dc;
 597     const char *driver, *path;
 598     DeviceState *dev = NULL;
 599     BusState *bus = NULL;
 600
 601     driver = qemu_opt_get(opts, "driver");
 602     if (!driver) {
 603         error_setg(errp, QERR_MISSING_PARAMETER, "driver");
 604         return NULL;
 605     }
 606
 607     /* find driver */
 608     dc = qdev_get_device_class(&driver, errp);
 609     if (!dc) {
 610         return NULL;
 611     }
 612
 613     /* find bus */
 614     path = qemu_opt_get(opts, "bus");
 615     if (path != NULL) {
 616         bus = qbus_find(path, errp);
 617         if (!bus) {
 618             return NULL;
 619         }
 620         if (!object_dynamic_cast(OBJECT(bus), dc->bus_type)) {
 621             error_setg(errp, "Device '%s' can't go on %s bus",
 622                        driver, object_get_typename(OBJECT(bus)));
 623             return NULL;
 624         }
 625     } else if (dc->bus_type != NULL) {
 626         bus = qbus_find_recursive(sysbus_get_default(), NULL, dc->bus_type);
 627         if (!bus || qbus_is_full(bus)) {
 628             error_setg(errp, "No '%s' bus found for device '%s'",
 629                        dc->bus_type, driver);
 630             return NULL;
 631         }
 632     }
 633
 634     if (qemu_opt_get(opts, "failover_pair_id")) {
 635         if (!opts->id) {
 636             error_setg(errp, "Device with failover_pair_id don't have id");
 637             return NULL;
 638         }
 639         if (qdev_should_hide_device(opts)) {
 640             if (bus && !qbus_is_hotpluggable(bus)) {
 641                 error_setg(errp, QERR_BUS_NO_HOTPLUG, bus->name);
 642             }
 643             return NULL;
 644         }
 645     }
 646
 647     if (phase_check(PHASE_MACHINE_READY) && bus && !qbus_is_hotpluggable(bus)) {
 648         error_setg(errp, QERR_BUS_NO_HOTPLUG, bus->name);
 649         return NULL;
 650     }
 651
 652     if (!migration_is_idle()) {
 653         error_setg(errp, "device_add not allowed while migrating");
 654         return NULL;
 655     }
 656
 657     /* create device */
 658     dev = qdev_new(driver);
 659
 660     /* Check whether the hotplug is allowed by the machine */
 661     if (phase_check(PHASE_MACHINE_READY)) {
 662         if (!qdev_hotplug_allowed(dev, errp)) {
 663             goto err_del_dev;
 664         }
 665
 666         if (!bus && !qdev_get_machine_hotplug_handler(dev)) {
 667             /* No bus, no machine hotplug handler --> device is not hotpluggable */
 668             error_setg(errp, "Device '%s' can not be hotplugged on this machine",
 669                        driver);
 670             goto err_del_dev;
 671         }
 672     }
 673
 674     qdev_set_id(dev, qemu_opts_id(opts));
 675
 676     /* set properties */
 677     if (qemu_opt_foreach(opts, set_property, dev, errp)) {
 678         goto err_del_dev;
 679     }
 680
 681     dev->opts = opts;
 682     if (!qdev_realize(DEVICE(dev), bus, errp)) {
 683         dev->opts = NULL;
 684         goto err_del_dev;
 685     }
 686     return dev;
 687
 688 err_del_dev:
 689     if (dev) {
 690         object_unparent(OBJECT(dev));
 691         object_unref(OBJECT(dev));
 692     }
 693     return NULL;
 694 }
 695
 696
 697 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
 698 static void qbus_print(Monitor *mon, BusState *bus, int indent);
 699
 700 static void qdev_print_props(Monitor *mon, DeviceState *dev, Property *props,
 701                              int indent)
 702 {
 703     if (!props)
 704         return;
 705     for (; props->name; props++) {
 706         char *value;
 707         char *legacy_name = g_strdup_printf("legacy-%s", props->name);
 708
 709         if (object_property_get_type(OBJECT(dev), legacy_name, NULL)) {
 710             value = object_property_get_str(OBJECT(dev), legacy_name, NULL);
 711         } else {
 712             value = object_property_print(OBJECT(dev), props->name, true,
 713                                           NULL);
 714         }
 715         g_free(legacy_name);
 716
 717         if (!value) {
 718             continue;
 719         }
 720         qdev_printf("%s = %s\n", props->name,
 721                     *value ? value : "<null>");
 722         g_free(value);
 723     }
 724 }
 725
 726 static void bus_print_dev(BusState *bus, Monitor *mon, DeviceState *dev, int indent)
 727 {
 728     BusClass *bc = BUS_GET_CLASS(bus);
 729
 730     if (bc->print_dev) {
 731         bc->print_dev(mon, dev, indent);
 732     }
 733 }
 734
 735 static void qdev_print(Monitor *mon, DeviceState *dev, int indent)
 736 {
 737     ObjectClass *class;
 738     BusState *child;
 739     NamedGPIOList *ngl;
 740     NamedClockList *ncl;
 741
 742     qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev)),
 743                 dev->id ? dev->id : "");
 744     indent += 2;
 745     QLIST_FOREACH(ngl, &dev->gpios, node) {
 746         if (ngl->num_in) {
 747             qdev_printf("gpio-in \"%s\" %d\n", ngl->name ? ngl->name : "",
 748                         ngl->num_in);
 749         }
 750         if (ngl->num_out) {
 751             qdev_printf("gpio-out \"%s\" %d\n", ngl->name ? ngl->name : "",
 752                         ngl->num_out);
 753         }
 754     }
 755     QLIST_FOREACH(ncl, &dev->clocks, node) {
 756         g_autofree char *freq_str = clock_display_freq(ncl->clock);
 757         qdev_printf("clock-%s%s \"%s\" freq_hz=%s\n",
 758                     ncl->output ? "out" : "in",
 759                     ncl->alias ? " (alias)" : "",
 760                     ncl->name, freq_str);
 761     }
 762     class = object_get_class(OBJECT(dev));
 763     do {
 764         qdev_print_props(mon, dev, DEVICE_CLASS(class)->props_, indent);
 765         class = object_class_get_parent(class);
 766     } while (class != object_class_by_name(TYPE_DEVICE));
 767     bus_print_dev(dev->parent_bus, mon, dev, indent);
 768     QLIST_FOREACH(child, &dev->child_bus, sibling) {
 769         qbus_print(mon, child, indent);
 770     }
 771 }
 772
 773 static void qbus_print(Monitor *mon, BusState *bus, int indent)
 774 {
 775     BusChild *kid;
 776
 777     qdev_printf("bus: %s\n", bus->name);
 778     indent += 2;
 779     qdev_printf("type %s\n", object_get_typename(OBJECT(bus)));
 780     QTAILQ_FOREACH(kid, &bus->children, sibling) {
 781         DeviceState *dev = kid->child;
 782         qdev_print(mon, dev, indent);
 783     }
 784 }
 785 #undef qdev_printf
 786
 787 void hmp_info_qtree(Monitor *mon, const QDict *qdict)
 788 {
 789     if (sysbus_get_default())
 790         qbus_print(mon, sysbus_get_default(), 0);
 791 }
 792
 793 void hmp_info_qdm(Monitor *mon, const QDict *qdict)
 794 {
 795     qdev_print_devinfos(true);
 796 }
 797
 798 void qmp_device_add(QDict *qdict, QObject **ret_data, Error **errp)
 799 {
 800     QemuOpts *opts;
 801     DeviceState *dev;
 802
 803     opts = qemu_opts_from_qdict(qemu_find_opts("device"), qdict, errp);
 804     if (!opts) {
 805         return;
 806     }
 807     if (!monitor_cur_is_qmp() && qdev_device_help(opts)) {
 808         qemu_opts_del(opts);
 809         return;
 810     }
 811     dev = qdev_device_add(opts, errp);
 812
 813     /*
 814      * Drain all pending RCU callbacks. This is done because
 815      * some bus related operations can delay a device removal
 816      * (in this case this can happen if device is added and then
 817      * removed due to a configuration error)
 818      * to a RCU callback, but user might expect that this interface
 819      * will finish its job completely once qmp command returns result
 820      * to the user
 821      */
 822     drain_call_rcu();
 823
 824     if (!dev) {
 825         qemu_opts_del(opts);
 826         return;
 827     }
 828     object_unref(OBJECT(dev));
 829 }
 830
 831 static DeviceState *find_device_state(const char *id, Error **errp)
 832 {
 833     Object *obj;
 834
 835     if (id[0] == '/') {
 836         obj = object_resolve_path(id, NULL);
 837     } else {
 838         char *root_path = object_get_canonical_path(qdev_get_peripheral());
 839         char *path = g_strdup_printf("%s/%s", root_path, id);
 840
 841         g_free(root_path);
 842         obj = object_resolve_path_type(path, TYPE_DEVICE, NULL);
 843         g_free(path);
 844     }
 845
 846     if (!obj) {
 847         error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
 848                   "Device '%s' not found", id);
 849         return NULL;
 850     }
 851
 852     if (!object_dynamic_cast(obj, TYPE_DEVICE)) {
 853         error_setg(errp, "%s is not a hotpluggable device", id);
 854         return NULL;
 855     }
 856
 857     return DEVICE(obj);
 858 }
 859
 860 void qdev_unplug(DeviceState *dev, Error **errp)
 861 {
 862     DeviceClass *dc = DEVICE_GET_CLASS(dev);
 863     HotplugHandler *hotplug_ctrl;
 864     HotplugHandlerClass *hdc;
 865     Error *local_err = NULL;
 866
 867     if (dev->parent_bus && !qbus_is_hotpluggable(dev->parent_bus)) {
 868         error_setg(errp, QERR_BUS_NO_HOTPLUG, dev->parent_bus->name);
 869         return;
 870     }
 871
 872     if (!dc->hotpluggable) {
 873         error_setg(errp, QERR_DEVICE_NO_HOTPLUG,
 874                    object_get_typename(OBJECT(dev)));
 875         return;
 876     }
 877
 878     if (!migration_is_idle() && !dev->allow_unplug_during_migration) {
 879         error_setg(errp, "device_del not allowed while migrating");
 880         return;
 881     }
 882
 883     qdev_hot_removed = true;
 884
 885     hotplug_ctrl = qdev_get_hotplug_handler(dev);
 886     /* hotpluggable device MUST have HotplugHandler, if it doesn't
 887      * then something is very wrong with it */
 888     g_assert(hotplug_ctrl);
 889
 890     /* If device supports async unplug just request it to be done,
 891      * otherwise just remove it synchronously */
 892     hdc = HOTPLUG_HANDLER_GET_CLASS(hotplug_ctrl);
 893     if (hdc->unplug_request) {
 894         hotplug_handler_unplug_request(hotplug_ctrl, dev, &local_err);
 895     } else {
 896         hotplug_handler_unplug(hotplug_ctrl, dev, &local_err);
 897         if (!local_err) {
 898             object_unparent(OBJECT(dev));
 899         }
 900     }
 901     error_propagate(errp, local_err);
 902 }
 903
 904 void qmp_device_del(const char *id, Error **errp)
 905 {
 906     DeviceState *dev = find_device_state(id, errp);
 907     if (dev != NULL) {
 908         if (dev->pending_deleted_event) {
 909             error_setg(errp, "Device %s is already in the "
 910                              "process of unplug", id);
 911             return;
 912         }
 913
 914         qdev_unplug(dev, errp);
 915     }
 916 }
 917
 918 void hmp_device_add(Monitor *mon, const QDict *qdict)
 919 {
 920     Error *err = NULL;
 921
 922     qmp_device_add((QDict *)qdict, NULL, &err);
 923     hmp_handle_error(mon, err);
 924 }
 925
 926 void hmp_device_del(Monitor *mon, const QDict *qdict)
 927 {
 928     const char *id = qdict_get_str(qdict, "id");
 929     Error *err = NULL;
 930
 931     qmp_device_del(id, &err);
 932     hmp_handle_error(mon, err);
 933 }
 934
 935 BlockBackend *blk_by_qdev_id(const char *id, Error **errp)
 936 {
 937     DeviceState *dev;
 938     BlockBackend *blk;
 939
 940     dev = find_device_state(id, errp);
 941     if (dev == NULL) {
 942         return NULL;
 943     }
 944
 945     blk = blk_by_dev(dev);
 946     if (!blk) {
 947         error_setg(errp, "Device does not have a block device backend");
 948     }
 949     return blk;
 950 }
 951
 952 QemuOptsList qemu_device_opts = {
 953     .name = "device",
 954     .implied_opt_name = "driver",
 955     .head = QTAILQ_HEAD_INITIALIZER(qemu_device_opts.head),
 956     .desc = {
 957         /*
 958          * no elements => accept any
 959          * sanity checking will happen later
 960          * when setting device properties
 961          */
 962         { /* end of list */ }
 963     },
 964 };
 965
 966 QemuOptsList qemu_global_opts = {
 967     .name = "global",
 968     .head = QTAILQ_HEAD_INITIALIZER(qemu_global_opts.head),
 969     .desc = {
 970         {
 971             .name = "driver",
 972             .type = QEMU_OPT_STRING,
 973         },{
 974             .name = "property",
 975             .type = QEMU_OPT_STRING,
 976         },{
 977             .name = "value",
 978             .type = QEMU_OPT_STRING,
 979         },
 980         { /* end of list */ }
 981     },
 982 };
 983
 984 int qemu_global_option(const char *str)
 985 {
 986     char driver[64], property[64];
 987     QemuOpts *opts;
 988     int rc, offset;
 989
 990     rc = sscanf(str, "%63[^.=].%63[^=]%n", driver, property, &offset);
 991     if (rc == 2 && str[offset] == '=') {
 992         opts = qemu_opts_create(&qemu_global_opts, NULL, 0, &error_abort);
 993         qemu_opt_set(opts, "driver", driver, &error_abort);
 994         qemu_opt_set(opts, "property", property, &error_abort);
 995         qemu_opt_set(opts, "value", str + offset + 1, &error_abort);
 996         return 0;
 997     }
 998
 999     opts = qemu_opts_parse_noisily(&qemu_global_opts, str, false);
1000     if (!opts) {
1001         return -1;
1002     }
1003
1004     return 0;
1005 }
1006
1007 bool qmp_command_available(const QmpCommand *cmd, Error **errp)
1008 {
1009     if (!phase_check(PHASE_MACHINE_READY) &&
1010         !(cmd->options & QCO_ALLOW_PRECONFIG)) {
1011         error_setg(errp, "The command '%s' is permitted only after machine initialization has completed",
1012                    cmd->name);
1013         return false;
1014     }
1015     return true;
1016 }