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/error.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 "sysemu/block-backend.h"
34 #include "migration/misc.h"
37 * Aliases were a bad idea from the start. Let's keep them
38 * from spreading further.
40 typedef struct QDevAlias
47 /* Please keep this table sorted by typename. */
48 static const QDevAlias qdev_alias_table[] = {
49 { "e1000", "e1000-82540em" },
50 { "ich9-ahci", "ahci" },
51 { "lsi53c895a", "lsi" },
52 { "virtio-9p-ccw", "virtio-9p", QEMU_ARCH_S390X },
53 { "virtio-9p-pci", "virtio-9p", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
54 { "virtio-balloon-ccw", "virtio-balloon", QEMU_ARCH_S390X },
55 { "virtio-balloon-pci", "virtio-balloon",
56 QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
57 { "virtio-blk-ccw", "virtio-blk", QEMU_ARCH_S390X },
58 { "virtio-blk-pci", "virtio-blk", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
59 { "virtio-gpu-ccw", "virtio-gpu", QEMU_ARCH_S390X },
60 { "virtio-gpu-pci", "virtio-gpu", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
61 { "virtio-input-host-ccw", "virtio-input-host", QEMU_ARCH_S390X },
62 { "virtio-input-host-pci", "virtio-input-host",
63 QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
64 { "virtio-keyboard-ccw", "virtio-keyboard", QEMU_ARCH_S390X },
65 { "virtio-keyboard-pci", "virtio-keyboard",
66 QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
67 { "virtio-mouse-ccw", "virtio-mouse", QEMU_ARCH_S390X },
68 { "virtio-mouse-pci", "virtio-mouse", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
69 { "virtio-net-ccw", "virtio-net", QEMU_ARCH_S390X },
70 { "virtio-net-pci", "virtio-net", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
71 { "virtio-rng-ccw", "virtio-rng", QEMU_ARCH_S390X },
72 { "virtio-rng-pci", "virtio-rng", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
73 { "virtio-scsi-ccw", "virtio-scsi", QEMU_ARCH_S390X },
74 { "virtio-scsi-pci", "virtio-scsi", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
75 { "virtio-serial-ccw", "virtio-serial", QEMU_ARCH_S390X },
76 { "virtio-serial-pci", "virtio-serial", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
77 { "virtio-tablet-ccw", "virtio-tablet", QEMU_ARCH_S390X },
78 { "virtio-tablet-pci", "virtio-tablet", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
82 static const char *qdev_class_get_alias(DeviceClass *dc)
84 const char *typename = object_class_get_name(OBJECT_CLASS(dc));
87 for (i = 0; qdev_alias_table[i].typename; i++) {
88 if (qdev_alias_table[i].arch_mask &&
89 !(qdev_alias_table[i].arch_mask & arch_type)) {
93 if (strcmp(qdev_alias_table[i].typename, typename) == 0) {
94 return qdev_alias_table[i].alias;
101 static bool qdev_class_has_alias(DeviceClass *dc)
103 return (qdev_class_get_alias(dc) != NULL);
106 static void qdev_print_devinfo(DeviceClass *dc)
108 error_printf("name \"%s\"", object_class_get_name(OBJECT_CLASS(dc)));
110 error_printf(", bus %s", dc->bus_type);
112 if (qdev_class_has_alias(dc)) {
113 error_printf(", alias \"%s\"", qdev_class_get_alias(dc));
116 error_printf(", desc \"%s\"", dc->desc);
118 if (!dc->user_creatable) {
119 error_printf(", no-user");
124 static gint devinfo_cmp(gconstpointer a, gconstpointer b)
126 return strcasecmp(object_class_get_name((ObjectClass *)a),
127 object_class_get_name((ObjectClass *)b));
130 static void qdev_print_devinfos(bool show_no_user)
132 static const char *cat_name[DEVICE_CATEGORY_MAX + 1] = {
133 [DEVICE_CATEGORY_BRIDGE] = "Controller/Bridge/Hub",
134 [DEVICE_CATEGORY_USB] = "USB",
135 [DEVICE_CATEGORY_STORAGE] = "Storage",
136 [DEVICE_CATEGORY_NETWORK] = "Network",
137 [DEVICE_CATEGORY_INPUT] = "Input",
138 [DEVICE_CATEGORY_DISPLAY] = "Display",
139 [DEVICE_CATEGORY_SOUND] = "Sound",
140 [DEVICE_CATEGORY_MISC] = "Misc",
141 [DEVICE_CATEGORY_CPU] = "CPU",
142 [DEVICE_CATEGORY_MAX] = "Uncategorized",
148 list = g_slist_sort(object_class_get_list(TYPE_DEVICE, false),
151 for (i = 0; i <= DEVICE_CATEGORY_MAX; i++) {
153 for (elt = list; elt; elt = elt->next) {
154 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
156 if ((i < DEVICE_CATEGORY_MAX
157 ? !test_bit(i, dc->categories)
158 : !bitmap_empty(dc->categories, DEVICE_CATEGORY_MAX))
160 && !dc->user_creatable)) {
164 error_printf("%s%s devices:\n", i ? "\n" : "",
168 qdev_print_devinfo(dc);
175 static int set_property(void *opaque, const char *name, const char *value,
178 Object *obj = opaque;
181 if (strcmp(name, "driver") == 0)
183 if (strcmp(name, "bus") == 0)
186 object_property_parse(obj, value, name, &err);
188 error_propagate(errp, err);
194 static const char *find_typename_by_alias(const char *alias)
198 for (i = 0; qdev_alias_table[i].alias; i++) {
199 if (qdev_alias_table[i].arch_mask &&
200 !(qdev_alias_table[i].arch_mask & arch_type)) {
204 if (strcmp(qdev_alias_table[i].alias, alias) == 0) {
205 return qdev_alias_table[i].typename;
212 static DeviceClass *qdev_get_device_class(const char **driver, Error **errp)
216 const char *original_name = *driver;
218 oc = object_class_by_name(*driver);
220 const char *typename = find_typename_by_alias(*driver);
224 oc = object_class_by_name(*driver);
228 if (!object_class_dynamic_cast(oc, TYPE_DEVICE)) {
229 if (*driver != original_name) {
230 error_setg(errp, "'%s' (alias '%s') is not a valid device model"
231 " name", original_name, *driver);
233 error_setg(errp, "'%s' is not a valid device model name", *driver);
238 if (object_class_is_abstract(oc)) {
239 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
240 "non-abstract device type");
244 dc = DEVICE_CLASS(oc);
245 if (!dc->user_creatable ||
246 (qdev_hotplug && !dc->hotpluggable)) {
247 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
248 "pluggable device type");
256 int qdev_device_help(QemuOpts *opts)
258 Error *local_err = NULL;
260 DevicePropertyInfoList *prop_list;
261 DevicePropertyInfoList *prop;
263 driver = qemu_opt_get(opts, "driver");
264 if (driver && is_help_option(driver)) {
265 qdev_print_devinfos(false);
269 if (!driver || !qemu_opt_has_help_opt(opts)) {
273 if (!object_class_by_name(driver)) {
274 const char *typename = find_typename_by_alias(driver);
281 prop_list = qmp_device_list_properties(driver, &local_err);
286 for (prop = prop_list; prop; prop = prop->next) {
287 error_printf("%s.%s=%s", driver,
290 if (prop->value->has_description) {
291 error_printf(" (%s)\n", prop->value->description);
297 qapi_free_DevicePropertyInfoList(prop_list);
301 error_report_err(local_err);
305 static Object *qdev_get_peripheral(void)
310 dev = container_get(qdev_get_machine(), "/peripheral");
316 static Object *qdev_get_peripheral_anon(void)
321 dev = container_get(qdev_get_machine(), "/peripheral-anon");
327 static void qbus_list_bus(DeviceState *dev, Error **errp)
330 const char *sep = " ";
332 error_append_hint(errp, "child buses at \"%s\":",
333 dev->id ? dev->id : object_get_typename(OBJECT(dev)));
334 QLIST_FOREACH(child, &dev->child_bus, sibling) {
335 error_append_hint(errp, "%s\"%s\"", sep, child->name);
338 error_append_hint(errp, "\n");
341 static void qbus_list_dev(BusState *bus, Error **errp)
344 const char *sep = " ";
346 error_append_hint(errp, "devices at \"%s\":", bus->name);
347 QTAILQ_FOREACH(kid, &bus->children, sibling) {
348 DeviceState *dev = kid->child;
349 error_append_hint(errp, "%s\"%s\"", sep,
350 object_get_typename(OBJECT(dev)));
352 error_append_hint(errp, "/\"%s\"", dev->id);
356 error_append_hint(errp, "\n");
359 static BusState *qbus_find_bus(DeviceState *dev, char *elem)
363 QLIST_FOREACH(child, &dev->child_bus, sibling) {
364 if (strcmp(child->name, elem) == 0) {
371 static DeviceState *qbus_find_dev(BusState *bus, char *elem)
376 * try to match in order:
377 * (1) instance id, if present
379 * (3) driver alias, if present
381 QTAILQ_FOREACH(kid, &bus->children, sibling) {
382 DeviceState *dev = kid->child;
383 if (dev->id && strcmp(dev->id, elem) == 0) {
387 QTAILQ_FOREACH(kid, &bus->children, sibling) {
388 DeviceState *dev = kid->child;
389 if (strcmp(object_get_typename(OBJECT(dev)), elem) == 0) {
393 QTAILQ_FOREACH(kid, &bus->children, sibling) {
394 DeviceState *dev = kid->child;
395 DeviceClass *dc = DEVICE_GET_CLASS(dev);
397 if (qdev_class_has_alias(dc) &&
398 strcmp(qdev_class_get_alias(dc), elem) == 0) {
405 static inline bool qbus_is_full(BusState *bus)
407 BusClass *bus_class = BUS_GET_CLASS(bus);
408 return bus_class->max_dev && bus->max_index >= bus_class->max_dev;
412 * Search the tree rooted at @bus for a bus.
413 * If @name, search for a bus with that name. Note that bus names
414 * need not be unique. Yes, that's screwed up.
415 * Else search for a bus that is a subtype of @bus_typename.
416 * If more than one exists, prefer one that can take another device.
417 * Return the bus if found, else %NULL.
419 static BusState *qbus_find_recursive(BusState *bus, const char *name,
420 const char *bus_typename)
423 BusState *pick, *child, *ret;
426 assert(name || bus_typename);
428 match = !strcmp(bus->name, name);
430 match = !!object_dynamic_cast(OBJECT(bus), bus_typename);
433 if (match && !qbus_is_full(bus)) {
434 return bus; /* root matches and isn't full */
437 pick = match ? bus : NULL;
439 QTAILQ_FOREACH(kid, &bus->children, sibling) {
440 DeviceState *dev = kid->child;
441 QLIST_FOREACH(child, &dev->child_bus, sibling) {
442 ret = qbus_find_recursive(child, name, bus_typename);
443 if (ret && !qbus_is_full(ret)) {
444 return ret; /* a descendant matches and isn't full */
452 /* root or a descendant matches, but is full */
456 static BusState *qbus_find(const char *path, Error **errp)
463 /* find start element */
464 if (path[0] == '/') {
465 bus = sysbus_get_default();
468 if (sscanf(path, "%127[^/]%n", elem, &len) != 1) {
472 bus = qbus_find_recursive(sysbus_get_default(), elem, NULL);
474 error_setg(errp, "Bus '%s' not found", elem);
481 assert(path[pos] == '/' || !path[pos]);
482 while (path[pos] == '/') {
485 if (path[pos] == '\0') {
490 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
491 g_assert_not_reached();
495 dev = qbus_find_dev(bus, elem);
497 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
498 "Device '%s' not found", elem);
499 qbus_list_dev(bus, errp);
503 assert(path[pos] == '/' || !path[pos]);
504 while (path[pos] == '/') {
507 if (path[pos] == '\0') {
508 /* last specified element is a device. If it has exactly
509 * one child bus accept it nevertheless */
510 if (dev->num_child_bus == 1) {
511 bus = QLIST_FIRST(&dev->child_bus);
514 if (dev->num_child_bus) {
515 error_setg(errp, "Device '%s' has multiple child buses",
517 qbus_list_bus(dev, errp);
519 error_setg(errp, "Device '%s' has no child bus", elem);
525 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
526 g_assert_not_reached();
530 bus = qbus_find_bus(dev, elem);
532 error_setg(errp, "Bus '%s' not found", elem);
533 qbus_list_bus(dev, errp);
538 if (qbus_is_full(bus)) {
539 error_setg(errp, "Bus '%s' is full", path);
545 void qdev_set_id(DeviceState *dev, const char *id)
552 object_property_add_child(qdev_get_peripheral(), dev->id,
555 static int anon_count;
556 gchar *name = g_strdup_printf("device[%d]", anon_count++);
557 object_property_add_child(qdev_get_peripheral_anon(), name,
563 DeviceState *qdev_device_add(QemuOpts *opts, Error **errp)
566 const char *driver, *path;
568 BusState *bus = NULL;
571 driver = qemu_opt_get(opts, "driver");
573 error_setg(errp, QERR_MISSING_PARAMETER, "driver");
578 dc = qdev_get_device_class(&driver, errp);
584 path = qemu_opt_get(opts, "bus");
586 bus = qbus_find(path, errp);
590 if (!object_dynamic_cast(OBJECT(bus), dc->bus_type)) {
591 error_setg(errp, "Device '%s' can't go on %s bus",
592 driver, object_get_typename(OBJECT(bus)));
595 } else if (dc->bus_type != NULL) {
596 bus = qbus_find_recursive(sysbus_get_default(), NULL, dc->bus_type);
597 if (!bus || qbus_is_full(bus)) {
598 error_setg(errp, "No '%s' bus found for device '%s'",
599 dc->bus_type, driver);
603 if (qdev_hotplug && bus && !qbus_is_hotpluggable(bus)) {
604 error_setg(errp, QERR_BUS_NO_HOTPLUG, bus->name);
608 if (!migration_is_idle()) {
609 error_setg(errp, "device_add not allowed while migrating");
614 dev = DEVICE(object_new(driver));
617 qdev_set_parent_bus(dev, bus);
618 } else if (qdev_hotplug && !qdev_get_machine_hotplug_handler(dev)) {
619 /* No bus, no machine hotplug handler --> device is not hotpluggable */
620 error_setg(&err, "Device '%s' can not be hotplugged on this machine",
625 qdev_set_id(dev, qemu_opts_id(opts));
628 if (qemu_opt_foreach(opts, set_property, dev, &err)) {
633 object_property_set_bool(OBJECT(dev), true, "realized", &err);
641 error_propagate(errp, err);
642 object_unparent(OBJECT(dev));
643 object_unref(OBJECT(dev));
648 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
649 static void qbus_print(Monitor *mon, BusState *bus, int indent);
651 static void qdev_print_props(Monitor *mon, DeviceState *dev, Property *props,
656 for (; props->name; props++) {
659 char *legacy_name = g_strdup_printf("legacy-%s", props->name);
660 if (object_property_get_type(OBJECT(dev), legacy_name, NULL)) {
661 value = object_property_get_str(OBJECT(dev), legacy_name, &err);
663 value = object_property_print(OBJECT(dev), props->name, true, &err);
671 qdev_printf("%s = %s\n", props->name,
672 value && *value ? value : "<null>");
677 static void bus_print_dev(BusState *bus, Monitor *mon, DeviceState *dev, int indent)
679 BusClass *bc = BUS_GET_CLASS(bus);
682 bc->print_dev(mon, dev, indent);
686 static void qdev_print(Monitor *mon, DeviceState *dev, int indent)
692 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev)),
693 dev->id ? dev->id : "");
695 QLIST_FOREACH(ngl, &dev->gpios, node) {
697 qdev_printf("gpio-in \"%s\" %d\n", ngl->name ? ngl->name : "",
701 qdev_printf("gpio-out \"%s\" %d\n", ngl->name ? ngl->name : "",
705 class = object_get_class(OBJECT(dev));
707 qdev_print_props(mon, dev, DEVICE_CLASS(class)->props, indent);
708 class = object_class_get_parent(class);
709 } while (class != object_class_by_name(TYPE_DEVICE));
710 bus_print_dev(dev->parent_bus, mon, dev, indent);
711 QLIST_FOREACH(child, &dev->child_bus, sibling) {
712 qbus_print(mon, child, indent);
716 static void qbus_print(Monitor *mon, BusState *bus, int indent)
720 qdev_printf("bus: %s\n", bus->name);
722 qdev_printf("type %s\n", object_get_typename(OBJECT(bus)));
723 QTAILQ_FOREACH(kid, &bus->children, sibling) {
724 DeviceState *dev = kid->child;
725 qdev_print(mon, dev, indent);
730 void hmp_info_qtree(Monitor *mon, const QDict *qdict)
732 if (sysbus_get_default())
733 qbus_print(mon, sysbus_get_default(), 0);
736 void hmp_info_qdm(Monitor *mon, const QDict *qdict)
738 qdev_print_devinfos(true);
741 typedef struct QOMCompositionState {
744 } QOMCompositionState;
746 static void print_qom_composition(Monitor *mon, Object *obj, int indent);
748 static int print_qom_composition_child(Object *obj, void *opaque)
750 QOMCompositionState *s = opaque;
752 print_qom_composition(s->mon, obj, s->indent);
757 static void print_qom_composition(Monitor *mon, Object *obj, int indent)
759 QOMCompositionState s = {
761 .indent = indent + 2,
765 if (obj == object_get_root()) {
768 name = object_get_canonical_path_component(obj);
770 monitor_printf(mon, "%*s/%s (%s)\n", indent, "", name,
771 object_get_typename(obj));
773 object_child_foreach(obj, print_qom_composition_child, &s);
776 void hmp_info_qom_tree(Monitor *mon, const QDict *dict)
778 const char *path = qdict_get_try_str(dict, "path");
780 bool ambiguous = false;
783 obj = object_resolve_path(path, &ambiguous);
785 monitor_printf(mon, "Path '%s' could not be resolved.\n", path);
789 monitor_printf(mon, "Warning: Path '%s' is ambiguous.\n", path);
793 obj = qdev_get_machine();
795 print_qom_composition(mon, obj, 0);
798 void qmp_device_add(QDict *qdict, QObject **ret_data, Error **errp)
800 Error *local_err = NULL;
804 opts = qemu_opts_from_qdict(qemu_find_opts("device"), qdict, &local_err);
806 error_propagate(errp, local_err);
809 if (!monitor_cur_is_qmp() && qdev_device_help(opts)) {
813 dev = qdev_device_add(opts, &local_err);
815 error_propagate(errp, local_err);
819 object_unref(OBJECT(dev));
822 static DeviceState *find_device_state(const char *id, Error **errp)
827 obj = object_resolve_path(id, NULL);
829 char *root_path = object_get_canonical_path(qdev_get_peripheral());
830 char *path = g_strdup_printf("%s/%s", root_path, id);
833 obj = object_resolve_path_type(path, TYPE_DEVICE, NULL);
838 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
839 "Device '%s' not found", id);
843 if (!object_dynamic_cast(obj, TYPE_DEVICE)) {
844 error_setg(errp, "%s is not a hotpluggable device", id);
851 void qdev_unplug(DeviceState *dev, Error **errp)
853 DeviceClass *dc = DEVICE_GET_CLASS(dev);
854 HotplugHandler *hotplug_ctrl;
855 HotplugHandlerClass *hdc;
857 if (dev->parent_bus && !qbus_is_hotpluggable(dev->parent_bus)) {
858 error_setg(errp, QERR_BUS_NO_HOTPLUG, dev->parent_bus->name);
862 if (!dc->hotpluggable) {
863 error_setg(errp, QERR_DEVICE_NO_HOTPLUG,
864 object_get_typename(OBJECT(dev)));
868 if (!migration_is_idle()) {
869 error_setg(errp, "device_del not allowed while migrating");
873 qdev_hot_removed = true;
875 hotplug_ctrl = qdev_get_hotplug_handler(dev);
876 /* hotpluggable device MUST have HotplugHandler, if it doesn't
877 * then something is very wrong with it */
878 g_assert(hotplug_ctrl);
880 /* If device supports async unplug just request it to be done,
881 * otherwise just remove it synchronously */
882 hdc = HOTPLUG_HANDLER_GET_CLASS(hotplug_ctrl);
883 if (hdc->unplug_request) {
884 hotplug_handler_unplug_request(hotplug_ctrl, dev, errp);
886 hotplug_handler_unplug(hotplug_ctrl, dev, errp);
890 void qmp_device_del(const char *id, Error **errp)
892 DeviceState *dev = find_device_state(id, errp);
894 qdev_unplug(dev, errp);
898 BlockBackend *blk_by_qdev_id(const char *id, Error **errp)
903 dev = find_device_state(id, errp);
908 blk = blk_by_dev(dev);
910 error_setg(errp, "Device does not have a block device backend");
915 void qdev_machine_init(void)
917 qdev_get_peripheral_anon();
918 qdev_get_peripheral();
921 QemuOptsList qemu_device_opts = {
923 .implied_opt_name = "driver",
924 .head = QTAILQ_HEAD_INITIALIZER(qemu_device_opts.head),
927 * no elements => accept any
928 * sanity checking will happen later
929 * when setting device properties
931 { /* end of list */ }
935 QemuOptsList qemu_global_opts = {
937 .head = QTAILQ_HEAD_INITIALIZER(qemu_global_opts.head),
941 .type = QEMU_OPT_STRING,
944 .type = QEMU_OPT_STRING,
947 .type = QEMU_OPT_STRING,
949 { /* end of list */ }
953 int qemu_global_option(const char *str)
955 char driver[64], property[64];
959 rc = sscanf(str, "%63[^.=].%63[^=]%n", driver, property, &offset);
960 if (rc == 2 && str[offset] == '=') {
961 opts = qemu_opts_create(&qemu_global_opts, NULL, 0, &error_abort);
962 qemu_opt_set(opts, "driver", driver, &error_abort);
963 qemu_opt_set(opts, "property", property, &error_abort);
964 qemu_opt_set(opts, "value", str + offset + 1, &error_abort);
968 opts = qemu_opts_parse_noisily(&qemu_global_opts, str, false);