hw/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 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 "qdev.h"
  21 #include "monitor.h"
  22 #include "qmp-commands.h"
  23 #include "arch_init.h"
  24
  25 /*
  26  * Aliases were a bad idea from the start.  Let's keep them
  27  * from spreading further.
  28  */
  29 typedef struct QDevAlias
  30 {
  31     const char *typename;
  32     const char *alias;
  33     uint32_t arch_mask;
  34 } QDevAlias;
  35
  36 static const QDevAlias qdev_alias_table[] = {
  37     { "virtio-blk-pci", "virtio-blk", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
  38     { "virtio-net-pci", "virtio-net", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
  39     { "virtio-serial-pci", "virtio-serial", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
  40     { "virtio-balloon-pci", "virtio-balloon",
  41             QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
  42     { "virtio-blk-s390", "virtio-blk", QEMU_ARCH_S390X },
  43     { "virtio-net-s390", "virtio-net", QEMU_ARCH_S390X },
  44     { "virtio-serial-s390", "virtio-serial", QEMU_ARCH_S390X },
  45     { "lsi53c895a", "lsi" },
  46     { "ich9-ahci", "ahci" },
  47     { }
  48 };
  49
  50 static const char *qdev_class_get_alias(DeviceClass *dc)
  51 {
  52     const char *typename = object_class_get_name(OBJECT_CLASS(dc));
  53     int i;
  54
  55     for (i = 0; qdev_alias_table[i].typename; i++) {
  56         if (qdev_alias_table[i].arch_mask &&
  57             !(qdev_alias_table[i].arch_mask & arch_type)) {
  58             continue;
  59         }
  60
  61         if (strcmp(qdev_alias_table[i].typename, typename) == 0) {
  62             return qdev_alias_table[i].alias;
  63         }
  64     }
  65
  66     return NULL;
  67 }
  68
  69 static bool qdev_class_has_alias(DeviceClass *dc)
  70 {
  71     return (qdev_class_get_alias(dc) != NULL);
  72 }
  73
  74 static void qdev_print_devinfo(ObjectClass *klass, void *opaque)
  75 {
  76     DeviceClass *dc;
  77     bool *show_no_user = opaque;
  78
  79     dc = (DeviceClass *)object_class_dynamic_cast(klass, TYPE_DEVICE);
  80
  81     if (!dc || (show_no_user && !*show_no_user && dc->no_user)) {
  82         return;
  83     }
  84
  85     error_printf("name \"%s\"", object_class_get_name(klass));
  86     if (dc->bus_info) {
  87         error_printf(", bus %s", dc->bus_info->name);
  88     }
  89     if (qdev_class_has_alias(dc)) {
  90         error_printf(", alias \"%s\"", qdev_class_get_alias(dc));
  91     }
  92     if (dc->desc) {
  93         error_printf(", desc \"%s\"", dc->desc);
  94     }
  95     if (dc->no_user) {
  96         error_printf(", no-user");
  97     }
  98     error_printf("\n");
  99 }
 100
 101 static int set_property(const char *name, const char *value, void *opaque)
 102 {
 103     DeviceState *dev = opaque;
 104
 105     if (strcmp(name, "driver") == 0)
 106         return 0;
 107     if (strcmp(name, "bus") == 0)
 108         return 0;
 109
 110     if (qdev_prop_parse(dev, name, value) == -1) {
 111         return -1;
 112     }
 113     return 0;
 114 }
 115
 116 static const char *find_typename_by_alias(const char *alias)
 117 {
 118     int i;
 119
 120     for (i = 0; qdev_alias_table[i].alias; i++) {
 121         if (qdev_alias_table[i].arch_mask &&
 122             !(qdev_alias_table[i].arch_mask & arch_type)) {
 123             continue;
 124         }
 125
 126         if (strcmp(qdev_alias_table[i].alias, alias) == 0) {
 127             return qdev_alias_table[i].typename;
 128         }
 129     }
 130
 131     return NULL;
 132 }
 133
 134 int qdev_device_help(QemuOpts *opts)
 135 {
 136     const char *driver;
 137     Property *prop;
 138     ObjectClass *klass;
 139     DeviceClass *info;
 140
 141     driver = qemu_opt_get(opts, "driver");
 142     if (driver && !strcmp(driver, "?")) {
 143         bool show_no_user = false;
 144         object_class_foreach(qdev_print_devinfo, TYPE_DEVICE, false, &show_no_user);
 145         return 1;
 146     }
 147
 148     if (!driver || !qemu_opt_get(opts, "?")) {
 149         return 0;
 150     }
 151
 152     klass = object_class_by_name(driver);
 153     if (!klass) {
 154         const char *typename = find_typename_by_alias(driver);
 155
 156         if (typename) {
 157             driver = typename;
 158             klass = object_class_by_name(driver);
 159         }
 160     }
 161
 162     if (!klass) {
 163         return 0;
 164     }
 165     info = DEVICE_CLASS(klass);
 166
 167     for (prop = info->props; prop && prop->name; prop++) {
 168         /*
 169          * TODO Properties without a parser are just for dirty hacks.
 170          * qdev_prop_ptr is the only such PropertyInfo.  It's marked
 171          * for removal.  This conditional should be removed along with
 172          * it.
 173          */
 174         if (!prop->info->set) {
 175             continue;           /* no way to set it, don't show */
 176         }
 177         error_printf("%s.%s=%s\n", driver, prop->name,
 178                      prop->info->legacy_name ?: prop->info->name);
 179     }
 180     if (info->bus_info) {
 181         for (prop = info->bus_info->props; prop && prop->name; prop++) {
 182             if (!prop->info->set) {
 183                 continue;           /* no way to set it, don't show */
 184             }
 185             error_printf("%s.%s=%s\n", driver, prop->name,
 186                          prop->info->legacy_name ?: prop->info->name);
 187         }
 188     }
 189     return 1;
 190 }
 191
 192 static Object *qdev_get_peripheral(void)
 193 {
 194     static Object *dev;
 195
 196     if (dev == NULL) {
 197         dev = container_get(qdev_get_machine(), "/peripheral");
 198     }
 199
 200     return dev;
 201 }
 202
 203 static Object *qdev_get_peripheral_anon(void)
 204 {
 205     static Object *dev;
 206
 207     if (dev == NULL) {
 208         dev = container_get(qdev_get_machine(), "/peripheral-anon");
 209     }
 210
 211     return dev;
 212 }
 213
 214 static void qbus_list_bus(DeviceState *dev)
 215 {
 216     BusState *child;
 217     const char *sep = " ";
 218
 219     error_printf("child busses at \"%s\":",
 220                  dev->id ? dev->id : object_get_typename(OBJECT(dev)));
 221     QLIST_FOREACH(child, &dev->child_bus, sibling) {
 222         error_printf("%s\"%s\"", sep, child->name);
 223         sep = ", ";
 224     }
 225     error_printf("\n");
 226 }
 227
 228 static void qbus_list_dev(BusState *bus)
 229 {
 230     DeviceState *dev;
 231     const char *sep = " ";
 232
 233     error_printf("devices at \"%s\":", bus->name);
 234     QTAILQ_FOREACH(dev, &bus->children, sibling) {
 235         error_printf("%s\"%s\"", sep, object_get_typename(OBJECT(dev)));
 236         if (dev->id)
 237             error_printf("/\"%s\"", dev->id);
 238         sep = ", ";
 239     }
 240     error_printf("\n");
 241 }
 242
 243 static BusState *qbus_find_bus(DeviceState *dev, char *elem)
 244 {
 245     BusState *child;
 246
 247     QLIST_FOREACH(child, &dev->child_bus, sibling) {
 248         if (strcmp(child->name, elem) == 0) {
 249             return child;
 250         }
 251     }
 252     return NULL;
 253 }
 254
 255 static DeviceState *qbus_find_dev(BusState *bus, char *elem)
 256 {
 257     DeviceState *dev;
 258
 259     /*
 260      * try to match in order:
 261      *   (1) instance id, if present
 262      *   (2) driver name
 263      *   (3) driver alias, if present
 264      */
 265     QTAILQ_FOREACH(dev, &bus->children, sibling) {
 266         if (dev->id  &&  strcmp(dev->id, elem) == 0) {
 267             return dev;
 268         }
 269     }
 270     QTAILQ_FOREACH(dev, &bus->children, sibling) {
 271         if (strcmp(object_get_typename(OBJECT(dev)), elem) == 0) {
 272             return dev;
 273         }
 274     }
 275     QTAILQ_FOREACH(dev, &bus->children, sibling) {
 276         DeviceClass *dc = DEVICE_GET_CLASS(dev);
 277
 278         if (qdev_class_has_alias(dc) &&
 279             strcmp(qdev_class_get_alias(dc), elem) == 0) {
 280             return dev;
 281         }
 282     }
 283     return NULL;
 284 }
 285
 286 static BusState *qbus_find_recursive(BusState *bus, const char *name,
 287                                      const BusInfo *info)
 288 {
 289     DeviceState *dev;
 290     BusState *child, *ret;
 291     int match = 1;
 292
 293     if (name && (strcmp(bus->name, name) != 0)) {
 294         match = 0;
 295     }
 296     if (info && (bus->info != info)) {
 297         match = 0;
 298     }
 299     if (match) {
 300         return bus;
 301     }
 302
 303     QTAILQ_FOREACH(dev, &bus->children, sibling) {
 304         QLIST_FOREACH(child, &dev->child_bus, sibling) {
 305             ret = qbus_find_recursive(child, name, info);
 306             if (ret) {
 307                 return ret;
 308             }
 309         }
 310     }
 311     return NULL;
 312 }
 313
 314 static BusState *qbus_find(const char *path)
 315 {
 316     DeviceState *dev;
 317     BusState *bus;
 318     char elem[128];
 319     int pos, len;
 320
 321     /* find start element */
 322     if (path[0] == '/') {
 323         bus = sysbus_get_default();
 324         pos = 0;
 325     } else {
 326         if (sscanf(path, "%127[^/]%n", elem, &len) != 1) {
 327             assert(!path[0]);
 328             elem[0] = len = 0;
 329         }
 330         bus = qbus_find_recursive(sysbus_get_default(), elem, NULL);
 331         if (!bus) {
 332             qerror_report(QERR_BUS_NOT_FOUND, elem);
 333             return NULL;
 334         }
 335         pos = len;
 336     }
 337
 338     for (;;) {
 339         assert(path[pos] == '/' || !path[pos]);
 340         while (path[pos] == '/') {
 341             pos++;
 342         }
 343         if (path[pos] == '\0') {
 344             return bus;
 345         }
 346
 347         /* find device */
 348         if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
 349             assert(0);
 350             elem[0] = len = 0;
 351         }
 352         pos += len;
 353         dev = qbus_find_dev(bus, elem);
 354         if (!dev) {
 355             qerror_report(QERR_DEVICE_NOT_FOUND, elem);
 356             if (!monitor_cur_is_qmp()) {
 357                 qbus_list_dev(bus);
 358             }
 359             return NULL;
 360         }
 361
 362         assert(path[pos] == '/' || !path[pos]);
 363         while (path[pos] == '/') {
 364             pos++;
 365         }
 366         if (path[pos] == '\0') {
 367             /* last specified element is a device.  If it has exactly
 368              * one child bus accept it nevertheless */
 369             switch (dev->num_child_bus) {
 370             case 0:
 371                 qerror_report(QERR_DEVICE_NO_BUS, elem);
 372                 return NULL;
 373             case 1:
 374                 return QLIST_FIRST(&dev->child_bus);
 375             default:
 376                 qerror_report(QERR_DEVICE_MULTIPLE_BUSSES, elem);
 377                 if (!monitor_cur_is_qmp()) {
 378                     qbus_list_bus(dev);
 379                 }
 380                 return NULL;
 381             }
 382         }
 383
 384         /* find bus */
 385         if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
 386             assert(0);
 387             elem[0] = len = 0;
 388         }
 389         pos += len;
 390         bus = qbus_find_bus(dev, elem);
 391         if (!bus) {
 392             qerror_report(QERR_BUS_NOT_FOUND, elem);
 393             if (!monitor_cur_is_qmp()) {
 394                 qbus_list_bus(dev);
 395             }
 396             return NULL;
 397         }
 398     }
 399 }
 400
 401 DeviceState *qdev_device_add(QemuOpts *opts)
 402 {
 403     ObjectClass *obj;
 404     DeviceClass *k;
 405     const char *driver, *path, *id;
 406     DeviceState *qdev;
 407     BusState *bus;
 408
 409     driver = qemu_opt_get(opts, "driver");
 410     if (!driver) {
 411         qerror_report(QERR_MISSING_PARAMETER, "driver");
 412         return NULL;
 413     }
 414
 415     /* find driver */
 416     obj = object_class_by_name(driver);
 417     if (!obj) {
 418         const char *typename = find_typename_by_alias(driver);
 419
 420         if (typename) {
 421             driver = typename;
 422             obj = object_class_by_name(driver);
 423         }
 424     }
 425
 426     if (!obj) {
 427         qerror_report(QERR_INVALID_PARAMETER_VALUE, "driver", "device type");
 428         return NULL;
 429     }
 430
 431     k = DEVICE_CLASS(obj);
 432
 433     /* find bus */
 434     path = qemu_opt_get(opts, "bus");
 435     if (path != NULL) {
 436         bus = qbus_find(path);
 437         if (!bus) {
 438             return NULL;
 439         }
 440         if (bus->info != k->bus_info) {
 441             qerror_report(QERR_BAD_BUS_FOR_DEVICE,
 442                            driver, bus->info->name);
 443             return NULL;
 444         }
 445     } else {
 446         bus = qbus_find_recursive(sysbus_get_default(), NULL, k->bus_info);
 447         if (!bus) {
 448             qerror_report(QERR_NO_BUS_FOR_DEVICE,
 449                           driver, k->bus_info->name);
 450             return NULL;
 451         }
 452     }
 453     if (qdev_hotplug && !bus->allow_hotplug) {
 454         qerror_report(QERR_BUS_NO_HOTPLUG, bus->name);
 455         return NULL;
 456     }
 457
 458     if (!bus) {
 459         bus = sysbus_get_default();
 460     }
 461
 462     /* create device, set properties */
 463     qdev = DEVICE(object_new(driver));
 464     qdev_set_parent_bus(qdev, bus);
 465     qdev_prop_set_globals(qdev);
 466
 467     id = qemu_opts_id(opts);
 468     if (id) {
 469         qdev->id = id;
 470     }
 471     if (qemu_opt_foreach(opts, set_property, qdev, 1) != 0) {
 472         qdev_free(qdev);
 473         return NULL;
 474     }
 475     if (qdev->id) {
 476         object_property_add_child(qdev_get_peripheral(), qdev->id,
 477                                   OBJECT(qdev), NULL);
 478     } else {
 479         static int anon_count;
 480         gchar *name = g_strdup_printf("device[%d]", anon_count++);
 481         object_property_add_child(qdev_get_peripheral_anon(), name,
 482                                   OBJECT(qdev), NULL);
 483         g_free(name);
 484     }
 485     if (qdev_init(qdev) < 0) {
 486         qerror_report(QERR_DEVICE_INIT_FAILED, driver);
 487         return NULL;
 488     }
 489     qdev->opts = opts;
 490     return qdev;
 491 }
 492
 493
 494 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
 495 static void qbus_print(Monitor *mon, BusState *bus, int indent);
 496
 497 static void qdev_print_props(Monitor *mon, DeviceState *dev, Property *props,
 498                              const char *prefix, int indent)
 499 {
 500     if (!props)
 501         return;
 502     for (; props->name; props++) {
 503         Error *err = NULL;
 504         char *value;
 505         char *legacy_name = g_strdup_printf("legacy-%s", props->name);
 506         if (object_property_get_type(OBJECT(dev), legacy_name, NULL)) {
 507             value = object_property_get_str(OBJECT(dev), legacy_name, &err);
 508         } else {
 509             value = object_property_print(OBJECT(dev), props->name, &err);
 510         }
 511         g_free(legacy_name);
 512
 513         if (err) {
 514             error_free(err);
 515             continue;
 516         }
 517         qdev_printf("%s-prop: %s = %s\n", prefix, props->name,
 518                     value && *value ? value : "<null>");
 519         g_free(value);
 520     }
 521 }
 522
 523 static void qdev_print(Monitor *mon, DeviceState *dev, int indent)
 524 {
 525     BusState *child;
 526     qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev)),
 527                 dev->id ? dev->id : "");
 528     indent += 2;
 529     if (dev->num_gpio_in) {
 530         qdev_printf("gpio-in %d\n", dev->num_gpio_in);
 531     }
 532     if (dev->num_gpio_out) {
 533         qdev_printf("gpio-out %d\n", dev->num_gpio_out);
 534     }
 535     qdev_print_props(mon, dev, qdev_get_props(dev), "dev", indent);
 536     qdev_print_props(mon, dev, dev->parent_bus->info->props, "bus", indent);
 537     if (dev->parent_bus->info->print_dev)
 538         dev->parent_bus->info->print_dev(mon, dev, indent);
 539     QLIST_FOREACH(child, &dev->child_bus, sibling) {
 540         qbus_print(mon, child, indent);
 541     }
 542 }
 543
 544 static void qbus_print(Monitor *mon, BusState *bus, int indent)
 545 {
 546     struct DeviceState *dev;
 547
 548     qdev_printf("bus: %s\n", bus->name);
 549     indent += 2;
 550     qdev_printf("type %s\n", bus->info->name);
 551     QTAILQ_FOREACH(dev, &bus->children, sibling) {
 552         qdev_print(mon, dev, indent);
 553     }
 554 }
 555 #undef qdev_printf
 556
 557 void do_info_qtree(Monitor *mon)
 558 {
 559     if (sysbus_get_default())
 560         qbus_print(mon, sysbus_get_default(), 0);
 561 }
 562
 563 void do_info_qdm(Monitor *mon)
 564 {
 565     object_class_foreach(qdev_print_devinfo, TYPE_DEVICE, false, NULL);
 566 }
 567
 568 int do_device_add(Monitor *mon, const QDict *qdict, QObject **ret_data)
 569 {
 570     Error *local_err = NULL;
 571     QemuOpts *opts;
 572
 573     opts = qemu_opts_from_qdict(qemu_find_opts("device"), qdict, &local_err);
 574     if (error_is_set(&local_err)) {
 575         qerror_report_err(local_err);
 576         error_free(local_err);
 577         return -1;
 578     }
 579     if (!monitor_cur_is_qmp() && qdev_device_help(opts)) {
 580         qemu_opts_del(opts);
 581         return 0;
 582     }
 583     if (!qdev_device_add(opts)) {
 584         qemu_opts_del(opts);
 585         return -1;
 586     }
 587     return 0;
 588 }
 589
 590 void qmp_device_del(const char *id, Error **errp)
 591 {
 592     DeviceState *dev;
 593
 594     dev = qdev_find_recursive(sysbus_get_default(), id);
 595     if (NULL == dev) {
 596         error_set(errp, QERR_DEVICE_NOT_FOUND, id);
 597         return;
 598     }
 599
 600     qdev_unplug(dev, errp);
 601 }
 602
 603 void qdev_machine_init(void)
 604 {
 605     qdev_get_peripheral_anon();
 606     qdev_get_peripheral();
 607 }