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" },
56 static const char *qdev_class_get_alias(DeviceClass *dc)
58 const char *typename = object_class_get_name(OBJECT_CLASS(dc));
61 for (i = 0; qdev_alias_table[i].typename; i++) {
62 if (qdev_alias_table[i].arch_mask &&
63 !(qdev_alias_table[i].arch_mask & arch_type)) {
67 if (strcmp(qdev_alias_table[i].typename, typename) == 0) {
68 return qdev_alias_table[i].alias;
75 static bool qdev_class_has_alias(DeviceClass *dc)
77 return (qdev_class_get_alias(dc) != NULL);
80 static void qdev_print_devinfo(DeviceClass *dc)
82 error_printf("name \"%s\"", object_class_get_name(OBJECT_CLASS(dc)));
84 error_printf(", bus %s", dc->bus_type);
86 if (qdev_class_has_alias(dc)) {
87 error_printf(", alias \"%s\"", qdev_class_get_alias(dc));
90 error_printf(", desc \"%s\"", dc->desc);
92 if (dc->cannot_instantiate_with_device_add_yet) {
93 error_printf(", no-user");
98 static gint devinfo_cmp(gconstpointer a, gconstpointer b)
100 return strcasecmp(object_class_get_name((ObjectClass *)a),
101 object_class_get_name((ObjectClass *)b));
104 static void qdev_print_devinfos(bool show_no_user)
106 static const char *cat_name[DEVICE_CATEGORY_MAX + 1] = {
107 [DEVICE_CATEGORY_BRIDGE] = "Controller/Bridge/Hub",
108 [DEVICE_CATEGORY_USB] = "USB",
109 [DEVICE_CATEGORY_STORAGE] = "Storage",
110 [DEVICE_CATEGORY_NETWORK] = "Network",
111 [DEVICE_CATEGORY_INPUT] = "Input",
112 [DEVICE_CATEGORY_DISPLAY] = "Display",
113 [DEVICE_CATEGORY_SOUND] = "Sound",
114 [DEVICE_CATEGORY_MISC] = "Misc",
115 [DEVICE_CATEGORY_MAX] = "Uncategorized",
121 list = g_slist_sort(object_class_get_list(TYPE_DEVICE, false),
124 for (i = 0; i <= DEVICE_CATEGORY_MAX; i++) {
126 for (elt = list; elt; elt = elt->next) {
127 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
129 if ((i < DEVICE_CATEGORY_MAX
130 ? !test_bit(i, dc->categories)
131 : !bitmap_empty(dc->categories, DEVICE_CATEGORY_MAX))
133 && dc->cannot_instantiate_with_device_add_yet)) {
137 error_printf("%s%s devices:\n", i ? "\n" : "",
141 qdev_print_devinfo(dc);
148 static int set_property(void *opaque, const char *name, const char *value,
151 Object *obj = opaque;
154 if (strcmp(name, "driver") == 0)
156 if (strcmp(name, "bus") == 0)
159 object_property_parse(obj, value, name, &err);
161 error_propagate(errp, err);
167 static const char *find_typename_by_alias(const char *alias)
171 for (i = 0; qdev_alias_table[i].alias; i++) {
172 if (qdev_alias_table[i].arch_mask &&
173 !(qdev_alias_table[i].arch_mask & arch_type)) {
177 if (strcmp(qdev_alias_table[i].alias, alias) == 0) {
178 return qdev_alias_table[i].typename;
185 static DeviceClass *qdev_get_device_class(const char **driver, Error **errp)
190 oc = object_class_by_name(*driver);
192 const char *typename = find_typename_by_alias(*driver);
196 oc = object_class_by_name(*driver);
200 if (!object_class_dynamic_cast(oc, TYPE_DEVICE)) {
201 error_setg(errp, "'%s' is not a valid device model name", *driver);
205 if (object_class_is_abstract(oc)) {
206 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
207 "non-abstract device type");
211 dc = DEVICE_CLASS(oc);
212 if (dc->cannot_instantiate_with_device_add_yet ||
213 (qdev_hotplug && !dc->hotpluggable)) {
214 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
215 "pluggable device type");
223 int qdev_device_help(QemuOpts *opts)
225 Error *local_err = NULL;
227 DevicePropertyInfoList *prop_list;
228 DevicePropertyInfoList *prop;
230 driver = qemu_opt_get(opts, "driver");
231 if (driver && is_help_option(driver)) {
232 qdev_print_devinfos(false);
236 if (!driver || !qemu_opt_has_help_opt(opts)) {
240 qdev_get_device_class(&driver, &local_err);
245 prop_list = qmp_device_list_properties(driver, &local_err);
250 for (prop = prop_list; prop; prop = prop->next) {
251 error_printf("%s.%s=%s", driver,
254 if (prop->value->has_description) {
255 error_printf(" (%s)\n", prop->value->description);
261 qapi_free_DevicePropertyInfoList(prop_list);
265 error_printf("%s\n", error_get_pretty(local_err));
266 error_free(local_err);
270 static Object *qdev_get_peripheral(void)
275 dev = container_get(qdev_get_machine(), "/peripheral");
281 static Object *qdev_get_peripheral_anon(void)
286 dev = container_get(qdev_get_machine(), "/peripheral-anon");
292 #if 0 /* conversion from qerror_report() to error_set() broke their use */
293 static void qbus_list_bus(DeviceState *dev)
296 const char *sep = " ";
298 error_printf("child buses at \"%s\":",
299 dev->id ? dev->id : object_get_typename(OBJECT(dev)));
300 QLIST_FOREACH(child, &dev->child_bus, sibling) {
301 error_printf("%s\"%s\"", sep, child->name);
307 static void qbus_list_dev(BusState *bus)
310 const char *sep = " ";
312 error_printf("devices at \"%s\":", bus->name);
313 QTAILQ_FOREACH(kid, &bus->children, sibling) {
314 DeviceState *dev = kid->child;
315 error_printf("%s\"%s\"", sep, object_get_typename(OBJECT(dev)));
317 error_printf("/\"%s\"", dev->id);
324 static BusState *qbus_find_bus(DeviceState *dev, char *elem)
328 QLIST_FOREACH(child, &dev->child_bus, sibling) {
329 if (strcmp(child->name, elem) == 0) {
336 static DeviceState *qbus_find_dev(BusState *bus, char *elem)
341 * try to match in order:
342 * (1) instance id, if present
344 * (3) driver alias, if present
346 QTAILQ_FOREACH(kid, &bus->children, sibling) {
347 DeviceState *dev = kid->child;
348 if (dev->id && strcmp(dev->id, elem) == 0) {
352 QTAILQ_FOREACH(kid, &bus->children, sibling) {
353 DeviceState *dev = kid->child;
354 if (strcmp(object_get_typename(OBJECT(dev)), elem) == 0) {
358 QTAILQ_FOREACH(kid, &bus->children, sibling) {
359 DeviceState *dev = kid->child;
360 DeviceClass *dc = DEVICE_GET_CLASS(dev);
362 if (qdev_class_has_alias(dc) &&
363 strcmp(qdev_class_get_alias(dc), elem) == 0) {
370 static inline bool qbus_is_full(BusState *bus)
372 BusClass *bus_class = BUS_GET_CLASS(bus);
373 return bus_class->max_dev && bus->max_index >= bus_class->max_dev;
377 * Search the tree rooted at @bus for a bus.
378 * If @name, search for a bus with that name. Note that bus names
379 * need not be unique. Yes, that's screwed up.
380 * Else search for a bus that is a subtype of @bus_typename.
381 * If more than one exists, prefer one that can take another device.
382 * Return the bus if found, else %NULL.
384 static BusState *qbus_find_recursive(BusState *bus, const char *name,
385 const char *bus_typename)
388 BusState *pick, *child, *ret;
391 assert(name || bus_typename);
393 match = !strcmp(bus->name, name);
395 match = !!object_dynamic_cast(OBJECT(bus), bus_typename);
398 if (match && !qbus_is_full(bus)) {
399 return bus; /* root matches and isn't full */
402 pick = match ? bus : NULL;
404 QTAILQ_FOREACH(kid, &bus->children, sibling) {
405 DeviceState *dev = kid->child;
406 QLIST_FOREACH(child, &dev->child_bus, sibling) {
407 ret = qbus_find_recursive(child, name, bus_typename);
408 if (ret && !qbus_is_full(ret)) {
409 return ret; /* a descendant matches and isn't full */
417 /* root or a descendant matches, but is full */
421 static BusState *qbus_find(const char *path, Error **errp)
428 /* find start element */
429 if (path[0] == '/') {
430 bus = sysbus_get_default();
433 if (sscanf(path, "%127[^/]%n", elem, &len) != 1) {
437 bus = qbus_find_recursive(sysbus_get_default(), elem, NULL);
439 error_setg(errp, "Bus '%s' not found", elem);
446 assert(path[pos] == '/' || !path[pos]);
447 while (path[pos] == '/') {
450 if (path[pos] == '\0') {
455 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
456 g_assert_not_reached();
460 dev = qbus_find_dev(bus, elem);
462 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
463 "Device '%s' not found", elem);
464 #if 0 /* conversion from qerror_report() to error_set() broke this: */
465 if (!monitor_cur_is_qmp()) {
472 assert(path[pos] == '/' || !path[pos]);
473 while (path[pos] == '/') {
476 if (path[pos] == '\0') {
477 /* last specified element is a device. If it has exactly
478 * one child bus accept it nevertheless */
479 if (dev->num_child_bus == 1) {
480 bus = QLIST_FIRST(&dev->child_bus);
483 if (dev->num_child_bus) {
484 error_setg(errp, "Device '%s' has multiple child buses",
486 #if 0 /* conversion from qerror_report() to error_set() broke this: */
487 if (!monitor_cur_is_qmp()) {
492 error_setg(errp, "Device '%s' has no child bus", elem);
498 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
499 g_assert_not_reached();
503 bus = qbus_find_bus(dev, elem);
505 error_setg(errp, "Bus '%s' not found", elem);
506 #if 0 /* conversion from qerror_report() to error_set() broke this: */
507 if (!monitor_cur_is_qmp()) {
515 if (qbus_is_full(bus)) {
516 error_setg(errp, "Bus '%s' is full", path);
522 DeviceState *qdev_device_add(QemuOpts *opts, Error **errp)
525 const char *driver, *path, *id;
527 BusState *bus = NULL;
530 driver = qemu_opt_get(opts, "driver");
532 error_setg(errp, QERR_MISSING_PARAMETER, "driver");
537 dc = qdev_get_device_class(&driver, errp);
543 path = qemu_opt_get(opts, "bus");
545 bus = qbus_find(path, errp);
549 if (!object_dynamic_cast(OBJECT(bus), dc->bus_type)) {
550 error_setg(errp, "Device '%s' can't go on %s bus",
551 driver, object_get_typename(OBJECT(bus)));
554 } else if (dc->bus_type != NULL) {
555 bus = qbus_find_recursive(sysbus_get_default(), NULL, dc->bus_type);
556 if (!bus || qbus_is_full(bus)) {
557 error_setg(errp, "No '%s' bus found for device '%s'",
558 dc->bus_type, driver);
562 if (qdev_hotplug && bus && !qbus_is_hotpluggable(bus)) {
563 error_setg(errp, QERR_BUS_NO_HOTPLUG, bus->name);
568 dev = DEVICE(object_new(driver));
571 qdev_set_parent_bus(dev, bus);
574 id = qemu_opts_id(opts);
580 object_property_add_child(qdev_get_peripheral(), dev->id,
583 static int anon_count;
584 gchar *name = g_strdup_printf("device[%d]", anon_count++);
585 object_property_add_child(qdev_get_peripheral_anon(), name,
591 if (qemu_opt_foreach(opts, set_property, dev, &err)) {
592 error_propagate(errp, err);
593 object_unparent(OBJECT(dev));
594 object_unref(OBJECT(dev));
599 object_property_set_bool(OBJECT(dev), true, "realized", &err);
601 error_propagate(errp, err);
603 object_unparent(OBJECT(dev));
604 object_unref(OBJECT(dev));
611 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
612 static void qbus_print(Monitor *mon, BusState *bus, int indent);
614 static void qdev_print_props(Monitor *mon, DeviceState *dev, Property *props,
619 for (; props->name; props++) {
622 char *legacy_name = g_strdup_printf("legacy-%s", props->name);
623 if (object_property_get_type(OBJECT(dev), legacy_name, NULL)) {
624 value = object_property_get_str(OBJECT(dev), legacy_name, &err);
626 value = object_property_print(OBJECT(dev), props->name, true, &err);
634 qdev_printf("%s = %s\n", props->name,
635 value && *value ? value : "<null>");
640 static void bus_print_dev(BusState *bus, Monitor *mon, DeviceState *dev, int indent)
642 BusClass *bc = BUS_GET_CLASS(bus);
645 bc->print_dev(mon, dev, indent);
649 static void qdev_print(Monitor *mon, DeviceState *dev, int indent)
655 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev)),
656 dev->id ? dev->id : "");
658 QLIST_FOREACH(ngl, &dev->gpios, node) {
660 qdev_printf("gpio-in \"%s\" %d\n", ngl->name ? ngl->name : "",
664 qdev_printf("gpio-out \"%s\" %d\n", ngl->name ? ngl->name : "",
668 class = object_get_class(OBJECT(dev));
670 qdev_print_props(mon, dev, DEVICE_CLASS(class)->props, indent);
671 class = object_class_get_parent(class);
672 } while (class != object_class_by_name(TYPE_DEVICE));
673 bus_print_dev(dev->parent_bus, mon, dev, indent);
674 QLIST_FOREACH(child, &dev->child_bus, sibling) {
675 qbus_print(mon, child, indent);
679 static void qbus_print(Monitor *mon, BusState *bus, int indent)
683 qdev_printf("bus: %s\n", bus->name);
685 qdev_printf("type %s\n", object_get_typename(OBJECT(bus)));
686 QTAILQ_FOREACH(kid, &bus->children, sibling) {
687 DeviceState *dev = kid->child;
688 qdev_print(mon, dev, indent);
693 void hmp_info_qtree(Monitor *mon, const QDict *qdict)
695 if (sysbus_get_default())
696 qbus_print(mon, sysbus_get_default(), 0);
699 void hmp_info_qdm(Monitor *mon, const QDict *qdict)
701 qdev_print_devinfos(true);
704 typedef struct QOMCompositionState {
707 } QOMCompositionState;
709 static void print_qom_composition(Monitor *mon, Object *obj, int indent);
711 static int print_qom_composition_child(Object *obj, void *opaque)
713 QOMCompositionState *s = opaque;
715 print_qom_composition(s->mon, obj, s->indent);
720 static void print_qom_composition(Monitor *mon, Object *obj, int indent)
722 QOMCompositionState s = {
724 .indent = indent + 2,
728 if (obj == object_get_root()) {
731 name = object_get_canonical_path_component(obj);
733 monitor_printf(mon, "%*s/%s (%s)\n", indent, "", name,
734 object_get_typename(obj));
736 object_child_foreach(obj, print_qom_composition_child, &s);
739 void hmp_info_qom_tree(Monitor *mon, const QDict *dict)
741 const char *path = qdict_get_try_str(dict, "path");
743 bool ambiguous = false;
746 obj = object_resolve_path(path, &ambiguous);
748 monitor_printf(mon, "Path '%s' could not be resolved.\n", path);
752 monitor_printf(mon, "Warning: Path '%s' is ambiguous.\n", path);
756 obj = qdev_get_machine();
758 print_qom_composition(mon, obj, 0);
761 void qmp_device_add(QDict *qdict, QObject **ret_data, Error **errp)
763 Error *local_err = NULL;
767 opts = qemu_opts_from_qdict(qemu_find_opts("device"), qdict, &local_err);
769 error_propagate(errp, local_err);
772 if (!monitor_cur_is_qmp() && qdev_device_help(opts)) {
776 dev = qdev_device_add(opts, &local_err);
778 error_propagate(errp, local_err);
782 object_unref(OBJECT(dev));
785 void qmp_device_del(const char *id, Error **errp)
788 char *root_path = object_get_canonical_path(qdev_get_peripheral());
789 char *path = g_strdup_printf("%s/%s", root_path, id);
792 obj = object_resolve_path_type(path, TYPE_DEVICE, NULL);
796 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
797 "Device '%s' not found", id);
801 qdev_unplug(DEVICE(obj), errp);
804 void qdev_machine_init(void)
806 qdev_get_peripheral_anon();
807 qdev_get_peripheral();
810 QemuOptsList qemu_device_opts = {
812 .implied_opt_name = "driver",
813 .head = QTAILQ_HEAD_INITIALIZER(qemu_device_opts.head),
816 * no elements => accept any
817 * sanity checking will happen later
818 * when setting device properties
820 { /* end of list */ }
824 QemuOptsList qemu_global_opts = {
826 .head = QTAILQ_HEAD_INITIALIZER(qemu_global_opts.head),
830 .type = QEMU_OPT_STRING,
833 .type = QEMU_OPT_STRING,
836 .type = QEMU_OPT_STRING,
838 { /* end of list */ }
842 int qemu_global_option(const char *str)
844 char driver[64], property[64];
848 rc = sscanf(str, "%63[^.=].%63[^=]%n", driver, property, &offset);
849 if (rc == 2 && str[offset] == '=') {
850 opts = qemu_opts_create(&qemu_global_opts, NULL, 0, &error_abort);
851 qemu_opt_set(opts, "driver", driver, &error_abort);
852 qemu_opt_set(opts, "property", property, &error_abort);
853 qemu_opt_set(opts, "value", str + offset + 1, &error_abort);
857 opts = qemu_opts_parse_noisily(&qemu_global_opts, str, false);