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