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 "qemu/config-file.h"
29 * Aliases were a bad idea from the start. Let's keep them
30 * from spreading further.
32 typedef struct QDevAlias
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-ccw", "virtio-blk", QEMU_ARCH_S390X },
46 { "virtio-net-ccw", "virtio-net", QEMU_ARCH_S390X },
47 { "virtio-serial-ccw", "virtio-serial", QEMU_ARCH_S390X },
48 { "lsi53c895a", "lsi" },
49 { "ich9-ahci", "ahci" },
50 { "kvm-pci-assign", "pci-assign" },
54 static const char *qdev_class_get_alias(DeviceClass *dc)
56 const char *typename = object_class_get_name(OBJECT_CLASS(dc));
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)) {
65 if (strcmp(qdev_alias_table[i].typename, typename) == 0) {
66 return qdev_alias_table[i].alias;
73 static bool qdev_class_has_alias(DeviceClass *dc)
75 return (qdev_class_get_alias(dc) != NULL);
78 static void qdev_print_devinfo(DeviceClass *dc)
80 error_printf("name \"%s\"", object_class_get_name(OBJECT_CLASS(dc)));
82 error_printf(", bus %s", dc->bus_type);
84 if (qdev_class_has_alias(dc)) {
85 error_printf(", alias \"%s\"", qdev_class_get_alias(dc));
88 error_printf(", desc \"%s\"", dc->desc);
90 if (dc->cannot_instantiate_with_device_add_yet) {
91 error_printf(", no-user");
96 static gint devinfo_cmp(gconstpointer a, gconstpointer b)
98 return strcasecmp(object_class_get_name((ObjectClass *)a),
99 object_class_get_name((ObjectClass *)b));
102 static void qdev_print_devinfos(bool show_no_user)
104 static const char *cat_name[DEVICE_CATEGORY_MAX + 1] = {
105 [DEVICE_CATEGORY_BRIDGE] = "Controller/Bridge/Hub",
106 [DEVICE_CATEGORY_USB] = "USB",
107 [DEVICE_CATEGORY_STORAGE] = "Storage",
108 [DEVICE_CATEGORY_NETWORK] = "Network",
109 [DEVICE_CATEGORY_INPUT] = "Input",
110 [DEVICE_CATEGORY_DISPLAY] = "Display",
111 [DEVICE_CATEGORY_SOUND] = "Sound",
112 [DEVICE_CATEGORY_MISC] = "Misc",
113 [DEVICE_CATEGORY_MAX] = "Uncategorized",
119 list = g_slist_sort(object_class_get_list(TYPE_DEVICE, false),
122 for (i = 0; i <= DEVICE_CATEGORY_MAX; i++) {
124 for (elt = list; elt; elt = elt->next) {
125 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
127 if ((i < DEVICE_CATEGORY_MAX
128 ? !test_bit(i, dc->categories)
129 : !bitmap_empty(dc->categories, DEVICE_CATEGORY_MAX))
131 && dc->cannot_instantiate_with_device_add_yet)) {
135 error_printf("%s%s devices:\n", i ? "\n" : "",
139 qdev_print_devinfo(dc);
146 static int set_property(void *opaque, const char *name, const char *value,
149 Object *obj = opaque;
152 if (strcmp(name, "driver") == 0)
154 if (strcmp(name, "bus") == 0)
157 object_property_parse(obj, value, name, &err);
159 error_propagate(errp, err);
165 static const char *find_typename_by_alias(const char *alias)
169 for (i = 0; qdev_alias_table[i].alias; i++) {
170 if (qdev_alias_table[i].arch_mask &&
171 !(qdev_alias_table[i].arch_mask & arch_type)) {
175 if (strcmp(qdev_alias_table[i].alias, alias) == 0) {
176 return qdev_alias_table[i].typename;
183 static DeviceClass *qdev_get_device_class(const char **driver, Error **errp)
188 oc = object_class_by_name(*driver);
190 const char *typename = find_typename_by_alias(*driver);
194 oc = object_class_by_name(*driver);
198 if (!object_class_dynamic_cast(oc, TYPE_DEVICE)) {
199 error_setg(errp, "'%s' is not a valid device model name", *driver);
203 if (object_class_is_abstract(oc)) {
204 error_set(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
205 "non-abstract device type");
209 dc = DEVICE_CLASS(oc);
210 if (dc->cannot_instantiate_with_device_add_yet ||
211 (qdev_hotplug && !dc->hotpluggable)) {
212 error_set(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
213 "pluggable device type");
221 int qdev_device_help(QemuOpts *opts)
223 Error *local_err = NULL;
225 DevicePropertyInfoList *prop_list;
226 DevicePropertyInfoList *prop;
228 driver = qemu_opt_get(opts, "driver");
229 if (driver && is_help_option(driver)) {
230 qdev_print_devinfos(false);
234 if (!driver || !qemu_opt_has_help_opt(opts)) {
238 qdev_get_device_class(&driver, &local_err);
243 prop_list = qmp_device_list_properties(driver, &local_err);
248 for (prop = prop_list; prop; prop = prop->next) {
249 error_printf("%s.%s=%s", driver,
252 if (prop->value->has_description) {
253 error_printf(" (%s)\n", prop->value->description);
259 qapi_free_DevicePropertyInfoList(prop_list);
263 error_printf("%s\n", error_get_pretty(local_err));
264 error_free(local_err);
268 static Object *qdev_get_peripheral(void)
273 dev = container_get(qdev_get_machine(), "/peripheral");
279 static Object *qdev_get_peripheral_anon(void)
284 dev = container_get(qdev_get_machine(), "/peripheral-anon");
290 #if 0 /* conversion from qerror_report() to error_set() broke their use */
291 static void qbus_list_bus(DeviceState *dev)
294 const char *sep = " ";
296 error_printf("child buses at \"%s\":",
297 dev->id ? dev->id : object_get_typename(OBJECT(dev)));
298 QLIST_FOREACH(child, &dev->child_bus, sibling) {
299 error_printf("%s\"%s\"", sep, child->name);
305 static void qbus_list_dev(BusState *bus)
308 const char *sep = " ";
310 error_printf("devices at \"%s\":", bus->name);
311 QTAILQ_FOREACH(kid, &bus->children, sibling) {
312 DeviceState *dev = kid->child;
313 error_printf("%s\"%s\"", sep, object_get_typename(OBJECT(dev)));
315 error_printf("/\"%s\"", dev->id);
322 static BusState *qbus_find_bus(DeviceState *dev, char *elem)
326 QLIST_FOREACH(child, &dev->child_bus, sibling) {
327 if (strcmp(child->name, elem) == 0) {
334 static DeviceState *qbus_find_dev(BusState *bus, char *elem)
339 * try to match in order:
340 * (1) instance id, if present
342 * (3) driver alias, if present
344 QTAILQ_FOREACH(kid, &bus->children, sibling) {
345 DeviceState *dev = kid->child;
346 if (dev->id && strcmp(dev->id, elem) == 0) {
350 QTAILQ_FOREACH(kid, &bus->children, sibling) {
351 DeviceState *dev = kid->child;
352 if (strcmp(object_get_typename(OBJECT(dev)), elem) == 0) {
356 QTAILQ_FOREACH(kid, &bus->children, sibling) {
357 DeviceState *dev = kid->child;
358 DeviceClass *dc = DEVICE_GET_CLASS(dev);
360 if (qdev_class_has_alias(dc) &&
361 strcmp(qdev_class_get_alias(dc), elem) == 0) {
368 static inline bool qbus_is_full(BusState *bus)
370 BusClass *bus_class = BUS_GET_CLASS(bus);
371 return bus_class->max_dev && bus->max_index >= bus_class->max_dev;
375 * Search the tree rooted at @bus for a bus.
376 * If @name, search for a bus with that name. Note that bus names
377 * need not be unique. Yes, that's screwed up.
378 * Else search for a bus that is a subtype of @bus_typename.
379 * If more than one exists, prefer one that can take another device.
380 * Return the bus if found, else %NULL.
382 static BusState *qbus_find_recursive(BusState *bus, const char *name,
383 const char *bus_typename)
386 BusState *pick, *child, *ret;
389 assert(name || bus_typename);
391 match = !strcmp(bus->name, name);
393 match = !!object_dynamic_cast(OBJECT(bus), bus_typename);
396 if (match && !qbus_is_full(bus)) {
397 return bus; /* root matches and isn't full */
400 pick = match ? bus : NULL;
402 QTAILQ_FOREACH(kid, &bus->children, sibling) {
403 DeviceState *dev = kid->child;
404 QLIST_FOREACH(child, &dev->child_bus, sibling) {
405 ret = qbus_find_recursive(child, name, bus_typename);
406 if (ret && !qbus_is_full(ret)) {
407 return ret; /* a descendant matches and isn't full */
415 /* root or a descendant matches, but is full */
419 static BusState *qbus_find(const char *path, Error **errp)
426 /* find start element */
427 if (path[0] == '/') {
428 bus = sysbus_get_default();
431 if (sscanf(path, "%127[^/]%n", elem, &len) != 1) {
435 bus = qbus_find_recursive(sysbus_get_default(), elem, NULL);
437 error_setg(errp, "Bus '%s' not found", elem);
444 assert(path[pos] == '/' || !path[pos]);
445 while (path[pos] == '/') {
448 if (path[pos] == '\0') {
453 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
454 g_assert_not_reached();
458 dev = qbus_find_dev(bus, elem);
460 error_set(errp, QERR_DEVICE_NOT_FOUND, elem);
461 #if 0 /* conversion from qerror_report() to error_set() broke this: */
462 if (!monitor_cur_is_qmp()) {
469 assert(path[pos] == '/' || !path[pos]);
470 while (path[pos] == '/') {
473 if (path[pos] == '\0') {
474 /* last specified element is a device. If it has exactly
475 * one child bus accept it nevertheless */
476 if (dev->num_child_bus == 1) {
477 bus = QLIST_FIRST(&dev->child_bus);
480 if (dev->num_child_bus) {
481 error_setg(errp, "Device '%s' has multiple child buses",
483 #if 0 /* conversion from qerror_report() to error_set() broke this: */
484 if (!monitor_cur_is_qmp()) {
489 error_setg(errp, "Device '%s' has no child bus", elem);
495 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
496 g_assert_not_reached();
500 bus = qbus_find_bus(dev, elem);
502 error_setg(errp, "Bus '%s' not found", elem);
503 #if 0 /* conversion from qerror_report() to error_set() broke this: */
504 if (!monitor_cur_is_qmp()) {
512 if (qbus_is_full(bus)) {
513 error_setg(errp, "Bus '%s' is full", path);
519 DeviceState *qdev_device_add(QemuOpts *opts, Error **errp)
522 const char *driver, *path, *id;
524 BusState *bus = NULL;
527 driver = qemu_opt_get(opts, "driver");
529 error_set(errp, QERR_MISSING_PARAMETER, "driver");
534 dc = qdev_get_device_class(&driver, errp);
540 path = qemu_opt_get(opts, "bus");
542 bus = qbus_find(path, errp);
546 if (!object_dynamic_cast(OBJECT(bus), dc->bus_type)) {
547 error_setg(errp, "Device '%s' can't go on %s bus",
548 driver, object_get_typename(OBJECT(bus)));
551 } else if (dc->bus_type != NULL) {
552 bus = qbus_find_recursive(sysbus_get_default(), NULL, dc->bus_type);
553 if (!bus || qbus_is_full(bus)) {
554 error_setg(errp, "No '%s' bus found for device '%s'",
555 dc->bus_type, driver);
559 if (qdev_hotplug && bus && !qbus_is_hotpluggable(bus)) {
560 error_set(errp, QERR_BUS_NO_HOTPLUG, bus->name);
565 dev = DEVICE(object_new(driver));
568 qdev_set_parent_bus(dev, bus);
571 id = qemu_opts_id(opts);
577 object_property_add_child(qdev_get_peripheral(), dev->id,
580 static int anon_count;
581 gchar *name = g_strdup_printf("device[%d]", anon_count++);
582 object_property_add_child(qdev_get_peripheral_anon(), name,
588 if (qemu_opt_foreach(opts, set_property, dev, &err)) {
589 error_propagate(errp, err);
590 object_unparent(OBJECT(dev));
591 object_unref(OBJECT(dev));
596 object_property_set_bool(OBJECT(dev), true, "realized", &err);
598 error_propagate(errp, err);
600 object_unparent(OBJECT(dev));
601 object_unref(OBJECT(dev));
608 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
609 static void qbus_print(Monitor *mon, BusState *bus, int indent);
611 static void qdev_print_props(Monitor *mon, DeviceState *dev, Property *props,
616 for (; props->name; props++) {
619 char *legacy_name = g_strdup_printf("legacy-%s", props->name);
620 if (object_property_get_type(OBJECT(dev), legacy_name, NULL)) {
621 value = object_property_get_str(OBJECT(dev), legacy_name, &err);
623 value = object_property_print(OBJECT(dev), props->name, true, &err);
631 qdev_printf("%s = %s\n", props->name,
632 value && *value ? value : "<null>");
637 static void bus_print_dev(BusState *bus, Monitor *mon, DeviceState *dev, int indent)
639 BusClass *bc = BUS_GET_CLASS(bus);
642 bc->print_dev(mon, dev, indent);
646 static void qdev_print(Monitor *mon, DeviceState *dev, int indent)
652 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev)),
653 dev->id ? dev->id : "");
655 QLIST_FOREACH(ngl, &dev->gpios, node) {
657 qdev_printf("gpio-in \"%s\" %d\n", ngl->name ? ngl->name : "",
661 qdev_printf("gpio-out \"%s\" %d\n", ngl->name ? ngl->name : "",
665 class = object_get_class(OBJECT(dev));
667 qdev_print_props(mon, dev, DEVICE_CLASS(class)->props, indent);
668 class = object_class_get_parent(class);
669 } while (class != object_class_by_name(TYPE_DEVICE));
670 bus_print_dev(dev->parent_bus, mon, dev, indent);
671 QLIST_FOREACH(child, &dev->child_bus, sibling) {
672 qbus_print(mon, child, indent);
676 static void qbus_print(Monitor *mon, BusState *bus, int indent)
680 qdev_printf("bus: %s\n", bus->name);
682 qdev_printf("type %s\n", object_get_typename(OBJECT(bus)));
683 QTAILQ_FOREACH(kid, &bus->children, sibling) {
684 DeviceState *dev = kid->child;
685 qdev_print(mon, dev, indent);
690 void hmp_info_qtree(Monitor *mon, const QDict *qdict)
692 if (sysbus_get_default())
693 qbus_print(mon, sysbus_get_default(), 0);
696 void hmp_info_qdm(Monitor *mon, const QDict *qdict)
698 qdev_print_devinfos(true);
701 typedef struct QOMCompositionState {
704 } QOMCompositionState;
706 static void print_qom_composition(Monitor *mon, Object *obj, int indent);
708 static int print_qom_composition_child(Object *obj, void *opaque)
710 QOMCompositionState *s = opaque;
712 print_qom_composition(s->mon, obj, s->indent);
717 static void print_qom_composition(Monitor *mon, Object *obj, int indent)
719 QOMCompositionState s = {
721 .indent = indent + 2,
725 if (obj == object_get_root()) {
728 name = object_get_canonical_path_component(obj);
730 monitor_printf(mon, "%*s/%s (%s)\n", indent, "", name,
731 object_get_typename(obj));
733 object_child_foreach(obj, print_qom_composition_child, &s);
736 void hmp_info_qom_tree(Monitor *mon, const QDict *dict)
738 const char *path = qdict_get_try_str(dict, "path");
740 bool ambiguous = false;
743 obj = object_resolve_path(path, &ambiguous);
745 monitor_printf(mon, "Path '%s' could not be resolved.\n", path);
749 monitor_printf(mon, "Warning: Path '%s' is ambiguous.\n", path);
753 obj = qdev_get_machine();
755 print_qom_composition(mon, obj, 0);
758 int do_device_add(Monitor *mon, const QDict *qdict, QObject **ret_data)
760 Error *local_err = NULL;
764 opts = qemu_opts_from_qdict(qemu_find_opts("device"), qdict, &local_err);
766 qerror_report_err(local_err);
767 error_free(local_err);
770 if (!monitor_cur_is_qmp() && qdev_device_help(opts)) {
774 dev = qdev_device_add(opts, &local_err);
776 qerror_report_err(local_err);
777 error_free(local_err);
781 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, QERR_DEVICE_NOT_FOUND, id);
800 qdev_unplug(DEVICE(obj), errp);
803 void qdev_machine_init(void)
805 qdev_get_peripheral_anon();
806 qdev_get_peripheral();
809 QemuOptsList qemu_device_opts = {
811 .implied_opt_name = "driver",
812 .head = QTAILQ_HEAD_INITIALIZER(qemu_device_opts.head),
815 * no elements => accept any
816 * sanity checking will happen later
817 * when setting device properties
819 { /* end of list */ }
823 QemuOptsList qemu_global_opts = {
825 .head = QTAILQ_HEAD_INITIALIZER(qemu_global_opts.head),
829 .type = QEMU_OPT_STRING,
832 .type = QEMU_OPT_STRING,
835 .type = QEMU_OPT_STRING,
837 { /* end of list */ }
841 int qemu_global_option(const char *str)
843 char driver[64], property[64];
847 rc = sscanf(str, "%63[^.=].%63[^=]%n", driver, property, &offset);
848 if (rc == 2 && str[offset] == '=') {
849 opts = qemu_opts_create(&qemu_global_opts, NULL, 0, &error_abort);
850 qemu_opt_set(opts, "driver", driver, &error_abort);
851 qemu_opt_set(opts, "property", property, &error_abort);
852 qemu_opt_set(opts, "value", str + offset + 1, &error_abort);
856 opts = qemu_opts_parse_noisily(&qemu_global_opts, str, false);