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-s390", "virtio-blk", QEMU_ARCH_S390X },
46 { "virtio-net-s390", "virtio-net", QEMU_ARCH_S390X },
47 { "virtio-serial-s390", "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(const char *name, const char *value, void *opaque)
148 Object *obj = opaque;
151 if (strcmp(name, "driver") == 0)
153 if (strcmp(name, "bus") == 0)
156 object_property_parse(obj, value, name, &err);
158 qerror_report_err(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 static void qbus_list_bus(DeviceState *dev)
293 const char *sep = " ";
295 error_printf("child busses at \"%s\":",
296 dev->id ? dev->id : object_get_typename(OBJECT(dev)));
297 QLIST_FOREACH(child, &dev->child_bus, sibling) {
298 error_printf("%s\"%s\"", sep, child->name);
304 static void qbus_list_dev(BusState *bus)
307 const char *sep = " ";
309 error_printf("devices at \"%s\":", bus->name);
310 QTAILQ_FOREACH(kid, &bus->children, sibling) {
311 DeviceState *dev = kid->child;
312 error_printf("%s\"%s\"", sep, object_get_typename(OBJECT(dev)));
314 error_printf("/\"%s\"", dev->id);
320 static BusState *qbus_find_bus(DeviceState *dev, char *elem)
324 QLIST_FOREACH(child, &dev->child_bus, sibling) {
325 if (strcmp(child->name, elem) == 0) {
332 static DeviceState *qbus_find_dev(BusState *bus, char *elem)
337 * try to match in order:
338 * (1) instance id, if present
340 * (3) driver alias, if present
342 QTAILQ_FOREACH(kid, &bus->children, sibling) {
343 DeviceState *dev = kid->child;
344 if (dev->id && strcmp(dev->id, elem) == 0) {
348 QTAILQ_FOREACH(kid, &bus->children, sibling) {
349 DeviceState *dev = kid->child;
350 if (strcmp(object_get_typename(OBJECT(dev)), elem) == 0) {
354 QTAILQ_FOREACH(kid, &bus->children, sibling) {
355 DeviceState *dev = kid->child;
356 DeviceClass *dc = DEVICE_GET_CLASS(dev);
358 if (qdev_class_has_alias(dc) &&
359 strcmp(qdev_class_get_alias(dc), elem) == 0) {
366 static BusState *qbus_find_recursive(BusState *bus, const char *name,
367 const char *bus_typename)
369 BusClass *bus_class = BUS_GET_CLASS(bus);
371 BusState *child, *ret;
374 if (name && (strcmp(bus->name, name) != 0)) {
376 } else if (bus_typename && !object_dynamic_cast(OBJECT(bus), bus_typename)) {
378 } else if ((bus_class->max_dev != 0) && (bus_class->max_dev <= bus->max_index)) {
380 /* bus was explicitly specified: return an error. */
381 qerror_report(ERROR_CLASS_GENERIC_ERROR, "Bus '%s' is full",
385 /* bus was not specified: try to find another one. */
393 QTAILQ_FOREACH(kid, &bus->children, sibling) {
394 DeviceState *dev = kid->child;
395 QLIST_FOREACH(child, &dev->child_bus, sibling) {
396 ret = qbus_find_recursive(child, name, bus_typename);
405 static BusState *qbus_find(const char *path)
412 /* find start element */
413 if (path[0] == '/') {
414 bus = sysbus_get_default();
417 if (sscanf(path, "%127[^/]%n", elem, &len) != 1) {
421 bus = qbus_find_recursive(sysbus_get_default(), elem, NULL);
423 qerror_report(QERR_BUS_NOT_FOUND, elem);
430 assert(path[pos] == '/' || !path[pos]);
431 while (path[pos] == '/') {
434 if (path[pos] == '\0') {
439 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
440 g_assert_not_reached();
444 dev = qbus_find_dev(bus, elem);
446 qerror_report(QERR_DEVICE_NOT_FOUND, elem);
447 if (!monitor_cur_is_qmp()) {
453 assert(path[pos] == '/' || !path[pos]);
454 while (path[pos] == '/') {
457 if (path[pos] == '\0') {
458 /* last specified element is a device. If it has exactly
459 * one child bus accept it nevertheless */
460 switch (dev->num_child_bus) {
462 qerror_report(ERROR_CLASS_GENERIC_ERROR,
463 "Device '%s' has no child bus", elem);
466 return QLIST_FIRST(&dev->child_bus);
468 qerror_report(ERROR_CLASS_GENERIC_ERROR,
469 "Device '%s' has multiple child busses", elem);
470 if (!monitor_cur_is_qmp()) {
478 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
479 g_assert_not_reached();
483 bus = qbus_find_bus(dev, elem);
485 qerror_report(QERR_BUS_NOT_FOUND, elem);
486 if (!monitor_cur_is_qmp()) {
494 DeviceState *qdev_device_add(QemuOpts *opts)
497 const char *driver, *path, *id;
499 BusState *bus = NULL;
502 driver = qemu_opt_get(opts, "driver");
504 qerror_report(QERR_MISSING_PARAMETER, "driver");
509 dc = qdev_get_device_class(&driver, &err);
511 qerror_report_err(err);
517 path = qemu_opt_get(opts, "bus");
519 bus = qbus_find(path);
523 if (!object_dynamic_cast(OBJECT(bus), dc->bus_type)) {
524 qerror_report(ERROR_CLASS_GENERIC_ERROR,
525 "Device '%s' can't go on a %s bus",
526 driver, object_get_typename(OBJECT(bus)));
529 } else if (dc->bus_type != NULL) {
530 bus = qbus_find_recursive(sysbus_get_default(), NULL, dc->bus_type);
532 qerror_report(ERROR_CLASS_GENERIC_ERROR,
533 "No '%s' bus found for device '%s'",
534 dc->bus_type, driver);
538 if (qdev_hotplug && bus && !qbus_is_hotpluggable(bus)) {
539 qerror_report(QERR_BUS_NO_HOTPLUG, bus->name);
544 dev = DEVICE(object_new(driver));
547 qdev_set_parent_bus(dev, bus);
550 id = qemu_opts_id(opts);
556 object_property_add_child(qdev_get_peripheral(), dev->id,
559 static int anon_count;
560 gchar *name = g_strdup_printf("device[%d]", anon_count++);
561 object_property_add_child(qdev_get_peripheral_anon(), name,
567 if (qemu_opt_foreach(opts, set_property, dev, 1) != 0) {
568 object_unparent(OBJECT(dev));
569 object_unref(OBJECT(dev));
574 object_property_set_bool(OBJECT(dev), true, "realized", &err);
576 qerror_report_err(err);
579 object_unparent(OBJECT(dev));
580 object_unref(OBJECT(dev));
581 qerror_report(QERR_DEVICE_INIT_FAILED, driver);
588 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
589 static void qbus_print(Monitor *mon, BusState *bus, int indent);
591 static void qdev_print_props(Monitor *mon, DeviceState *dev, Property *props,
596 for (; props->name; props++) {
599 char *legacy_name = g_strdup_printf("legacy-%s", props->name);
600 if (object_property_get_type(OBJECT(dev), legacy_name, NULL)) {
601 value = object_property_get_str(OBJECT(dev), legacy_name, &err);
603 value = object_property_print(OBJECT(dev), props->name, true, &err);
611 qdev_printf("%s = %s\n", props->name,
612 value && *value ? value : "<null>");
617 static void bus_print_dev(BusState *bus, Monitor *mon, DeviceState *dev, int indent)
619 BusClass *bc = BUS_GET_CLASS(bus);
622 bc->print_dev(mon, dev, indent);
626 static void qdev_print(Monitor *mon, DeviceState *dev, int indent)
632 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev)),
633 dev->id ? dev->id : "");
635 QLIST_FOREACH(ngl, &dev->gpios, node) {
637 qdev_printf("gpio-in \"%s\" %d\n", ngl->name ? ngl->name : "",
641 qdev_printf("gpio-out \"%s\" %d\n", ngl->name ? ngl->name : "",
645 class = object_get_class(OBJECT(dev));
647 qdev_print_props(mon, dev, DEVICE_CLASS(class)->props, indent);
648 class = object_class_get_parent(class);
649 } while (class != object_class_by_name(TYPE_DEVICE));
650 bus_print_dev(dev->parent_bus, mon, dev, indent);
651 QLIST_FOREACH(child, &dev->child_bus, sibling) {
652 qbus_print(mon, child, indent);
656 static void qbus_print(Monitor *mon, BusState *bus, int indent)
660 qdev_printf("bus: %s\n", bus->name);
662 qdev_printf("type %s\n", object_get_typename(OBJECT(bus)));
663 QTAILQ_FOREACH(kid, &bus->children, sibling) {
664 DeviceState *dev = kid->child;
665 qdev_print(mon, dev, indent);
670 void hmp_info_qtree(Monitor *mon, const QDict *qdict)
672 if (sysbus_get_default())
673 qbus_print(mon, sysbus_get_default(), 0);
676 void hmp_info_qdm(Monitor *mon, const QDict *qdict)
678 qdev_print_devinfos(true);
681 typedef struct QOMCompositionState {
684 } QOMCompositionState;
686 static void print_qom_composition(Monitor *mon, Object *obj, int indent);
688 static int print_qom_composition_child(Object *obj, void *opaque)
690 QOMCompositionState *s = opaque;
692 print_qom_composition(s->mon, obj, s->indent);
697 static void print_qom_composition(Monitor *mon, Object *obj, int indent)
699 QOMCompositionState s = {
701 .indent = indent + 2,
705 if (obj == object_get_root()) {
708 name = object_get_canonical_path_component(obj);
710 monitor_printf(mon, "%*s/%s (%s)\n", indent, "", name,
711 object_get_typename(obj));
713 object_child_foreach(obj, print_qom_composition_child, &s);
716 void hmp_info_qom_tree(Monitor *mon, const QDict *dict)
718 const char *path = qdict_get_try_str(dict, "path");
720 bool ambiguous = false;
723 obj = object_resolve_path(path, &ambiguous);
725 monitor_printf(mon, "Path '%s' could not be resolved.\n", path);
729 monitor_printf(mon, "Warning: Path '%s' is ambiguous.\n", path);
733 obj = qdev_get_machine();
735 print_qom_composition(mon, obj, 0);
738 int do_device_add(Monitor *mon, const QDict *qdict, QObject **ret_data)
740 Error *local_err = NULL;
744 opts = qemu_opts_from_qdict(qemu_find_opts("device"), qdict, &local_err);
746 qerror_report_err(local_err);
747 error_free(local_err);
750 if (!monitor_cur_is_qmp() && qdev_device_help(opts)) {
754 dev = qdev_device_add(opts);
759 object_unref(OBJECT(dev));
763 void qmp_device_del(const char *id, Error **errp)
766 char *root_path = object_get_canonical_path(qdev_get_peripheral());
767 char *path = g_strdup_printf("%s/%s", root_path, id);
770 obj = object_resolve_path_type(path, TYPE_DEVICE, NULL);
774 error_set(errp, QERR_DEVICE_NOT_FOUND, id);
778 qdev_unplug(DEVICE(obj), errp);
781 void qdev_machine_init(void)
783 qdev_get_peripheral_anon();
784 qdev_get_peripheral();
787 QemuOptsList qemu_device_opts = {
789 .implied_opt_name = "driver",
790 .head = QTAILQ_HEAD_INITIALIZER(qemu_device_opts.head),
793 * no elements => accept any
794 * sanity checking will happen later
795 * when setting device properties
797 { /* end of list */ }
801 QemuOptsList qemu_global_opts = {
803 .head = QTAILQ_HEAD_INITIALIZER(qemu_global_opts.head),
807 .type = QEMU_OPT_STRING,
810 .type = QEMU_OPT_STRING,
813 .type = QEMU_OPT_STRING,
815 { /* end of list */ }
819 int qemu_global_option(const char *str)
821 char driver[64], property[64];
825 rc = sscanf(str, "%63[^.].%63[^=]%n", driver, property, &offset);
826 if (rc < 2 || str[offset] != '=') {
827 error_report("can't parse: \"%s\"", str);
831 opts = qemu_opts_create(&qemu_global_opts, NULL, 0, &error_abort);
832 qemu_opt_set(opts, "driver", driver, &error_abort);
833 qemu_opt_set(opts, "property", property, &error_abort);
834 qemu_opt_set(opts, "value", str + offset + 1, &error_abort);