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/>.
20 #include "qemu/osdep.h"
22 #include "hw/sysbus.h"
23 #include "monitor/monitor.h"
24 #include "monitor/qdev.h"
25 #include "qmp-commands.h"
26 #include "sysemu/arch_init.h"
27 #include "qapi/qmp/qerror.h"
28 #include "qemu/config-file.h"
29 #include "qemu/error-report.h"
32 * Aliases were a bad idea from the start. Let's keep them
33 * from spreading further.
35 typedef struct QDevAlias
42 static const QDevAlias qdev_alias_table[] = {
43 { "virtio-blk-pci", "virtio-blk", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
44 { "virtio-net-pci", "virtio-net", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
45 { "virtio-serial-pci", "virtio-serial", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
46 { "virtio-balloon-pci", "virtio-balloon",
47 QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
48 { "virtio-blk-ccw", "virtio-blk", QEMU_ARCH_S390X },
49 { "virtio-net-ccw", "virtio-net", QEMU_ARCH_S390X },
50 { "virtio-serial-ccw", "virtio-serial", QEMU_ARCH_S390X },
51 { "lsi53c895a", "lsi" },
52 { "ich9-ahci", "ahci" },
53 { "kvm-pci-assign", "pci-assign" },
54 { "e1000", "e1000-82540em" },
58 static const char *qdev_class_get_alias(DeviceClass *dc)
60 const char *typename = object_class_get_name(OBJECT_CLASS(dc));
63 for (i = 0; qdev_alias_table[i].typename; i++) {
64 if (qdev_alias_table[i].arch_mask &&
65 !(qdev_alias_table[i].arch_mask & arch_type)) {
69 if (strcmp(qdev_alias_table[i].typename, typename) == 0) {
70 return qdev_alias_table[i].alias;
77 static bool qdev_class_has_alias(DeviceClass *dc)
79 return (qdev_class_get_alias(dc) != NULL);
82 static void qdev_print_devinfo(DeviceClass *dc)
84 error_printf("name \"%s\"", object_class_get_name(OBJECT_CLASS(dc)));
86 error_printf(", bus %s", dc->bus_type);
88 if (qdev_class_has_alias(dc)) {
89 error_printf(", alias \"%s\"", qdev_class_get_alias(dc));
92 error_printf(", desc \"%s\"", dc->desc);
94 if (dc->cannot_instantiate_with_device_add_yet) {
95 error_printf(", no-user");
100 static gint devinfo_cmp(gconstpointer a, gconstpointer b)
102 return strcasecmp(object_class_get_name((ObjectClass *)a),
103 object_class_get_name((ObjectClass *)b));
106 static void qdev_print_devinfos(bool show_no_user)
108 static const char *cat_name[DEVICE_CATEGORY_MAX + 1] = {
109 [DEVICE_CATEGORY_BRIDGE] = "Controller/Bridge/Hub",
110 [DEVICE_CATEGORY_USB] = "USB",
111 [DEVICE_CATEGORY_STORAGE] = "Storage",
112 [DEVICE_CATEGORY_NETWORK] = "Network",
113 [DEVICE_CATEGORY_INPUT] = "Input",
114 [DEVICE_CATEGORY_DISPLAY] = "Display",
115 [DEVICE_CATEGORY_SOUND] = "Sound",
116 [DEVICE_CATEGORY_MISC] = "Misc",
117 [DEVICE_CATEGORY_MAX] = "Uncategorized",
123 list = g_slist_sort(object_class_get_list(TYPE_DEVICE, false),
126 for (i = 0; i <= DEVICE_CATEGORY_MAX; i++) {
128 for (elt = list; elt; elt = elt->next) {
129 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
131 if ((i < DEVICE_CATEGORY_MAX
132 ? !test_bit(i, dc->categories)
133 : !bitmap_empty(dc->categories, DEVICE_CATEGORY_MAX))
135 && dc->cannot_instantiate_with_device_add_yet)) {
139 error_printf("%s%s devices:\n", i ? "\n" : "",
143 qdev_print_devinfo(dc);
150 static int set_property(void *opaque, const char *name, const char *value,
153 Object *obj = opaque;
156 if (strcmp(name, "driver") == 0)
158 if (strcmp(name, "bus") == 0)
161 object_property_parse(obj, value, name, &err);
163 error_propagate(errp, err);
169 static const char *find_typename_by_alias(const char *alias)
173 for (i = 0; qdev_alias_table[i].alias; i++) {
174 if (qdev_alias_table[i].arch_mask &&
175 !(qdev_alias_table[i].arch_mask & arch_type)) {
179 if (strcmp(qdev_alias_table[i].alias, alias) == 0) {
180 return qdev_alias_table[i].typename;
187 static DeviceClass *qdev_get_device_class(const char **driver, Error **errp)
191 const char *original_name = *driver;
193 oc = object_class_by_name(*driver);
195 const char *typename = find_typename_by_alias(*driver);
199 oc = object_class_by_name(*driver);
203 if (!object_class_dynamic_cast(oc, TYPE_DEVICE)) {
204 if (*driver != original_name) {
205 error_setg(errp, "'%s' (alias '%s') is not a valid device model"
206 " name", original_name, *driver);
208 error_setg(errp, "'%s' is not a valid device model name", *driver);
213 if (object_class_is_abstract(oc)) {
214 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
215 "non-abstract device type");
219 dc = DEVICE_CLASS(oc);
220 if (dc->cannot_instantiate_with_device_add_yet ||
221 (qdev_hotplug && !dc->hotpluggable)) {
222 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
223 "pluggable device type");
231 int qdev_device_help(QemuOpts *opts)
233 Error *local_err = NULL;
235 DevicePropertyInfoList *prop_list;
236 DevicePropertyInfoList *prop;
238 driver = qemu_opt_get(opts, "driver");
239 if (driver && is_help_option(driver)) {
240 qdev_print_devinfos(false);
244 if (!driver || !qemu_opt_has_help_opt(opts)) {
248 if (!object_class_by_name(driver)) {
249 const char *typename = find_typename_by_alias(driver);
256 prop_list = qmp_device_list_properties(driver, &local_err);
261 for (prop = prop_list; prop; prop = prop->next) {
262 error_printf("%s.%s=%s", driver,
265 if (prop->value->has_description) {
266 error_printf(" (%s)\n", prop->value->description);
272 qapi_free_DevicePropertyInfoList(prop_list);
276 error_report_err(local_err);
280 static Object *qdev_get_peripheral(void)
285 dev = container_get(qdev_get_machine(), "/peripheral");
291 static Object *qdev_get_peripheral_anon(void)
296 dev = container_get(qdev_get_machine(), "/peripheral-anon");
302 static void qbus_list_bus(DeviceState *dev, Error **errp)
305 const char *sep = " ";
307 error_append_hint(errp, "child buses at \"%s\":",
308 dev->id ? dev->id : object_get_typename(OBJECT(dev)));
309 QLIST_FOREACH(child, &dev->child_bus, sibling) {
310 error_append_hint(errp, "%s\"%s\"", sep, child->name);
313 error_append_hint(errp, "\n");
316 static void qbus_list_dev(BusState *bus, Error **errp)
319 const char *sep = " ";
321 error_append_hint(errp, "devices at \"%s\":", bus->name);
322 QTAILQ_FOREACH(kid, &bus->children, sibling) {
323 DeviceState *dev = kid->child;
324 error_append_hint(errp, "%s\"%s\"", sep,
325 object_get_typename(OBJECT(dev)));
327 error_append_hint(errp, "/\"%s\"", dev->id);
331 error_append_hint(errp, "\n");
334 static BusState *qbus_find_bus(DeviceState *dev, char *elem)
338 QLIST_FOREACH(child, &dev->child_bus, sibling) {
339 if (strcmp(child->name, elem) == 0) {
346 static DeviceState *qbus_find_dev(BusState *bus, char *elem)
351 * try to match in order:
352 * (1) instance id, if present
354 * (3) driver alias, if present
356 QTAILQ_FOREACH(kid, &bus->children, sibling) {
357 DeviceState *dev = kid->child;
358 if (dev->id && strcmp(dev->id, elem) == 0) {
362 QTAILQ_FOREACH(kid, &bus->children, sibling) {
363 DeviceState *dev = kid->child;
364 if (strcmp(object_get_typename(OBJECT(dev)), elem) == 0) {
368 QTAILQ_FOREACH(kid, &bus->children, sibling) {
369 DeviceState *dev = kid->child;
370 DeviceClass *dc = DEVICE_GET_CLASS(dev);
372 if (qdev_class_has_alias(dc) &&
373 strcmp(qdev_class_get_alias(dc), elem) == 0) {
380 static inline bool qbus_is_full(BusState *bus)
382 BusClass *bus_class = BUS_GET_CLASS(bus);
383 return bus_class->max_dev && bus->max_index >= bus_class->max_dev;
387 * Search the tree rooted at @bus for a bus.
388 * If @name, search for a bus with that name. Note that bus names
389 * need not be unique. Yes, that's screwed up.
390 * Else search for a bus that is a subtype of @bus_typename.
391 * If more than one exists, prefer one that can take another device.
392 * Return the bus if found, else %NULL.
394 static BusState *qbus_find_recursive(BusState *bus, const char *name,
395 const char *bus_typename)
398 BusState *pick, *child, *ret;
401 assert(name || bus_typename);
403 match = !strcmp(bus->name, name);
405 match = !!object_dynamic_cast(OBJECT(bus), bus_typename);
408 if (match && !qbus_is_full(bus)) {
409 return bus; /* root matches and isn't full */
412 pick = match ? bus : NULL;
414 QTAILQ_FOREACH(kid, &bus->children, sibling) {
415 DeviceState *dev = kid->child;
416 QLIST_FOREACH(child, &dev->child_bus, sibling) {
417 ret = qbus_find_recursive(child, name, bus_typename);
418 if (ret && !qbus_is_full(ret)) {
419 return ret; /* a descendant matches and isn't full */
427 /* root or a descendant matches, but is full */
431 static BusState *qbus_find(const char *path, Error **errp)
438 /* find start element */
439 if (path[0] == '/') {
440 bus = sysbus_get_default();
443 if (sscanf(path, "%127[^/]%n", elem, &len) != 1) {
447 bus = qbus_find_recursive(sysbus_get_default(), elem, NULL);
449 error_setg(errp, "Bus '%s' not found", elem);
456 assert(path[pos] == '/' || !path[pos]);
457 while (path[pos] == '/') {
460 if (path[pos] == '\0') {
465 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
466 g_assert_not_reached();
470 dev = qbus_find_dev(bus, elem);
472 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
473 "Device '%s' not found", elem);
474 qbus_list_dev(bus, errp);
478 assert(path[pos] == '/' || !path[pos]);
479 while (path[pos] == '/') {
482 if (path[pos] == '\0') {
483 /* last specified element is a device. If it has exactly
484 * one child bus accept it nevertheless */
485 if (dev->num_child_bus == 1) {
486 bus = QLIST_FIRST(&dev->child_bus);
489 if (dev->num_child_bus) {
490 error_setg(errp, "Device '%s' has multiple child buses",
492 qbus_list_bus(dev, errp);
494 error_setg(errp, "Device '%s' has no child bus", elem);
500 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
501 g_assert_not_reached();
505 bus = qbus_find_bus(dev, elem);
507 error_setg(errp, "Bus '%s' not found", elem);
508 qbus_list_bus(dev, errp);
513 if (qbus_is_full(bus)) {
514 error_setg(errp, "Bus '%s' is full", path);
520 DeviceState *qdev_device_add(QemuOpts *opts, Error **errp)
523 const char *driver, *path, *id;
525 BusState *bus = NULL;
528 driver = qemu_opt_get(opts, "driver");
530 error_setg(errp, QERR_MISSING_PARAMETER, "driver");
535 dc = qdev_get_device_class(&driver, errp);
541 path = qemu_opt_get(opts, "bus");
543 bus = qbus_find(path, errp);
547 if (!object_dynamic_cast(OBJECT(bus), dc->bus_type)) {
548 error_setg(errp, "Device '%s' can't go on %s bus",
549 driver, object_get_typename(OBJECT(bus)));
552 } else if (dc->bus_type != NULL) {
553 bus = qbus_find_recursive(sysbus_get_default(), NULL, dc->bus_type);
554 if (!bus || qbus_is_full(bus)) {
555 error_setg(errp, "No '%s' bus found for device '%s'",
556 dc->bus_type, driver);
560 if (qdev_hotplug && bus && !qbus_is_hotpluggable(bus)) {
561 error_setg(errp, QERR_BUS_NO_HOTPLUG, bus->name);
566 dev = DEVICE(object_new(driver));
569 qdev_set_parent_bus(dev, bus);
572 id = qemu_opts_id(opts);
578 object_property_add_child(qdev_get_peripheral(), dev->id,
581 static int anon_count;
582 gchar *name = g_strdup_printf("device[%d]", anon_count++);
583 object_property_add_child(qdev_get_peripheral_anon(), name,
589 if (qemu_opt_foreach(opts, set_property, dev, &err)) {
590 error_propagate(errp, err);
591 object_unparent(OBJECT(dev));
592 object_unref(OBJECT(dev));
597 object_property_set_bool(OBJECT(dev), true, "realized", &err);
599 error_propagate(errp, err);
601 object_unparent(OBJECT(dev));
602 object_unref(OBJECT(dev));
609 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
610 static void qbus_print(Monitor *mon, BusState *bus, int indent);
612 static void qdev_print_props(Monitor *mon, DeviceState *dev, Property *props,
617 for (; props->name; props++) {
620 char *legacy_name = g_strdup_printf("legacy-%s", props->name);
621 if (object_property_get_type(OBJECT(dev), legacy_name, NULL)) {
622 value = object_property_get_str(OBJECT(dev), legacy_name, &err);
624 value = object_property_print(OBJECT(dev), props->name, true, &err);
632 qdev_printf("%s = %s\n", props->name,
633 value && *value ? value : "<null>");
638 static void bus_print_dev(BusState *bus, Monitor *mon, DeviceState *dev, int indent)
640 BusClass *bc = BUS_GET_CLASS(bus);
643 bc->print_dev(mon, dev, indent);
647 static void qdev_print(Monitor *mon, DeviceState *dev, int indent)
653 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev)),
654 dev->id ? dev->id : "");
656 QLIST_FOREACH(ngl, &dev->gpios, node) {
658 qdev_printf("gpio-in \"%s\" %d\n", ngl->name ? ngl->name : "",
662 qdev_printf("gpio-out \"%s\" %d\n", ngl->name ? ngl->name : "",
666 class = object_get_class(OBJECT(dev));
668 qdev_print_props(mon, dev, DEVICE_CLASS(class)->props, indent);
669 class = object_class_get_parent(class);
670 } while (class != object_class_by_name(TYPE_DEVICE));
671 bus_print_dev(dev->parent_bus, mon, dev, indent);
672 QLIST_FOREACH(child, &dev->child_bus, sibling) {
673 qbus_print(mon, child, indent);
677 static void qbus_print(Monitor *mon, BusState *bus, int indent)
681 qdev_printf("bus: %s\n", bus->name);
683 qdev_printf("type %s\n", object_get_typename(OBJECT(bus)));
684 QTAILQ_FOREACH(kid, &bus->children, sibling) {
685 DeviceState *dev = kid->child;
686 qdev_print(mon, dev, indent);
691 void hmp_info_qtree(Monitor *mon, const QDict *qdict)
693 if (sysbus_get_default())
694 qbus_print(mon, sysbus_get_default(), 0);
697 void hmp_info_qdm(Monitor *mon, const QDict *qdict)
699 qdev_print_devinfos(true);
702 typedef struct QOMCompositionState {
705 } QOMCompositionState;
707 static void print_qom_composition(Monitor *mon, Object *obj, int indent);
709 static int print_qom_composition_child(Object *obj, void *opaque)
711 QOMCompositionState *s = opaque;
713 print_qom_composition(s->mon, obj, s->indent);
718 static void print_qom_composition(Monitor *mon, Object *obj, int indent)
720 QOMCompositionState s = {
722 .indent = indent + 2,
726 if (obj == object_get_root()) {
729 name = object_get_canonical_path_component(obj);
731 monitor_printf(mon, "%*s/%s (%s)\n", indent, "", name,
732 object_get_typename(obj));
734 object_child_foreach(obj, print_qom_composition_child, &s);
737 void hmp_info_qom_tree(Monitor *mon, const QDict *dict)
739 const char *path = qdict_get_try_str(dict, "path");
741 bool ambiguous = false;
744 obj = object_resolve_path(path, &ambiguous);
746 monitor_printf(mon, "Path '%s' could not be resolved.\n", path);
750 monitor_printf(mon, "Warning: Path '%s' is ambiguous.\n", path);
754 obj = qdev_get_machine();
756 print_qom_composition(mon, obj, 0);
759 void qmp_device_add(QDict *qdict, QObject **ret_data, Error **errp)
761 Error *local_err = NULL;
765 opts = qemu_opts_from_qdict(qemu_find_opts("device"), qdict, &local_err);
767 error_propagate(errp, local_err);
770 if (!monitor_cur_is_qmp() && qdev_device_help(opts)) {
774 dev = qdev_device_add(opts, &local_err);
776 error_propagate(errp, local_err);
780 object_unref(OBJECT(dev));
783 void qmp_device_del(const char *id, Error **errp)
788 obj = object_resolve_path(id, NULL);
790 char *root_path = object_get_canonical_path(qdev_get_peripheral());
791 char *path = g_strdup_printf("%s/%s", root_path, id);
794 obj = object_resolve_path_type(path, TYPE_DEVICE, NULL);
799 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
800 "Device '%s' not found", id);
804 if (!object_dynamic_cast(obj, TYPE_DEVICE)) {
805 error_setg(errp, "%s is not a hotpluggable device", id);
809 qdev_unplug(DEVICE(obj), errp);
812 void qdev_machine_init(void)
814 qdev_get_peripheral_anon();
815 qdev_get_peripheral();
818 QemuOptsList qemu_device_opts = {
820 .implied_opt_name = "driver",
821 .head = QTAILQ_HEAD_INITIALIZER(qemu_device_opts.head),
824 * no elements => accept any
825 * sanity checking will happen later
826 * when setting device properties
828 { /* end of list */ }
832 QemuOptsList qemu_global_opts = {
834 .head = QTAILQ_HEAD_INITIALIZER(qemu_global_opts.head),
838 .type = QEMU_OPT_STRING,
841 .type = QEMU_OPT_STRING,
844 .type = QEMU_OPT_STRING,
846 { /* end of list */ }
850 int qemu_global_option(const char *str)
852 char driver[64], property[64];
856 rc = sscanf(str, "%63[^.=].%63[^=]%n", driver, property, &offset);
857 if (rc == 2 && str[offset] == '=') {
858 opts = qemu_opts_create(&qemu_global_opts, NULL, 0, &error_abort);
859 qemu_opt_set(opts, "driver", driver, &error_abort);
860 qemu_opt_set(opts, "property", property, &error_abort);
861 qemu_opt_set(opts, "value", str + offset + 1, &error_abort);
865 opts = qemu_opts_parse_noisily(&qemu_global_opts, str, false);