2 * Dynamic device configuration and creation.
4 * Copyright (c) 2009 CodeSourcery
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.
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.
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/>.
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 "qapi/qmp/qerror.h"
27 #include "qemu/config-file.h"
28 #include "qemu/error-report.h"
31 * Aliases were a bad idea from the start. Let's keep them
32 * from spreading further.
34 typedef struct QDevAlias
41 static const QDevAlias qdev_alias_table[] = {
42 { "virtio-blk-pci", "virtio-blk", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
43 { "virtio-net-pci", "virtio-net", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
44 { "virtio-serial-pci", "virtio-serial", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
45 { "virtio-balloon-pci", "virtio-balloon",
46 QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
47 { "virtio-blk-ccw", "virtio-blk", QEMU_ARCH_S390X },
48 { "virtio-net-ccw", "virtio-net", QEMU_ARCH_S390X },
49 { "virtio-serial-ccw", "virtio-serial", QEMU_ARCH_S390X },
50 { "lsi53c895a", "lsi" },
51 { "ich9-ahci", "ahci" },
52 { "kvm-pci-assign", "pci-assign" },
53 { "e1000", "e1000-82540em" },
57 static const char *qdev_class_get_alias(DeviceClass *dc)
59 const char *typename = object_class_get_name(OBJECT_CLASS(dc));
62 for (i = 0; qdev_alias_table[i].typename; i++) {
63 if (qdev_alias_table[i].arch_mask &&
64 !(qdev_alias_table[i].arch_mask & arch_type)) {
68 if (strcmp(qdev_alias_table[i].typename, typename) == 0) {
69 return qdev_alias_table[i].alias;
76 static bool qdev_class_has_alias(DeviceClass *dc)
78 return (qdev_class_get_alias(dc) != NULL);
81 static void qdev_print_devinfo(DeviceClass *dc)
83 error_printf("name \"%s\"", object_class_get_name(OBJECT_CLASS(dc)));
85 error_printf(", bus %s", dc->bus_type);
87 if (qdev_class_has_alias(dc)) {
88 error_printf(", alias \"%s\"", qdev_class_get_alias(dc));
91 error_printf(", desc \"%s\"", dc->desc);
93 if (dc->cannot_instantiate_with_device_add_yet) {
94 error_printf(", no-user");
99 static gint devinfo_cmp(gconstpointer a, gconstpointer b)
101 return strcasecmp(object_class_get_name((ObjectClass *)a),
102 object_class_get_name((ObjectClass *)b));
105 static void qdev_print_devinfos(bool show_no_user)
107 static const char *cat_name[DEVICE_CATEGORY_MAX + 1] = {
108 [DEVICE_CATEGORY_BRIDGE] = "Controller/Bridge/Hub",
109 [DEVICE_CATEGORY_USB] = "USB",
110 [DEVICE_CATEGORY_STORAGE] = "Storage",
111 [DEVICE_CATEGORY_NETWORK] = "Network",
112 [DEVICE_CATEGORY_INPUT] = "Input",
113 [DEVICE_CATEGORY_DISPLAY] = "Display",
114 [DEVICE_CATEGORY_SOUND] = "Sound",
115 [DEVICE_CATEGORY_MISC] = "Misc",
116 [DEVICE_CATEGORY_MAX] = "Uncategorized",
122 list = g_slist_sort(object_class_get_list(TYPE_DEVICE, false),
125 for (i = 0; i <= DEVICE_CATEGORY_MAX; i++) {
127 for (elt = list; elt; elt = elt->next) {
128 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
130 if ((i < DEVICE_CATEGORY_MAX
131 ? !test_bit(i, dc->categories)
132 : !bitmap_empty(dc->categories, DEVICE_CATEGORY_MAX))
134 && dc->cannot_instantiate_with_device_add_yet)) {
138 error_printf("%s%s devices:\n", i ? "\n" : "",
142 qdev_print_devinfo(dc);
149 static int set_property(void *opaque, const char *name, const char *value,
152 Object *obj = opaque;
155 if (strcmp(name, "driver") == 0)
157 if (strcmp(name, "bus") == 0)
160 object_property_parse(obj, value, name, &err);
162 error_propagate(errp, err);
168 static const char *find_typename_by_alias(const char *alias)
172 for (i = 0; qdev_alias_table[i].alias; i++) {
173 if (qdev_alias_table[i].arch_mask &&
174 !(qdev_alias_table[i].arch_mask & arch_type)) {
178 if (strcmp(qdev_alias_table[i].alias, alias) == 0) {
179 return qdev_alias_table[i].typename;
186 static DeviceClass *qdev_get_device_class(const char **driver, Error **errp)
191 oc = object_class_by_name(*driver);
193 const char *typename = find_typename_by_alias(*driver);
197 oc = object_class_by_name(*driver);
201 if (!object_class_dynamic_cast(oc, TYPE_DEVICE)) {
202 error_setg(errp, "'%s' is not a valid device model name", *driver);
206 if (object_class_is_abstract(oc)) {
207 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
208 "non-abstract device type");
212 dc = DEVICE_CLASS(oc);
213 if (dc->cannot_instantiate_with_device_add_yet ||
214 (qdev_hotplug && !dc->hotpluggable)) {
215 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
216 "pluggable device type");
224 int qdev_device_help(QemuOpts *opts)
226 Error *local_err = NULL;
228 DevicePropertyInfoList *prop_list;
229 DevicePropertyInfoList *prop;
231 driver = qemu_opt_get(opts, "driver");
232 if (driver && is_help_option(driver)) {
233 qdev_print_devinfos(false);
237 if (!driver || !qemu_opt_has_help_opt(opts)) {
241 if (!object_class_by_name(driver)) {
242 const char *typename = find_typename_by_alias(driver);
249 prop_list = qmp_device_list_properties(driver, &local_err);
254 for (prop = prop_list; prop; prop = prop->next) {
255 error_printf("%s.%s=%s", driver,
258 if (prop->value->has_description) {
259 error_printf(" (%s)\n", prop->value->description);
265 qapi_free_DevicePropertyInfoList(prop_list);
269 error_report_err(local_err);
273 static Object *qdev_get_peripheral(void)
278 dev = container_get(qdev_get_machine(), "/peripheral");
284 static Object *qdev_get_peripheral_anon(void)
289 dev = container_get(qdev_get_machine(), "/peripheral-anon");
295 static void qbus_list_bus(DeviceState *dev, Error **errp)
298 const char *sep = " ";
300 error_append_hint(errp, "child buses at \"%s\":",
301 dev->id ? dev->id : object_get_typename(OBJECT(dev)));
302 QLIST_FOREACH(child, &dev->child_bus, sibling) {
303 error_append_hint(errp, "%s\"%s\"", sep, child->name);
306 error_append_hint(errp, "\n");
309 static void qbus_list_dev(BusState *bus, Error **errp)
312 const char *sep = " ";
314 error_append_hint(errp, "devices at \"%s\":", bus->name);
315 QTAILQ_FOREACH(kid, &bus->children, sibling) {
316 DeviceState *dev = kid->child;
317 error_append_hint(errp, "%s\"%s\"", sep,
318 object_get_typename(OBJECT(dev)));
320 error_append_hint(errp, "/\"%s\"", dev->id);
324 error_append_hint(errp, "\n");
327 static BusState *qbus_find_bus(DeviceState *dev, char *elem)
331 QLIST_FOREACH(child, &dev->child_bus, sibling) {
332 if (strcmp(child->name, elem) == 0) {
339 static DeviceState *qbus_find_dev(BusState *bus, char *elem)
344 * try to match in order:
345 * (1) instance id, if present
347 * (3) driver alias, if present
349 QTAILQ_FOREACH(kid, &bus->children, sibling) {
350 DeviceState *dev = kid->child;
351 if (dev->id && strcmp(dev->id, elem) == 0) {
355 QTAILQ_FOREACH(kid, &bus->children, sibling) {
356 DeviceState *dev = kid->child;
357 if (strcmp(object_get_typename(OBJECT(dev)), elem) == 0) {
361 QTAILQ_FOREACH(kid, &bus->children, sibling) {
362 DeviceState *dev = kid->child;
363 DeviceClass *dc = DEVICE_GET_CLASS(dev);
365 if (qdev_class_has_alias(dc) &&
366 strcmp(qdev_class_get_alias(dc), elem) == 0) {
373 static inline bool qbus_is_full(BusState *bus)
375 BusClass *bus_class = BUS_GET_CLASS(bus);
376 return bus_class->max_dev && bus->max_index >= bus_class->max_dev;
380 * Search the tree rooted at @bus for a bus.
381 * If @name, search for a bus with that name. Note that bus names
382 * need not be unique. Yes, that's screwed up.
383 * Else search for a bus that is a subtype of @bus_typename.
384 * If more than one exists, prefer one that can take another device.
385 * Return the bus if found, else %NULL.
387 static BusState *qbus_find_recursive(BusState *bus, const char *name,
388 const char *bus_typename)
391 BusState *pick, *child, *ret;
394 assert(name || bus_typename);
396 match = !strcmp(bus->name, name);
398 match = !!object_dynamic_cast(OBJECT(bus), bus_typename);
401 if (match && !qbus_is_full(bus)) {
402 return bus; /* root matches and isn't full */
405 pick = match ? bus : NULL;
407 QTAILQ_FOREACH(kid, &bus->children, sibling) {
408 DeviceState *dev = kid->child;
409 QLIST_FOREACH(child, &dev->child_bus, sibling) {
410 ret = qbus_find_recursive(child, name, bus_typename);
411 if (ret && !qbus_is_full(ret)) {
412 return ret; /* a descendant matches and isn't full */
420 /* root or a descendant matches, but is full */
424 static BusState *qbus_find(const char *path, Error **errp)
431 /* find start element */
432 if (path[0] == '/') {
433 bus = sysbus_get_default();
436 if (sscanf(path, "%127[^/]%n", elem, &len) != 1) {
440 bus = qbus_find_recursive(sysbus_get_default(), elem, NULL);
442 error_setg(errp, "Bus '%s' not found", elem);
449 assert(path[pos] == '/' || !path[pos]);
450 while (path[pos] == '/') {
453 if (path[pos] == '\0') {
458 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
459 g_assert_not_reached();
463 dev = qbus_find_dev(bus, elem);
465 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
466 "Device '%s' not found", elem);
467 qbus_list_dev(bus, errp);
471 assert(path[pos] == '/' || !path[pos]);
472 while (path[pos] == '/') {
475 if (path[pos] == '\0') {
476 /* last specified element is a device. If it has exactly
477 * one child bus accept it nevertheless */
478 if (dev->num_child_bus == 1) {
479 bus = QLIST_FIRST(&dev->child_bus);
482 if (dev->num_child_bus) {
483 error_setg(errp, "Device '%s' has multiple child buses",
485 qbus_list_bus(dev, errp);
487 error_setg(errp, "Device '%s' has no child bus", elem);
493 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
494 g_assert_not_reached();
498 bus = qbus_find_bus(dev, elem);
500 error_setg(errp, "Bus '%s' not found", elem);
501 qbus_list_bus(dev, errp);
506 if (qbus_is_full(bus)) {
507 error_setg(errp, "Bus '%s' is full", path);
513 DeviceState *qdev_device_add(QemuOpts *opts, Error **errp)
516 const char *driver, *path, *id;
518 BusState *bus = NULL;
521 driver = qemu_opt_get(opts, "driver");
523 error_setg(errp, QERR_MISSING_PARAMETER, "driver");
528 dc = qdev_get_device_class(&driver, errp);
534 path = qemu_opt_get(opts, "bus");
536 bus = qbus_find(path, errp);
540 if (!object_dynamic_cast(OBJECT(bus), dc->bus_type)) {
541 error_setg(errp, "Device '%s' can't go on %s bus",
542 driver, object_get_typename(OBJECT(bus)));
545 } else if (dc->bus_type != NULL) {
546 bus = qbus_find_recursive(sysbus_get_default(), NULL, dc->bus_type);
547 if (!bus || qbus_is_full(bus)) {
548 error_setg(errp, "No '%s' bus found for device '%s'",
549 dc->bus_type, driver);
553 if (qdev_hotplug && bus && !qbus_is_hotpluggable(bus)) {
554 error_setg(errp, QERR_BUS_NO_HOTPLUG, bus->name);
559 dev = DEVICE(object_new(driver));
562 qdev_set_parent_bus(dev, bus);
565 id = qemu_opts_id(opts);
571 object_property_add_child(qdev_get_peripheral(), dev->id,
574 static int anon_count;
575 gchar *name = g_strdup_printf("device[%d]", anon_count++);
576 object_property_add_child(qdev_get_peripheral_anon(), name,
582 if (qemu_opt_foreach(opts, set_property, dev, &err)) {
583 error_propagate(errp, err);
584 object_unparent(OBJECT(dev));
585 object_unref(OBJECT(dev));
590 object_property_set_bool(OBJECT(dev), true, "realized", &err);
592 error_propagate(errp, err);
594 object_unparent(OBJECT(dev));
595 object_unref(OBJECT(dev));
602 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
603 static void qbus_print(Monitor *mon, BusState *bus, int indent);
605 static void qdev_print_props(Monitor *mon, DeviceState *dev, Property *props,
610 for (; props->name; props++) {
613 char *legacy_name = g_strdup_printf("legacy-%s", props->name);
614 if (object_property_get_type(OBJECT(dev), legacy_name, NULL)) {
615 value = object_property_get_str(OBJECT(dev), legacy_name, &err);
617 value = object_property_print(OBJECT(dev), props->name, true, &err);
625 qdev_printf("%s = %s\n", props->name,
626 value && *value ? value : "<null>");
631 static void bus_print_dev(BusState *bus, Monitor *mon, DeviceState *dev, int indent)
633 BusClass *bc = BUS_GET_CLASS(bus);
636 bc->print_dev(mon, dev, indent);
640 static void qdev_print(Monitor *mon, DeviceState *dev, int indent)
646 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev)),
647 dev->id ? dev->id : "");
649 QLIST_FOREACH(ngl, &dev->gpios, node) {
651 qdev_printf("gpio-in \"%s\" %d\n", ngl->name ? ngl->name : "",
655 qdev_printf("gpio-out \"%s\" %d\n", ngl->name ? ngl->name : "",
659 class = object_get_class(OBJECT(dev));
661 qdev_print_props(mon, dev, DEVICE_CLASS(class)->props, indent);
662 class = object_class_get_parent(class);
663 } while (class != object_class_by_name(TYPE_DEVICE));
664 bus_print_dev(dev->parent_bus, mon, dev, indent);
665 QLIST_FOREACH(child, &dev->child_bus, sibling) {
666 qbus_print(mon, child, indent);
670 static void qbus_print(Monitor *mon, BusState *bus, int indent)
674 qdev_printf("bus: %s\n", bus->name);
676 qdev_printf("type %s\n", object_get_typename(OBJECT(bus)));
677 QTAILQ_FOREACH(kid, &bus->children, sibling) {
678 DeviceState *dev = kid->child;
679 qdev_print(mon, dev, indent);
684 void hmp_info_qtree(Monitor *mon, const QDict *qdict)
686 if (sysbus_get_default())
687 qbus_print(mon, sysbus_get_default(), 0);
690 void hmp_info_qdm(Monitor *mon, const QDict *qdict)
692 qdev_print_devinfos(true);
695 typedef struct QOMCompositionState {
698 } QOMCompositionState;
700 static void print_qom_composition(Monitor *mon, Object *obj, int indent);
702 static int print_qom_composition_child(Object *obj, void *opaque)
704 QOMCompositionState *s = opaque;
706 print_qom_composition(s->mon, obj, s->indent);
711 static void print_qom_composition(Monitor *mon, Object *obj, int indent)
713 QOMCompositionState s = {
715 .indent = indent + 2,
719 if (obj == object_get_root()) {
722 name = object_get_canonical_path_component(obj);
724 monitor_printf(mon, "%*s/%s (%s)\n", indent, "", name,
725 object_get_typename(obj));
727 object_child_foreach(obj, print_qom_composition_child, &s);
730 void hmp_info_qom_tree(Monitor *mon, const QDict *dict)
732 const char *path = qdict_get_try_str(dict, "path");
734 bool ambiguous = false;
737 obj = object_resolve_path(path, &ambiguous);
739 monitor_printf(mon, "Path '%s' could not be resolved.\n", path);
743 monitor_printf(mon, "Warning: Path '%s' is ambiguous.\n", path);
747 obj = qdev_get_machine();
749 print_qom_composition(mon, obj, 0);
752 void qmp_device_add(QDict *qdict, QObject **ret_data, Error **errp)
754 Error *local_err = NULL;
758 opts = qemu_opts_from_qdict(qemu_find_opts("device"), qdict, &local_err);
760 error_propagate(errp, local_err);
763 if (!monitor_cur_is_qmp() && qdev_device_help(opts)) {
767 dev = qdev_device_add(opts, &local_err);
769 error_propagate(errp, local_err);
773 object_unref(OBJECT(dev));
776 void qmp_device_del(const char *id, Error **errp)
781 obj = object_resolve_path(id, NULL);
783 char *root_path = object_get_canonical_path(qdev_get_peripheral());
784 char *path = g_strdup_printf("%s/%s", root_path, id);
787 obj = object_resolve_path_type(path, TYPE_DEVICE, NULL);
792 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
793 "Device '%s' not found", id);
797 if (!object_dynamic_cast(obj, TYPE_DEVICE)) {
798 error_setg(errp, "%s is not a hotpluggable device", id);
802 qdev_unplug(DEVICE(obj), errp);
805 void qdev_machine_init(void)
807 qdev_get_peripheral_anon();
808 qdev_get_peripheral();
811 QemuOptsList qemu_device_opts = {
813 .implied_opt_name = "driver",
814 .head = QTAILQ_HEAD_INITIALIZER(qemu_device_opts.head),
817 * no elements => accept any
818 * sanity checking will happen later
819 * when setting device properties
821 { /* end of list */ }
825 QemuOptsList qemu_global_opts = {
827 .head = QTAILQ_HEAD_INITIALIZER(qemu_global_opts.head),
831 .type = QEMU_OPT_STRING,
834 .type = QEMU_OPT_STRING,
837 .type = QEMU_OPT_STRING,
839 { /* end of list */ }
843 int qemu_global_option(const char *str)
845 char driver[64], property[64];
849 rc = sscanf(str, "%63[^.=].%63[^=]%n", driver, property, &offset);
850 if (rc == 2 && str[offset] == '=') {
851 opts = qemu_opts_create(&qemu_global_opts, NULL, 0, &error_abort);
852 qemu_opt_set(opts, "driver", driver, &error_abort);
853 qemu_opt_set(opts, "property", property, &error_abort);
854 qemu_opt_set(opts, "value", str + offset + 1, &error_abort);
858 opts = qemu_opts_parse_noisily(&qemu_global_opts, str, false);