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"
30 #include "qemu/help_option.h"
31 #include "sysemu/block-backend.h"
34 * Aliases were a bad idea from the start. Let's keep them
35 * from spreading further.
37 typedef struct QDevAlias
44 /* Please keep this table sorted by typename. */
45 static const QDevAlias qdev_alias_table[] = {
46 { "e1000", "e1000-82540em" },
47 { "ich9-ahci", "ahci" },
48 { "kvm-pci-assign", "pci-assign" },
49 { "lsi53c895a", "lsi" },
50 { "virtio-9p-ccw", "virtio-9p", QEMU_ARCH_S390X },
51 { "virtio-9p-pci", "virtio-9p", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
52 { "virtio-balloon-ccw", "virtio-balloon", QEMU_ARCH_S390X },
53 { "virtio-balloon-pci", "virtio-balloon",
54 QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
55 { "virtio-blk-ccw", "virtio-blk", QEMU_ARCH_S390X },
56 { "virtio-blk-pci", "virtio-blk", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
57 { "virtio-gpu-ccw", "virtio-gpu", QEMU_ARCH_S390X },
58 { "virtio-gpu-pci", "virtio-gpu", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
59 { "virtio-input-host-ccw", "virtio-input-host", QEMU_ARCH_S390X },
60 { "virtio-input-host-pci", "virtio-input-host",
61 QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
62 { "virtio-keyboard-ccw", "virtio-keyboard", QEMU_ARCH_S390X },
63 { "virtio-keyboard-pci", "virtio-keyboard",
64 QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
65 { "virtio-mouse-ccw", "virtio-mouse", QEMU_ARCH_S390X },
66 { "virtio-mouse-pci", "virtio-mouse", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
67 { "virtio-net-ccw", "virtio-net", QEMU_ARCH_S390X },
68 { "virtio-net-pci", "virtio-net", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
69 { "virtio-rng-ccw", "virtio-rng", QEMU_ARCH_S390X },
70 { "virtio-rng-pci", "virtio-rng", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
71 { "virtio-scsi-ccw", "virtio-scsi", QEMU_ARCH_S390X },
72 { "virtio-scsi-pci", "virtio-scsi", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
73 { "virtio-serial-ccw", "virtio-serial", QEMU_ARCH_S390X },
74 { "virtio-serial-pci", "virtio-serial", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
75 { "virtio-tablet-ccw", "virtio-tablet", QEMU_ARCH_S390X },
76 { "virtio-tablet-pci", "virtio-tablet", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
80 static const char *qdev_class_get_alias(DeviceClass *dc)
82 const char *typename = object_class_get_name(OBJECT_CLASS(dc));
85 for (i = 0; qdev_alias_table[i].typename; i++) {
86 if (qdev_alias_table[i].arch_mask &&
87 !(qdev_alias_table[i].arch_mask & arch_type)) {
91 if (strcmp(qdev_alias_table[i].typename, typename) == 0) {
92 return qdev_alias_table[i].alias;
99 static bool qdev_class_has_alias(DeviceClass *dc)
101 return (qdev_class_get_alias(dc) != NULL);
104 static void qdev_print_devinfo(DeviceClass *dc)
106 error_printf("name \"%s\"", object_class_get_name(OBJECT_CLASS(dc)));
108 error_printf(", bus %s", dc->bus_type);
110 if (qdev_class_has_alias(dc)) {
111 error_printf(", alias \"%s\"", qdev_class_get_alias(dc));
114 error_printf(", desc \"%s\"", dc->desc);
116 if (dc->cannot_instantiate_with_device_add_yet) {
117 error_printf(", no-user");
122 static gint devinfo_cmp(gconstpointer a, gconstpointer b)
124 return strcasecmp(object_class_get_name((ObjectClass *)a),
125 object_class_get_name((ObjectClass *)b));
128 static void qdev_print_devinfos(bool show_no_user)
130 static const char *cat_name[DEVICE_CATEGORY_MAX + 1] = {
131 [DEVICE_CATEGORY_BRIDGE] = "Controller/Bridge/Hub",
132 [DEVICE_CATEGORY_USB] = "USB",
133 [DEVICE_CATEGORY_STORAGE] = "Storage",
134 [DEVICE_CATEGORY_NETWORK] = "Network",
135 [DEVICE_CATEGORY_INPUT] = "Input",
136 [DEVICE_CATEGORY_DISPLAY] = "Display",
137 [DEVICE_CATEGORY_SOUND] = "Sound",
138 [DEVICE_CATEGORY_MISC] = "Misc",
139 [DEVICE_CATEGORY_MAX] = "Uncategorized",
145 list = g_slist_sort(object_class_get_list(TYPE_DEVICE, false),
148 for (i = 0; i <= DEVICE_CATEGORY_MAX; i++) {
150 for (elt = list; elt; elt = elt->next) {
151 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
153 if ((i < DEVICE_CATEGORY_MAX
154 ? !test_bit(i, dc->categories)
155 : !bitmap_empty(dc->categories, DEVICE_CATEGORY_MAX))
157 && dc->cannot_instantiate_with_device_add_yet)) {
161 error_printf("%s%s devices:\n", i ? "\n" : "",
165 qdev_print_devinfo(dc);
172 static int set_property(void *opaque, const char *name, const char *value,
175 Object *obj = opaque;
178 if (strcmp(name, "driver") == 0)
180 if (strcmp(name, "bus") == 0)
183 object_property_parse(obj, value, name, &err);
185 error_propagate(errp, err);
191 static const char *find_typename_by_alias(const char *alias)
195 for (i = 0; qdev_alias_table[i].alias; i++) {
196 if (qdev_alias_table[i].arch_mask &&
197 !(qdev_alias_table[i].arch_mask & arch_type)) {
201 if (strcmp(qdev_alias_table[i].alias, alias) == 0) {
202 return qdev_alias_table[i].typename;
209 static DeviceClass *qdev_get_device_class(const char **driver, Error **errp)
213 const char *original_name = *driver;
215 oc = object_class_by_name(*driver);
217 const char *typename = find_typename_by_alias(*driver);
221 oc = object_class_by_name(*driver);
225 if (!object_class_dynamic_cast(oc, TYPE_DEVICE)) {
226 if (*driver != original_name) {
227 error_setg(errp, "'%s' (alias '%s') is not a valid device model"
228 " name", original_name, *driver);
230 error_setg(errp, "'%s' is not a valid device model name", *driver);
235 if (object_class_is_abstract(oc)) {
236 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
237 "non-abstract device type");
241 dc = DEVICE_CLASS(oc);
242 if (dc->cannot_instantiate_with_device_add_yet ||
243 (qdev_hotplug && !dc->hotpluggable)) {
244 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
245 "pluggable device type");
253 int qdev_device_help(QemuOpts *opts)
255 Error *local_err = NULL;
257 DevicePropertyInfoList *prop_list;
258 DevicePropertyInfoList *prop;
260 driver = qemu_opt_get(opts, "driver");
261 if (driver && is_help_option(driver)) {
262 qdev_print_devinfos(false);
266 if (!driver || !qemu_opt_has_help_opt(opts)) {
270 if (!object_class_by_name(driver)) {
271 const char *typename = find_typename_by_alias(driver);
278 prop_list = qmp_device_list_properties(driver, &local_err);
283 for (prop = prop_list; prop; prop = prop->next) {
284 error_printf("%s.%s=%s", driver,
287 if (prop->value->has_description) {
288 error_printf(" (%s)\n", prop->value->description);
294 qapi_free_DevicePropertyInfoList(prop_list);
298 error_report_err(local_err);
302 static Object *qdev_get_peripheral(void)
307 dev = container_get(qdev_get_machine(), "/peripheral");
313 static Object *qdev_get_peripheral_anon(void)
318 dev = container_get(qdev_get_machine(), "/peripheral-anon");
324 static void qbus_list_bus(DeviceState *dev, Error **errp)
327 const char *sep = " ";
329 error_append_hint(errp, "child buses at \"%s\":",
330 dev->id ? dev->id : object_get_typename(OBJECT(dev)));
331 QLIST_FOREACH(child, &dev->child_bus, sibling) {
332 error_append_hint(errp, "%s\"%s\"", sep, child->name);
335 error_append_hint(errp, "\n");
338 static void qbus_list_dev(BusState *bus, Error **errp)
341 const char *sep = " ";
343 error_append_hint(errp, "devices at \"%s\":", bus->name);
344 QTAILQ_FOREACH(kid, &bus->children, sibling) {
345 DeviceState *dev = kid->child;
346 error_append_hint(errp, "%s\"%s\"", sep,
347 object_get_typename(OBJECT(dev)));
349 error_append_hint(errp, "/\"%s\"", dev->id);
353 error_append_hint(errp, "\n");
356 static BusState *qbus_find_bus(DeviceState *dev, char *elem)
360 QLIST_FOREACH(child, &dev->child_bus, sibling) {
361 if (strcmp(child->name, elem) == 0) {
368 static DeviceState *qbus_find_dev(BusState *bus, char *elem)
373 * try to match in order:
374 * (1) instance id, if present
376 * (3) driver alias, if present
378 QTAILQ_FOREACH(kid, &bus->children, sibling) {
379 DeviceState *dev = kid->child;
380 if (dev->id && strcmp(dev->id, elem) == 0) {
384 QTAILQ_FOREACH(kid, &bus->children, sibling) {
385 DeviceState *dev = kid->child;
386 if (strcmp(object_get_typename(OBJECT(dev)), elem) == 0) {
390 QTAILQ_FOREACH(kid, &bus->children, sibling) {
391 DeviceState *dev = kid->child;
392 DeviceClass *dc = DEVICE_GET_CLASS(dev);
394 if (qdev_class_has_alias(dc) &&
395 strcmp(qdev_class_get_alias(dc), elem) == 0) {
402 static inline bool qbus_is_full(BusState *bus)
404 BusClass *bus_class = BUS_GET_CLASS(bus);
405 return bus_class->max_dev && bus->max_index >= bus_class->max_dev;
409 * Search the tree rooted at @bus for a bus.
410 * If @name, search for a bus with that name. Note that bus names
411 * need not be unique. Yes, that's screwed up.
412 * Else search for a bus that is a subtype of @bus_typename.
413 * If more than one exists, prefer one that can take another device.
414 * Return the bus if found, else %NULL.
416 static BusState *qbus_find_recursive(BusState *bus, const char *name,
417 const char *bus_typename)
420 BusState *pick, *child, *ret;
423 assert(name || bus_typename);
425 match = !strcmp(bus->name, name);
427 match = !!object_dynamic_cast(OBJECT(bus), bus_typename);
430 if (match && !qbus_is_full(bus)) {
431 return bus; /* root matches and isn't full */
434 pick = match ? bus : NULL;
436 QTAILQ_FOREACH(kid, &bus->children, sibling) {
437 DeviceState *dev = kid->child;
438 QLIST_FOREACH(child, &dev->child_bus, sibling) {
439 ret = qbus_find_recursive(child, name, bus_typename);
440 if (ret && !qbus_is_full(ret)) {
441 return ret; /* a descendant matches and isn't full */
449 /* root or a descendant matches, but is full */
453 static BusState *qbus_find(const char *path, Error **errp)
460 /* find start element */
461 if (path[0] == '/') {
462 bus = sysbus_get_default();
465 if (sscanf(path, "%127[^/]%n", elem, &len) != 1) {
469 bus = qbus_find_recursive(sysbus_get_default(), elem, NULL);
471 error_setg(errp, "Bus '%s' not found", elem);
478 assert(path[pos] == '/' || !path[pos]);
479 while (path[pos] == '/') {
482 if (path[pos] == '\0') {
487 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
488 g_assert_not_reached();
492 dev = qbus_find_dev(bus, elem);
494 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
495 "Device '%s' not found", elem);
496 qbus_list_dev(bus, errp);
500 assert(path[pos] == '/' || !path[pos]);
501 while (path[pos] == '/') {
504 if (path[pos] == '\0') {
505 /* last specified element is a device. If it has exactly
506 * one child bus accept it nevertheless */
507 if (dev->num_child_bus == 1) {
508 bus = QLIST_FIRST(&dev->child_bus);
511 if (dev->num_child_bus) {
512 error_setg(errp, "Device '%s' has multiple child buses",
514 qbus_list_bus(dev, errp);
516 error_setg(errp, "Device '%s' has no child bus", elem);
522 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
523 g_assert_not_reached();
527 bus = qbus_find_bus(dev, elem);
529 error_setg(errp, "Bus '%s' not found", elem);
530 qbus_list_bus(dev, errp);
535 if (qbus_is_full(bus)) {
536 error_setg(errp, "Bus '%s' is full", path);
542 void qdev_set_id(DeviceState *dev, const char *id)
549 object_property_add_child(qdev_get_peripheral(), dev->id,
552 static int anon_count;
553 gchar *name = g_strdup_printf("device[%d]", anon_count++);
554 object_property_add_child(qdev_get_peripheral_anon(), name,
560 DeviceState *qdev_device_add(QemuOpts *opts, Error **errp)
563 const char *driver, *path;
565 BusState *bus = NULL;
568 driver = qemu_opt_get(opts, "driver");
570 error_setg(errp, QERR_MISSING_PARAMETER, "driver");
575 dc = qdev_get_device_class(&driver, errp);
581 path = qemu_opt_get(opts, "bus");
583 bus = qbus_find(path, errp);
587 if (!object_dynamic_cast(OBJECT(bus), dc->bus_type)) {
588 error_setg(errp, "Device '%s' can't go on %s bus",
589 driver, object_get_typename(OBJECT(bus)));
592 } else if (dc->bus_type != NULL) {
593 bus = qbus_find_recursive(sysbus_get_default(), NULL, dc->bus_type);
594 if (!bus || qbus_is_full(bus)) {
595 error_setg(errp, "No '%s' bus found for device '%s'",
596 dc->bus_type, driver);
600 if (qdev_hotplug && bus && !qbus_is_hotpluggable(bus)) {
601 error_setg(errp, QERR_BUS_NO_HOTPLUG, bus->name);
606 dev = DEVICE(object_new(driver));
609 qdev_set_parent_bus(dev, bus);
612 qdev_set_id(dev, qemu_opts_id(opts));
615 if (qemu_opt_foreach(opts, set_property, dev, &err)) {
616 error_propagate(errp, err);
617 object_unparent(OBJECT(dev));
618 object_unref(OBJECT(dev));
623 object_property_set_bool(OBJECT(dev), true, "realized", &err);
625 error_propagate(errp, err);
627 object_unparent(OBJECT(dev));
628 object_unref(OBJECT(dev));
635 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
636 static void qbus_print(Monitor *mon, BusState *bus, int indent);
638 static void qdev_print_props(Monitor *mon, DeviceState *dev, Property *props,
643 for (; props->name; props++) {
646 char *legacy_name = g_strdup_printf("legacy-%s", props->name);
647 if (object_property_get_type(OBJECT(dev), legacy_name, NULL)) {
648 value = object_property_get_str(OBJECT(dev), legacy_name, &err);
650 value = object_property_print(OBJECT(dev), props->name, true, &err);
658 qdev_printf("%s = %s\n", props->name,
659 value && *value ? value : "<null>");
664 static void bus_print_dev(BusState *bus, Monitor *mon, DeviceState *dev, int indent)
666 BusClass *bc = BUS_GET_CLASS(bus);
669 bc->print_dev(mon, dev, indent);
673 static void qdev_print(Monitor *mon, DeviceState *dev, int indent)
679 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev)),
680 dev->id ? dev->id : "");
682 QLIST_FOREACH(ngl, &dev->gpios, node) {
684 qdev_printf("gpio-in \"%s\" %d\n", ngl->name ? ngl->name : "",
688 qdev_printf("gpio-out \"%s\" %d\n", ngl->name ? ngl->name : "",
692 class = object_get_class(OBJECT(dev));
694 qdev_print_props(mon, dev, DEVICE_CLASS(class)->props, indent);
695 class = object_class_get_parent(class);
696 } while (class != object_class_by_name(TYPE_DEVICE));
697 bus_print_dev(dev->parent_bus, mon, dev, indent);
698 QLIST_FOREACH(child, &dev->child_bus, sibling) {
699 qbus_print(mon, child, indent);
703 static void qbus_print(Monitor *mon, BusState *bus, int indent)
707 qdev_printf("bus: %s\n", bus->name);
709 qdev_printf("type %s\n", object_get_typename(OBJECT(bus)));
710 QTAILQ_FOREACH(kid, &bus->children, sibling) {
711 DeviceState *dev = kid->child;
712 qdev_print(mon, dev, indent);
717 void hmp_info_qtree(Monitor *mon, const QDict *qdict)
719 if (sysbus_get_default())
720 qbus_print(mon, sysbus_get_default(), 0);
723 void hmp_info_qdm(Monitor *mon, const QDict *qdict)
725 qdev_print_devinfos(true);
728 typedef struct QOMCompositionState {
731 } QOMCompositionState;
733 static void print_qom_composition(Monitor *mon, Object *obj, int indent);
735 static int print_qom_composition_child(Object *obj, void *opaque)
737 QOMCompositionState *s = opaque;
739 print_qom_composition(s->mon, obj, s->indent);
744 static void print_qom_composition(Monitor *mon, Object *obj, int indent)
746 QOMCompositionState s = {
748 .indent = indent + 2,
752 if (obj == object_get_root()) {
755 name = object_get_canonical_path_component(obj);
757 monitor_printf(mon, "%*s/%s (%s)\n", indent, "", name,
758 object_get_typename(obj));
760 object_child_foreach(obj, print_qom_composition_child, &s);
763 void hmp_info_qom_tree(Monitor *mon, const QDict *dict)
765 const char *path = qdict_get_try_str(dict, "path");
767 bool ambiguous = false;
770 obj = object_resolve_path(path, &ambiguous);
772 monitor_printf(mon, "Path '%s' could not be resolved.\n", path);
776 monitor_printf(mon, "Warning: Path '%s' is ambiguous.\n", path);
780 obj = qdev_get_machine();
782 print_qom_composition(mon, obj, 0);
785 void qmp_device_add(QDict *qdict, QObject **ret_data, Error **errp)
787 Error *local_err = NULL;
791 opts = qemu_opts_from_qdict(qemu_find_opts("device"), qdict, &local_err);
793 error_propagate(errp, local_err);
796 if (!monitor_cur_is_qmp() && qdev_device_help(opts)) {
800 dev = qdev_device_add(opts, &local_err);
802 error_propagate(errp, local_err);
806 object_unref(OBJECT(dev));
809 static DeviceState *find_device_state(const char *id, Error **errp)
814 obj = object_resolve_path(id, NULL);
816 char *root_path = object_get_canonical_path(qdev_get_peripheral());
817 char *path = g_strdup_printf("%s/%s", root_path, id);
820 obj = object_resolve_path_type(path, TYPE_DEVICE, NULL);
825 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
826 "Device '%s' not found", id);
830 if (!object_dynamic_cast(obj, TYPE_DEVICE)) {
831 error_setg(errp, "%s is not a hotpluggable device", id);
838 void qmp_device_del(const char *id, Error **errp)
840 DeviceState *dev = find_device_state(id, errp);
842 qdev_unplug(dev, errp);
846 BlockBackend *blk_by_qdev_id(const char *id, Error **errp)
851 dev = find_device_state(id, errp);
856 blk = blk_by_dev(dev);
858 error_setg(errp, "Device does not have a block device backend");
863 void qdev_machine_init(void)
865 qdev_get_peripheral_anon();
866 qdev_get_peripheral();
869 QemuOptsList qemu_device_opts = {
871 .implied_opt_name = "driver",
872 .head = QTAILQ_HEAD_INITIALIZER(qemu_device_opts.head),
875 * no elements => accept any
876 * sanity checking will happen later
877 * when setting device properties
879 { /* end of list */ }
883 QemuOptsList qemu_global_opts = {
885 .head = QTAILQ_HEAD_INITIALIZER(qemu_global_opts.head),
889 .type = QEMU_OPT_STRING,
892 .type = QEMU_OPT_STRING,
895 .type = QEMU_OPT_STRING,
897 { /* end of list */ }
901 int qemu_global_option(const char *str)
903 char driver[64], property[64];
907 rc = sscanf(str, "%63[^.=].%63[^=]%n", driver, property, &offset);
908 if (rc == 2 && str[offset] == '=') {
909 opts = qemu_opts_create(&qemu_global_opts, NULL, 0, &error_abort);
910 qemu_opt_set(opts, "driver", driver, &error_abort);
911 qemu_opt_set(opts, "property", property, &error_abort);
912 qemu_opt_set(opts, "value", str + offset + 1, &error_abort);
916 opts = qemu_opts_parse_noisily(&qemu_global_opts, str, false);