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     }
 296     if (bus_typename && !object_dynamic_cast(OBJECT(bus), bus_typename)) {
 297         match = 0;
 298     }
 299     if ((bus_class->max_dev != 0) && (bus_class->max_dev <= bus->max_index)) {
 300         if (name != NULL) {
 301             /* bus was explicitly specified: return an error. */
 302             qerror_report(ERROR_CLASS_GENERIC_ERROR, "Bus '%s' is full",
 303                           bus->name);
 304             return NULL;
 305         } else {
 306             /* bus was not specified: try to find another one. */
 307             match = 0;
 308         }
 309     }
 310     if (match) {
 311         return bus;
 312     }
 313
 314     QTAILQ_FOREACH(kid, &bus->children, sibling) {
 315         DeviceState *dev = kid->child;
 316         QLIST_FOREACH(child, &dev->child_bus, sibling) {
 317             ret = qbus_find_recursive(child, name, bus_typename);
 318             if (ret) {
 319                 return ret;
 320             }
 321         }
 322     }
 323     return NULL;
 324 }
 325
 326 static BusState *qbus_find(const char *path)
 327 {
 328     DeviceState *dev;
 329     BusState *bus;
 330     char elem[128];
 331     int pos, len;
 332
 333     /* find start element */
 334     if (path[0] == '/') {
 335         bus = sysbus_get_default();
 336         pos = 0;
 337     } else {
 338         if (sscanf(path, "%127[^/]%n", elem, &len) != 1) {
 339             assert(!path[0]);
 340             elem[0] = len = 0;
 341         }
 342         bus = qbus_find_recursive(sysbus_get_default(), elem, NULL);
 343         if (!bus) {
 344             qerror_report(QERR_BUS_NOT_FOUND, elem);
 345             return NULL;
 346         }
 347         pos = len;
 348     }
 349
 350     for (;;) {
 351         assert(path[pos] == '/' || !path[pos]);
 352         while (path[pos] == '/') {
 353             pos++;
 354         }
 355         if (path[pos] == '\0') {
 356             return bus;
 357         }
 358
 359         /* find device */
 360         if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
 361             assert(0);
 362             elem[0] = len = 0;
 363         }
 364         pos += len;
 365         dev = qbus_find_dev(bus, elem);
 366         if (!dev) {
 367             qerror_report(QERR_DEVICE_NOT_FOUND, elem);
 368             if (!monitor_cur_is_qmp()) {
 369                 qbus_list_dev(bus);
 370             }
 371             return NULL;
 372         }
 373
 374         assert(path[pos] == '/' || !path[pos]);
 375         while (path[pos] == '/') {
 376             pos++;
 377         }
 378         if (path[pos] == '\0') {
 379             /* last specified element is a device.  If it has exactly
 380              * one child bus accept it nevertheless */
 381             switch (dev->num_child_bus) {
 382             case 0:
 383                 qerror_report(QERR_DEVICE_NO_BUS, elem);
 384                 return NULL;
 385             case 1:
 386                 return QLIST_FIRST(&dev->child_bus);
 387             default:
 388                 qerror_report(QERR_DEVICE_MULTIPLE_BUSSES, elem);
 389                 if (!monitor_cur_is_qmp()) {
 390                     qbus_list_bus(dev);
 391                 }
 392                 return NULL;
 393             }
 394         }
 395
 396         /* find bus */
 397         if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
 398             assert(0);
 399             elem[0] = len = 0;
 400         }
 401         pos += len;
 402         bus = qbus_find_bus(dev, elem);
 403         if (!bus) {
 404             qerror_report(QERR_BUS_NOT_FOUND, elem);
 405             if (!monitor_cur_is_qmp()) {
 406                 qbus_list_bus(dev);
 407             }
 408             return NULL;
 409         }
 410     }
 411 }
 412
 413 DeviceState *qdev_device_add(QemuOpts *opts)
 414 {
 415     ObjectClass *obj;
 416     DeviceClass *k;
 417     const char *driver, *path, *id;
 418     DeviceState *qdev;
 419     BusState *bus = NULL;
 420
 421     driver = qemu_opt_get(opts, "driver");
 422     if (!driver) {
 423         qerror_report(QERR_MISSING_PARAMETER, "driver");
 424         return NULL;
 425     }
 426
 427     /* find driver */
 428     obj = object_class_by_name(driver);
 429     if (!obj) {
 430         const char *typename = find_typename_by_alias(driver);
 431
 432         if (typename) {
 433             driver = typename;
 434             obj = object_class_by_name(driver);
 435         }
 436     }
 437
 438     if (!obj) {
 439         qerror_report(QERR_INVALID_PARAMETER_VALUE, "driver", "device type");
 440         return NULL;
 441     }
 442
 443     k = DEVICE_CLASS(obj);
 444
 445     /* find bus */
 446     path = qemu_opt_get(opts, "bus");
 447     if (path != NULL) {
 448         bus = qbus_find(path);
 449         if (!bus) {
 450             return NULL;
 451         }
 452         if (!object_dynamic_cast(OBJECT(bus), k->bus_type)) {
 453             qerror_report(QERR_BAD_BUS_FOR_DEVICE,
 454                           driver, object_get_typename(OBJECT(bus)));
 455             return NULL;
 456         }
 457     } else if (k->bus_type != NULL) {
 458         bus = qbus_find_recursive(sysbus_get_default(), NULL, k->bus_type);
 459         if (!bus) {
 460             qerror_report(QERR_NO_BUS_FOR_DEVICE,
 461                           k->bus_type, driver);
 462             return NULL;
 463         }
 464     }
 465     if (qdev_hotplug && bus && !bus->allow_hotplug) {
 466         qerror_report(QERR_BUS_NO_HOTPLUG, bus->name);
 467         return NULL;
 468     }
 469
 470     /* create device, set properties */
 471     qdev = DEVICE(object_new(driver));
 472
 473     if (bus) {
 474         qdev_set_parent_bus(qdev, bus);
 475     }
 476
 477     id = qemu_opts_id(opts);
 478     if (id) {
 479         qdev->id = id;
 480     }
 481     if (qemu_opt_foreach(opts, set_property, qdev, 1) != 0) {
 482         qdev_free(qdev);
 483         return NULL;
 484     }
 485     if (qdev->id) {
 486         object_property_add_child(qdev_get_peripheral(), qdev->id,
 487                                   OBJECT(qdev), NULL);
 488     } else {
 489         static int anon_count;
 490         gchar *name = g_strdup_printf("device[%d]", anon_count++);
 491         object_property_add_child(qdev_get_peripheral_anon(), name,
 492                                   OBJECT(qdev), NULL);
 493         g_free(name);
 494     }
 495     if (qdev_init(qdev) < 0) {
 496         qerror_report(QERR_DEVICE_INIT_FAILED, driver);
 497         return NULL;
 498     }
 499     qdev->opts = opts;
 500     return qdev;
 501 }
 502
 503
 504 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
 505 static void qbus_print(Monitor *mon, BusState *bus, int indent);
 506
 507 static void qdev_print_props(Monitor *mon, DeviceState *dev, Property *props,
 508                              int indent)
 509 {
 510     if (!props)
 511         return;
 512     for (; props->name; props++) {
 513         Error *err = NULL;
 514         char *value;
 515         char *legacy_name = g_strdup_printf("legacy-%s", props->name);
 516         if (object_property_get_type(OBJECT(dev), legacy_name, NULL)) {
 517             value = object_property_get_str(OBJECT(dev), legacy_name, &err);
 518         } else {
 519             value = object_property_print(OBJECT(dev), props->name, &err);
 520         }
 521         g_free(legacy_name);
 522
 523         if (err) {
 524             error_free(err);
 525             continue;
 526         }
 527         qdev_printf("%s = %s\n", props->name,
 528                     value && *value ? value : "<null>");
 529         g_free(value);
 530     }
 531 }
 532
 533 static void bus_print_dev(BusState *bus, Monitor *mon, DeviceState *dev, int indent)
 534 {
 535     BusClass *bc = BUS_GET_CLASS(bus);
 536
 537     if (bc->print_dev) {
 538         bc->print_dev(mon, dev, indent);
 539     }
 540 }
 541
 542 static void qdev_print(Monitor *mon, DeviceState *dev, int indent)
 543 {
 544     ObjectClass *class;
 545     BusState *child;
 546     qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev)),
 547                 dev->id ? dev->id : "");
 548     indent += 2;
 549     if (dev->num_gpio_in) {
 550         qdev_printf("gpio-in %d\n", dev->num_gpio_in);
 551     }
 552     if (dev->num_gpio_out) {
 553         qdev_printf("gpio-out %d\n", dev->num_gpio_out);
 554     }
 555     class = object_get_class(OBJECT(dev));
 556     do {
 557         qdev_print_props(mon, dev, DEVICE_CLASS(class)->props, indent);
 558         class = object_class_get_parent(class);
 559     } while (class != object_class_by_name(TYPE_DEVICE));
 560     bus_print_dev(dev->parent_bus, mon, dev, indent);
 561     QLIST_FOREACH(child, &dev->child_bus, sibling) {
 562         qbus_print(mon, child, indent);
 563     }
 564 }
 565
 566 static void qbus_print(Monitor *mon, BusState *bus, int indent)
 567 {
 568     BusChild *kid;
 569
 570     qdev_printf("bus: %s\n", bus->name);
 571     indent += 2;
 572     qdev_printf("type %s\n", object_get_typename(OBJECT(bus)));
 573     QTAILQ_FOREACH(kid, &bus->children, sibling) {
 574         DeviceState *dev = kid->child;
 575         qdev_print(mon, dev, indent);
 576     }
 577 }
 578 #undef qdev_printf
 579
 580 void do_info_qtree(Monitor *mon, const QDict *qdict)
 581 {
 582     if (sysbus_get_default())
 583         qbus_print(mon, sysbus_get_default(), 0);
 584 }
 585
 586 void do_info_qdm(Monitor *mon, const QDict *qdict)
 587 {
 588     object_class_foreach(qdev_print_devinfo, TYPE_DEVICE, false, NULL);
 589 }
 590
 591 int do_device_add(Monitor *mon, const QDict *qdict, QObject **ret_data)
 592 {
 593     Error *local_err = NULL;
 594     QemuOpts *opts;
 595     DeviceState *dev;
 596
 597     opts = qemu_opts_from_qdict(qemu_find_opts("device"), qdict, &local_err);
 598     if (error_is_set(&local_err)) {
 599         qerror_report_err(local_err);
 600         error_free(local_err);
 601         return -1;
 602     }
 603     if (!monitor_cur_is_qmp() && qdev_device_help(opts)) {
 604         qemu_opts_del(opts);
 605         return 0;
 606     }
 607     dev = qdev_device_add(opts);
 608     if (!dev) {
 609         qemu_opts_del(opts);
 610         return -1;
 611     }
 612     object_unref(OBJECT(dev));
 613     return 0;
 614 }
 615
 616 void qmp_device_del(const char *id, Error **errp)
 617 {
 618     DeviceState *dev;
 619
 620     dev = qdev_find_recursive(sysbus_get_default(), id);
 621     if (NULL == dev) {
 622         error_set(errp, QERR_DEVICE_NOT_FOUND, id);
 623         return;
 624     }
 625
 626     qdev_unplug(dev, errp);
 627 }
 628
 629 void qdev_machine_init(void)
 630 {
 631     qdev_get_peripheral_anon();
 632     qdev_get_peripheral();
 633 }
 634
 635 QemuOptsList qemu_device_opts = {
 636     .name = "device",
 637     .implied_opt_name = "driver",
 638     .head = QTAILQ_HEAD_INITIALIZER(qemu_device_opts.head),
 639     .desc = {
 640         /*
 641          * no elements => accept any
 642          * sanity checking will happen later
 643          * when setting device properties
 644          */
 645         { /* end of list */ }
 646     },
 647 };
 648
 649 QemuOptsList qemu_global_opts = {
 650     .name = "global",
 651     .head = QTAILQ_HEAD_INITIALIZER(qemu_global_opts.head),
 652     .desc = {
 653         {
 654             .name = "driver",
 655             .type = QEMU_OPT_STRING,
 656         },{
 657             .name = "property",
 658             .type = QEMU_OPT_STRING,
 659         },{
 660             .name = "value",
 661             .type = QEMU_OPT_STRING,
 662         },
 663         { /* end of list */ }
 664     },
 665 };
 666
 667 int qemu_global_option(const char *str)
 668 {
 669     char driver[64], property[64];
 670     QemuOpts *opts;
 671     int rc, offset;
 672
 673     rc = sscanf(str, "%63[^.].%63[^=]%n", driver, property, &offset);
 674     if (rc < 2 || str[offset] != '=') {
 675         error_report("can't parse: \"%s\"", str);
 676         return -1;
 677     }
 678
 679     opts = qemu_opts_create_nofail(&qemu_global_opts);
 680     qemu_opt_set(opts, "driver", driver);
 681     qemu_opt_set(opts, "property", property);
 682     qemu_opt_set(opts, "value", str+offset+1);
 683     return 0;
 684 }