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 "sysemu/arch_init.h"
26 #include "qapi/error.h"
27 #include "qapi/qapi-commands-misc.h"
28 #include "qapi/qmp/qdict.h"
29 #include "qapi/qmp/qerror.h"
30 #include "qemu/config-file.h"
31 #include "qemu/error-report.h"
32 #include "qemu/help_option.h"
33 #include "qemu/option.h"
34 #include "sysemu/block-backend.h"
35 #include "migration/misc.h"
38 * Aliases were a bad idea from the start. Let's keep them
39 * from spreading further.
41 typedef struct QDevAlias
48 /* Please keep this table sorted by typename. */
49 static const QDevAlias qdev_alias_table[] = {
50 { "e1000", "e1000-82540em" },
51 { "ich9-ahci", "ahci" },
52 { "lsi53c895a", "lsi" },
53 { "virtio-9p-ccw", "virtio-9p", QEMU_ARCH_S390X },
54 { "virtio-9p-pci", "virtio-9p", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
55 { "virtio-balloon-ccw", "virtio-balloon", QEMU_ARCH_S390X },
56 { "virtio-balloon-pci", "virtio-balloon",
57 QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
58 { "virtio-blk-ccw", "virtio-blk", QEMU_ARCH_S390X },
59 { "virtio-blk-pci", "virtio-blk", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
60 { "virtio-gpu-ccw", "virtio-gpu", QEMU_ARCH_S390X },
61 { "virtio-gpu-pci", "virtio-gpu", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
62 { "virtio-input-host-ccw", "virtio-input-host", QEMU_ARCH_S390X },
63 { "virtio-input-host-pci", "virtio-input-host",
64 QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
65 { "virtio-keyboard-ccw", "virtio-keyboard", QEMU_ARCH_S390X },
66 { "virtio-keyboard-pci", "virtio-keyboard",
67 QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
68 { "virtio-mouse-ccw", "virtio-mouse", QEMU_ARCH_S390X },
69 { "virtio-mouse-pci", "virtio-mouse", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
70 { "virtio-net-ccw", "virtio-net", QEMU_ARCH_S390X },
71 { "virtio-net-pci", "virtio-net", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
72 { "virtio-rng-ccw", "virtio-rng", QEMU_ARCH_S390X },
73 { "virtio-rng-pci", "virtio-rng", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
74 { "virtio-scsi-ccw", "virtio-scsi", QEMU_ARCH_S390X },
75 { "virtio-scsi-pci", "virtio-scsi", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
76 { "virtio-serial-ccw", "virtio-serial", QEMU_ARCH_S390X },
77 { "virtio-serial-pci", "virtio-serial", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
78 { "virtio-tablet-ccw", "virtio-tablet", QEMU_ARCH_S390X },
79 { "virtio-tablet-pci", "virtio-tablet", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
83 static const char *qdev_class_get_alias(DeviceClass *dc)
85 const char *typename = object_class_get_name(OBJECT_CLASS(dc));
88 for (i = 0; qdev_alias_table[i].typename; i++) {
89 if (qdev_alias_table[i].arch_mask &&
90 !(qdev_alias_table[i].arch_mask & arch_type)) {
94 if (strcmp(qdev_alias_table[i].typename, typename) == 0) {
95 return qdev_alias_table[i].alias;
102 static bool qdev_class_has_alias(DeviceClass *dc)
104 return (qdev_class_get_alias(dc) != NULL);
107 static void qdev_print_devinfo(DeviceClass *dc)
109 error_printf("name \"%s\"", object_class_get_name(OBJECT_CLASS(dc)));
111 error_printf(", bus %s", dc->bus_type);
113 if (qdev_class_has_alias(dc)) {
114 error_printf(", alias \"%s\"", qdev_class_get_alias(dc));
117 error_printf(", desc \"%s\"", dc->desc);
119 if (!dc->user_creatable) {
120 error_printf(", no-user");
125 static void qdev_print_devinfos(bool show_no_user)
127 static const char *cat_name[DEVICE_CATEGORY_MAX + 1] = {
128 [DEVICE_CATEGORY_BRIDGE] = "Controller/Bridge/Hub",
129 [DEVICE_CATEGORY_USB] = "USB",
130 [DEVICE_CATEGORY_STORAGE] = "Storage",
131 [DEVICE_CATEGORY_NETWORK] = "Network",
132 [DEVICE_CATEGORY_INPUT] = "Input",
133 [DEVICE_CATEGORY_DISPLAY] = "Display",
134 [DEVICE_CATEGORY_SOUND] = "Sound",
135 [DEVICE_CATEGORY_MISC] = "Misc",
136 [DEVICE_CATEGORY_CPU] = "CPU",
137 [DEVICE_CATEGORY_MAX] = "Uncategorized",
143 list = object_class_get_list_sorted(TYPE_DEVICE, false);
145 for (i = 0; i <= DEVICE_CATEGORY_MAX; i++) {
147 for (elt = list; elt; elt = elt->next) {
148 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
150 if ((i < DEVICE_CATEGORY_MAX
151 ? !test_bit(i, dc->categories)
152 : !bitmap_empty(dc->categories, DEVICE_CATEGORY_MAX))
154 && !dc->user_creatable)) {
158 error_printf("%s%s devices:\n", i ? "\n" : "",
162 qdev_print_devinfo(dc);
169 static int set_property(void *opaque, const char *name, const char *value,
172 Object *obj = opaque;
175 if (strcmp(name, "driver") == 0)
177 if (strcmp(name, "bus") == 0)
180 object_property_parse(obj, value, name, &err);
182 error_propagate(errp, err);
188 static const char *find_typename_by_alias(const char *alias)
192 for (i = 0; qdev_alias_table[i].alias; i++) {
193 if (qdev_alias_table[i].arch_mask &&
194 !(qdev_alias_table[i].arch_mask & arch_type)) {
198 if (strcmp(qdev_alias_table[i].alias, alias) == 0) {
199 return qdev_alias_table[i].typename;
206 static DeviceClass *qdev_get_device_class(const char **driver, Error **errp)
210 const char *original_name = *driver;
212 oc = object_class_by_name(*driver);
214 const char *typename = find_typename_by_alias(*driver);
218 oc = object_class_by_name(*driver);
222 if (!object_class_dynamic_cast(oc, TYPE_DEVICE)) {
223 if (*driver != original_name) {
224 error_setg(errp, "'%s' (alias '%s') is not a valid device model"
225 " name", original_name, *driver);
227 error_setg(errp, "'%s' is not a valid device model name", *driver);
232 if (object_class_is_abstract(oc)) {
233 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
234 "non-abstract device type");
238 dc = DEVICE_CLASS(oc);
239 if (!dc->user_creatable ||
240 (qdev_hotplug && !dc->hotpluggable)) {
241 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
242 "pluggable device type");
250 int qdev_device_help(QemuOpts *opts)
252 Error *local_err = NULL;
254 ObjectPropertyInfoList *prop_list;
255 ObjectPropertyInfoList *prop;
257 driver = qemu_opt_get(opts, "driver");
258 if (driver && is_help_option(driver)) {
259 qdev_print_devinfos(false);
263 if (!driver || !qemu_opt_has_help_opt(opts)) {
267 if (!object_class_by_name(driver)) {
268 const char *typename = find_typename_by_alias(driver);
275 prop_list = qmp_device_list_properties(driver, &local_err);
280 for (prop = prop_list; prop; prop = prop->next) {
281 error_printf("%s.%s=%s", driver,
284 if (prop->value->has_description) {
285 error_printf(" (%s)\n", prop->value->description);
291 qapi_free_ObjectPropertyInfoList(prop_list);
295 error_report_err(local_err);
299 static Object *qdev_get_peripheral(void)
304 dev = container_get(qdev_get_machine(), "/peripheral");
310 static Object *qdev_get_peripheral_anon(void)
315 dev = container_get(qdev_get_machine(), "/peripheral-anon");
321 static void qbus_list_bus(DeviceState *dev, Error **errp)
324 const char *sep = " ";
326 error_append_hint(errp, "child buses at \"%s\":",
327 dev->id ? dev->id : object_get_typename(OBJECT(dev)));
328 QLIST_FOREACH(child, &dev->child_bus, sibling) {
329 error_append_hint(errp, "%s\"%s\"", sep, child->name);
332 error_append_hint(errp, "\n");
335 static void qbus_list_dev(BusState *bus, Error **errp)
338 const char *sep = " ";
340 error_append_hint(errp, "devices at \"%s\":", bus->name);
341 QTAILQ_FOREACH(kid, &bus->children, sibling) {
342 DeviceState *dev = kid->child;
343 error_append_hint(errp, "%s\"%s\"", sep,
344 object_get_typename(OBJECT(dev)));
346 error_append_hint(errp, "/\"%s\"", dev->id);
350 error_append_hint(errp, "\n");
353 static BusState *qbus_find_bus(DeviceState *dev, char *elem)
357 QLIST_FOREACH(child, &dev->child_bus, sibling) {
358 if (strcmp(child->name, elem) == 0) {
365 static DeviceState *qbus_find_dev(BusState *bus, char *elem)
370 * try to match in order:
371 * (1) instance id, if present
373 * (3) driver alias, if present
375 QTAILQ_FOREACH(kid, &bus->children, sibling) {
376 DeviceState *dev = kid->child;
377 if (dev->id && strcmp(dev->id, elem) == 0) {
381 QTAILQ_FOREACH(kid, &bus->children, sibling) {
382 DeviceState *dev = kid->child;
383 if (strcmp(object_get_typename(OBJECT(dev)), elem) == 0) {
387 QTAILQ_FOREACH(kid, &bus->children, sibling) {
388 DeviceState *dev = kid->child;
389 DeviceClass *dc = DEVICE_GET_CLASS(dev);
391 if (qdev_class_has_alias(dc) &&
392 strcmp(qdev_class_get_alias(dc), elem) == 0) {
399 static inline bool qbus_is_full(BusState *bus)
401 BusClass *bus_class = BUS_GET_CLASS(bus);
402 return bus_class->max_dev && bus->max_index >= bus_class->max_dev;
406 * Search the tree rooted at @bus for a bus.
407 * If @name, search for a bus with that name. Note that bus names
408 * need not be unique. Yes, that's screwed up.
409 * Else search for a bus that is a subtype of @bus_typename.
410 * If more than one exists, prefer one that can take another device.
411 * Return the bus if found, else %NULL.
413 static BusState *qbus_find_recursive(BusState *bus, const char *name,
414 const char *bus_typename)
417 BusState *pick, *child, *ret;
420 assert(name || bus_typename);
422 match = !strcmp(bus->name, name);
424 match = !!object_dynamic_cast(OBJECT(bus), bus_typename);
427 if (match && !qbus_is_full(bus)) {
428 return bus; /* root matches and isn't full */
431 pick = match ? bus : NULL;
433 QTAILQ_FOREACH(kid, &bus->children, sibling) {
434 DeviceState *dev = kid->child;
435 QLIST_FOREACH(child, &dev->child_bus, sibling) {
436 ret = qbus_find_recursive(child, name, bus_typename);
437 if (ret && !qbus_is_full(ret)) {
438 return ret; /* a descendant matches and isn't full */
446 /* root or a descendant matches, but is full */
450 static BusState *qbus_find(const char *path, Error **errp)
457 /* find start element */
458 if (path[0] == '/') {
459 bus = sysbus_get_default();
462 if (sscanf(path, "%127[^/]%n", elem, &len) != 1) {
466 bus = qbus_find_recursive(sysbus_get_default(), elem, NULL);
468 error_setg(errp, "Bus '%s' not found", elem);
475 assert(path[pos] == '/' || !path[pos]);
476 while (path[pos] == '/') {
479 if (path[pos] == '\0') {
484 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
485 g_assert_not_reached();
489 dev = qbus_find_dev(bus, elem);
491 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
492 "Device '%s' not found", elem);
493 qbus_list_dev(bus, errp);
497 assert(path[pos] == '/' || !path[pos]);
498 while (path[pos] == '/') {
501 if (path[pos] == '\0') {
502 /* last specified element is a device. If it has exactly
503 * one child bus accept it nevertheless */
504 if (dev->num_child_bus == 1) {
505 bus = QLIST_FIRST(&dev->child_bus);
508 if (dev->num_child_bus) {
509 error_setg(errp, "Device '%s' has multiple child buses",
511 qbus_list_bus(dev, errp);
513 error_setg(errp, "Device '%s' has no child bus", elem);
519 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
520 g_assert_not_reached();
524 bus = qbus_find_bus(dev, elem);
526 error_setg(errp, "Bus '%s' not found", elem);
527 qbus_list_bus(dev, errp);
532 if (qbus_is_full(bus)) {
533 error_setg(errp, "Bus '%s' is full", path);
539 void qdev_set_id(DeviceState *dev, const char *id)
546 object_property_add_child(qdev_get_peripheral(), dev->id,
549 static int anon_count;
550 gchar *name = g_strdup_printf("device[%d]", anon_count++);
551 object_property_add_child(qdev_get_peripheral_anon(), name,
557 DeviceState *qdev_device_add(QemuOpts *opts, Error **errp)
560 const char *driver, *path;
562 BusState *bus = NULL;
565 driver = qemu_opt_get(opts, "driver");
567 error_setg(errp, QERR_MISSING_PARAMETER, "driver");
572 dc = qdev_get_device_class(&driver, errp);
578 path = qemu_opt_get(opts, "bus");
580 bus = qbus_find(path, errp);
584 if (!object_dynamic_cast(OBJECT(bus), dc->bus_type)) {
585 error_setg(errp, "Device '%s' can't go on %s bus",
586 driver, object_get_typename(OBJECT(bus)));
589 } else if (dc->bus_type != NULL) {
590 bus = qbus_find_recursive(sysbus_get_default(), NULL, dc->bus_type);
591 if (!bus || qbus_is_full(bus)) {
592 error_setg(errp, "No '%s' bus found for device '%s'",
593 dc->bus_type, driver);
597 if (qdev_hotplug && bus && !qbus_is_hotpluggable(bus)) {
598 error_setg(errp, QERR_BUS_NO_HOTPLUG, bus->name);
602 if (!migration_is_idle()) {
603 error_setg(errp, "device_add not allowed while migrating");
608 dev = DEVICE(object_new(driver));
611 qdev_set_parent_bus(dev, bus);
612 } else if (qdev_hotplug && !qdev_get_machine_hotplug_handler(dev)) {
613 /* No bus, no machine hotplug handler --> device is not hotpluggable */
614 error_setg(&err, "Device '%s' can not be hotplugged on this machine",
619 qdev_set_id(dev, qemu_opts_id(opts));
622 if (qemu_opt_foreach(opts, set_property, dev, &err)) {
627 object_property_set_bool(OBJECT(dev), true, "realized", &err);
635 error_propagate(errp, err);
636 object_unparent(OBJECT(dev));
637 object_unref(OBJECT(dev));
642 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
643 static void qbus_print(Monitor *mon, BusState *bus, int indent);
645 static void qdev_print_props(Monitor *mon, DeviceState *dev, Property *props,
650 for (; props->name; props++) {
653 char *legacy_name = g_strdup_printf("legacy-%s", props->name);
654 if (object_property_get_type(OBJECT(dev), legacy_name, NULL)) {
655 value = object_property_get_str(OBJECT(dev), legacy_name, &err);
657 value = object_property_print(OBJECT(dev), props->name, true, &err);
665 qdev_printf("%s = %s\n", props->name,
666 value && *value ? value : "<null>");
671 static void bus_print_dev(BusState *bus, Monitor *mon, DeviceState *dev, int indent)
673 BusClass *bc = BUS_GET_CLASS(bus);
676 bc->print_dev(mon, dev, indent);
680 static void qdev_print(Monitor *mon, DeviceState *dev, int indent)
686 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev)),
687 dev->id ? dev->id : "");
689 QLIST_FOREACH(ngl, &dev->gpios, node) {
691 qdev_printf("gpio-in \"%s\" %d\n", ngl->name ? ngl->name : "",
695 qdev_printf("gpio-out \"%s\" %d\n", ngl->name ? ngl->name : "",
699 class = object_get_class(OBJECT(dev));
701 qdev_print_props(mon, dev, DEVICE_CLASS(class)->props, indent);
702 class = object_class_get_parent(class);
703 } while (class != object_class_by_name(TYPE_DEVICE));
704 bus_print_dev(dev->parent_bus, mon, dev, indent);
705 QLIST_FOREACH(child, &dev->child_bus, sibling) {
706 qbus_print(mon, child, indent);
710 static void qbus_print(Monitor *mon, BusState *bus, int indent)
714 qdev_printf("bus: %s\n", bus->name);
716 qdev_printf("type %s\n", object_get_typename(OBJECT(bus)));
717 QTAILQ_FOREACH(kid, &bus->children, sibling) {
718 DeviceState *dev = kid->child;
719 qdev_print(mon, dev, indent);
724 void hmp_info_qtree(Monitor *mon, const QDict *qdict)
726 if (sysbus_get_default())
727 qbus_print(mon, sysbus_get_default(), 0);
730 void hmp_info_qdm(Monitor *mon, const QDict *qdict)
732 qdev_print_devinfos(true);
735 typedef struct QOMCompositionState {
738 } QOMCompositionState;
740 static void print_qom_composition(Monitor *mon, Object *obj, int indent);
742 static int print_qom_composition_child(Object *obj, void *opaque)
744 QOMCompositionState *s = opaque;
746 print_qom_composition(s->mon, obj, s->indent);
751 static void print_qom_composition(Monitor *mon, Object *obj, int indent)
753 QOMCompositionState s = {
755 .indent = indent + 2,
759 if (obj == object_get_root()) {
762 name = object_get_canonical_path_component(obj);
764 monitor_printf(mon, "%*s/%s (%s)\n", indent, "", name,
765 object_get_typename(obj));
767 object_child_foreach(obj, print_qom_composition_child, &s);
770 void hmp_info_qom_tree(Monitor *mon, const QDict *dict)
772 const char *path = qdict_get_try_str(dict, "path");
774 bool ambiguous = false;
777 obj = object_resolve_path(path, &ambiguous);
779 monitor_printf(mon, "Path '%s' could not be resolved.\n", path);
783 monitor_printf(mon, "Warning: Path '%s' is ambiguous.\n", path);
787 obj = qdev_get_machine();
789 print_qom_composition(mon, obj, 0);
792 void qmp_device_add(QDict *qdict, QObject **ret_data, Error **errp)
794 Error *local_err = NULL;
798 opts = qemu_opts_from_qdict(qemu_find_opts("device"), qdict, &local_err);
800 error_propagate(errp, local_err);
803 if (!monitor_cur_is_qmp() && qdev_device_help(opts)) {
807 dev = qdev_device_add(opts, &local_err);
809 error_propagate(errp, local_err);
813 object_unref(OBJECT(dev));
816 static DeviceState *find_device_state(const char *id, Error **errp)
821 obj = object_resolve_path(id, NULL);
823 char *root_path = object_get_canonical_path(qdev_get_peripheral());
824 char *path = g_strdup_printf("%s/%s", root_path, id);
827 obj = object_resolve_path_type(path, TYPE_DEVICE, NULL);
832 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
833 "Device '%s' not found", id);
837 if (!object_dynamic_cast(obj, TYPE_DEVICE)) {
838 error_setg(errp, "%s is not a hotpluggable device", id);
845 void qdev_unplug(DeviceState *dev, Error **errp)
847 DeviceClass *dc = DEVICE_GET_CLASS(dev);
848 HotplugHandler *hotplug_ctrl;
849 HotplugHandlerClass *hdc;
851 if (dev->parent_bus && !qbus_is_hotpluggable(dev->parent_bus)) {
852 error_setg(errp, QERR_BUS_NO_HOTPLUG, dev->parent_bus->name);
856 if (!dc->hotpluggable) {
857 error_setg(errp, QERR_DEVICE_NO_HOTPLUG,
858 object_get_typename(OBJECT(dev)));
862 if (!migration_is_idle()) {
863 error_setg(errp, "device_del not allowed while migrating");
867 qdev_hot_removed = true;
869 hotplug_ctrl = qdev_get_hotplug_handler(dev);
870 /* hotpluggable device MUST have HotplugHandler, if it doesn't
871 * then something is very wrong with it */
872 g_assert(hotplug_ctrl);
874 /* If device supports async unplug just request it to be done,
875 * otherwise just remove it synchronously */
876 hdc = HOTPLUG_HANDLER_GET_CLASS(hotplug_ctrl);
877 if (hdc->unplug_request) {
878 hotplug_handler_unplug_request(hotplug_ctrl, dev, errp);
880 hotplug_handler_unplug(hotplug_ctrl, dev, errp);
884 void qmp_device_del(const char *id, Error **errp)
886 DeviceState *dev = find_device_state(id, errp);
888 qdev_unplug(dev, errp);
892 BlockBackend *blk_by_qdev_id(const char *id, Error **errp)
897 dev = find_device_state(id, errp);
902 blk = blk_by_dev(dev);
904 error_setg(errp, "Device does not have a block device backend");
909 void qdev_machine_init(void)
911 qdev_get_peripheral_anon();
912 qdev_get_peripheral();
915 QemuOptsList qemu_device_opts = {
917 .implied_opt_name = "driver",
918 .head = QTAILQ_HEAD_INITIALIZER(qemu_device_opts.head),
921 * no elements => accept any
922 * sanity checking will happen later
923 * when setting device properties
925 { /* end of list */ }
929 QemuOptsList qemu_global_opts = {
931 .head = QTAILQ_HEAD_INITIALIZER(qemu_global_opts.head),
935 .type = QEMU_OPT_STRING,
938 .type = QEMU_OPT_STRING,
941 .type = QEMU_OPT_STRING,
943 { /* end of list */ }
947 int qemu_global_option(const char *str)
949 char driver[64], property[64];
953 rc = sscanf(str, "%63[^.=].%63[^=]%n", driver, property, &offset);
954 if (rc == 2 && str[offset] == '=') {
955 opts = qemu_opts_create(&qemu_global_opts, NULL, 0, &error_abort);
956 qemu_opt_set(opts, "driver", driver, &error_abort);
957 qemu_opt_set(opts, "property", property, &error_abort);
958 qemu_opt_set(opts, "value", str + offset + 1, &error_abort);
962 opts = qemu_opts_parse_noisily(&qemu_global_opts, str, false);