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