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 /* Please keep this table sorted by typename. */
43 static const QDevAlias qdev_alias_table
[] = {
44 { "e1000", "e1000-82540em" },
45 { "ich9-ahci", "ahci" },
46 { "kvm-pci-assign", "pci-assign" },
47 { "lsi53c895a", "lsi" },
48 { "virtio-9p-ccw", "virtio-9p", QEMU_ARCH_S390X
},
49 { "virtio-9p-pci", "virtio-9p", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
50 { "virtio-balloon-ccw", "virtio-balloon", QEMU_ARCH_S390X
},
51 { "virtio-balloon-pci", "virtio-balloon",
52 QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
53 { "virtio-blk-ccw", "virtio-blk", QEMU_ARCH_S390X
},
54 { "virtio-blk-pci", "virtio-blk", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
55 { "virtio-gpu-ccw", "virtio-gpu", QEMU_ARCH_S390X
},
56 { "virtio-gpu-pci", "virtio-gpu", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
57 { "virtio-input-host-ccw", "virtio-input-host", QEMU_ARCH_S390X
},
58 { "virtio-input-host-pci", "virtio-input-host",
59 QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
60 { "virtio-keyboard-ccw", "virtio-keyboard", QEMU_ARCH_S390X
},
61 { "virtio-keyboard-pci", "virtio-keyboard",
62 QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
63 { "virtio-mouse-ccw", "virtio-mouse", QEMU_ARCH_S390X
},
64 { "virtio-mouse-pci", "virtio-mouse", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
65 { "virtio-net-ccw", "virtio-net", QEMU_ARCH_S390X
},
66 { "virtio-net-pci", "virtio-net", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
67 { "virtio-rng-ccw", "virtio-rng", QEMU_ARCH_S390X
},
68 { "virtio-rng-pci", "virtio-rng", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
69 { "virtio-scsi-ccw", "virtio-scsi", QEMU_ARCH_S390X
},
70 { "virtio-scsi-pci", "virtio-scsi", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
71 { "virtio-serial-ccw", "virtio-serial", QEMU_ARCH_S390X
},
72 { "virtio-serial-pci", "virtio-serial", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
73 { "virtio-tablet-ccw", "virtio-tablet", QEMU_ARCH_S390X
},
74 { "virtio-tablet-pci", "virtio-tablet", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
78 static const char *qdev_class_get_alias(DeviceClass
*dc
)
80 const char *typename
= object_class_get_name(OBJECT_CLASS(dc
));
83 for (i
= 0; qdev_alias_table
[i
].typename
; i
++) {
84 if (qdev_alias_table
[i
].arch_mask
&&
85 !(qdev_alias_table
[i
].arch_mask
& arch_type
)) {
89 if (strcmp(qdev_alias_table
[i
].typename
, typename
) == 0) {
90 return qdev_alias_table
[i
].alias
;
97 static bool qdev_class_has_alias(DeviceClass
*dc
)
99 return (qdev_class_get_alias(dc
) != NULL
);
102 static void qdev_print_devinfo(DeviceClass
*dc
)
104 error_printf("name \"%s\"", object_class_get_name(OBJECT_CLASS(dc
)));
106 error_printf(", bus %s", dc
->bus_type
);
108 if (qdev_class_has_alias(dc
)) {
109 error_printf(", alias \"%s\"", qdev_class_get_alias(dc
));
112 error_printf(", desc \"%s\"", dc
->desc
);
114 if (dc
->cannot_instantiate_with_device_add_yet
) {
115 error_printf(", no-user");
120 static gint
devinfo_cmp(gconstpointer a
, gconstpointer b
)
122 return strcasecmp(object_class_get_name((ObjectClass
*)a
),
123 object_class_get_name((ObjectClass
*)b
));
126 static void qdev_print_devinfos(bool show_no_user
)
128 static const char *cat_name
[DEVICE_CATEGORY_MAX
+ 1] = {
129 [DEVICE_CATEGORY_BRIDGE
] = "Controller/Bridge/Hub",
130 [DEVICE_CATEGORY_USB
] = "USB",
131 [DEVICE_CATEGORY_STORAGE
] = "Storage",
132 [DEVICE_CATEGORY_NETWORK
] = "Network",
133 [DEVICE_CATEGORY_INPUT
] = "Input",
134 [DEVICE_CATEGORY_DISPLAY
] = "Display",
135 [DEVICE_CATEGORY_SOUND
] = "Sound",
136 [DEVICE_CATEGORY_MISC
] = "Misc",
137 [DEVICE_CATEGORY_MAX
] = "Uncategorized",
143 list
= g_slist_sort(object_class_get_list(TYPE_DEVICE
, false),
146 for (i
= 0; i
<= DEVICE_CATEGORY_MAX
; i
++) {
148 for (elt
= list
; elt
; elt
= elt
->next
) {
149 DeviceClass
*dc
= OBJECT_CLASS_CHECK(DeviceClass
, elt
->data
,
151 if ((i
< DEVICE_CATEGORY_MAX
152 ? !test_bit(i
, dc
->categories
)
153 : !bitmap_empty(dc
->categories
, DEVICE_CATEGORY_MAX
))
155 && dc
->cannot_instantiate_with_device_add_yet
)) {
159 error_printf("%s%s devices:\n", i
? "\n" : "",
163 qdev_print_devinfo(dc
);
170 static int set_property(void *opaque
, const char *name
, const char *value
,
173 Object
*obj
= opaque
;
176 if (strcmp(name
, "driver") == 0)
178 if (strcmp(name
, "bus") == 0)
181 object_property_parse(obj
, value
, name
, &err
);
183 error_propagate(errp
, err
);
189 static const char *find_typename_by_alias(const char *alias
)
193 for (i
= 0; qdev_alias_table
[i
].alias
; i
++) {
194 if (qdev_alias_table
[i
].arch_mask
&&
195 !(qdev_alias_table
[i
].arch_mask
& arch_type
)) {
199 if (strcmp(qdev_alias_table
[i
].alias
, alias
) == 0) {
200 return qdev_alias_table
[i
].typename
;
207 static DeviceClass
*qdev_get_device_class(const char **driver
, Error
**errp
)
211 const char *original_name
= *driver
;
213 oc
= object_class_by_name(*driver
);
215 const char *typename
= find_typename_by_alias(*driver
);
219 oc
= object_class_by_name(*driver
);
223 if (!object_class_dynamic_cast(oc
, TYPE_DEVICE
)) {
224 if (*driver
!= original_name
) {
225 error_setg(errp
, "'%s' (alias '%s') is not a valid device model"
226 " name", original_name
, *driver
);
228 error_setg(errp
, "'%s' is not a valid device model name", *driver
);
233 if (object_class_is_abstract(oc
)) {
234 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "driver",
235 "non-abstract device type");
239 dc
= DEVICE_CLASS(oc
);
240 if (dc
->cannot_instantiate_with_device_add_yet
||
241 (qdev_hotplug
&& !dc
->hotpluggable
)) {
242 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "driver",
243 "pluggable device type");
251 int qdev_device_help(QemuOpts
*opts
)
253 Error
*local_err
= NULL
;
255 DevicePropertyInfoList
*prop_list
;
256 DevicePropertyInfoList
*prop
;
258 driver
= qemu_opt_get(opts
, "driver");
259 if (driver
&& is_help_option(driver
)) {
260 qdev_print_devinfos(false);
264 if (!driver
|| !qemu_opt_has_help_opt(opts
)) {
268 if (!object_class_by_name(driver
)) {
269 const char *typename
= find_typename_by_alias(driver
);
276 prop_list
= qmp_device_list_properties(driver
, &local_err
);
281 for (prop
= prop_list
; prop
; prop
= prop
->next
) {
282 error_printf("%s.%s=%s", driver
,
285 if (prop
->value
->has_description
) {
286 error_printf(" (%s)\n", prop
->value
->description
);
292 qapi_free_DevicePropertyInfoList(prop_list
);
296 error_report_err(local_err
);
300 static Object
*qdev_get_peripheral(void)
305 dev
= container_get(qdev_get_machine(), "/peripheral");
311 static Object
*qdev_get_peripheral_anon(void)
316 dev
= container_get(qdev_get_machine(), "/peripheral-anon");
322 static void qbus_list_bus(DeviceState
*dev
, Error
**errp
)
325 const char *sep
= " ";
327 error_append_hint(errp
, "child buses at \"%s\":",
328 dev
->id
? dev
->id
: object_get_typename(OBJECT(dev
)));
329 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
330 error_append_hint(errp
, "%s\"%s\"", sep
, child
->name
);
333 error_append_hint(errp
, "\n");
336 static void qbus_list_dev(BusState
*bus
, Error
**errp
)
339 const char *sep
= " ";
341 error_append_hint(errp
, "devices at \"%s\":", bus
->name
);
342 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
343 DeviceState
*dev
= kid
->child
;
344 error_append_hint(errp
, "%s\"%s\"", sep
,
345 object_get_typename(OBJECT(dev
)));
347 error_append_hint(errp
, "/\"%s\"", dev
->id
);
351 error_append_hint(errp
, "\n");
354 static BusState
*qbus_find_bus(DeviceState
*dev
, char *elem
)
358 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
359 if (strcmp(child
->name
, elem
) == 0) {
366 static DeviceState
*qbus_find_dev(BusState
*bus
, char *elem
)
371 * try to match in order:
372 * (1) instance id, if present
374 * (3) driver alias, if present
376 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
377 DeviceState
*dev
= kid
->child
;
378 if (dev
->id
&& strcmp(dev
->id
, elem
) == 0) {
382 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
383 DeviceState
*dev
= kid
->child
;
384 if (strcmp(object_get_typename(OBJECT(dev
)), elem
) == 0) {
388 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
389 DeviceState
*dev
= kid
->child
;
390 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
392 if (qdev_class_has_alias(dc
) &&
393 strcmp(qdev_class_get_alias(dc
), elem
) == 0) {
400 static inline bool qbus_is_full(BusState
*bus
)
402 BusClass
*bus_class
= BUS_GET_CLASS(bus
);
403 return bus_class
->max_dev
&& bus
->max_index
>= bus_class
->max_dev
;
407 * Search the tree rooted at @bus for a bus.
408 * If @name, search for a bus with that name. Note that bus names
409 * need not be unique. Yes, that's screwed up.
410 * Else search for a bus that is a subtype of @bus_typename.
411 * If more than one exists, prefer one that can take another device.
412 * Return the bus if found, else %NULL.
414 static BusState
*qbus_find_recursive(BusState
*bus
, const char *name
,
415 const char *bus_typename
)
418 BusState
*pick
, *child
, *ret
;
421 assert(name
|| bus_typename
);
423 match
= !strcmp(bus
->name
, name
);
425 match
= !!object_dynamic_cast(OBJECT(bus
), bus_typename
);
428 if (match
&& !qbus_is_full(bus
)) {
429 return bus
; /* root matches and isn't full */
432 pick
= match
? bus
: NULL
;
434 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
435 DeviceState
*dev
= kid
->child
;
436 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
437 ret
= qbus_find_recursive(child
, name
, bus_typename
);
438 if (ret
&& !qbus_is_full(ret
)) {
439 return ret
; /* a descendant matches and isn't full */
447 /* root or a descendant matches, but is full */
451 static BusState
*qbus_find(const char *path
, Error
**errp
)
458 /* find start element */
459 if (path
[0] == '/') {
460 bus
= sysbus_get_default();
463 if (sscanf(path
, "%127[^/]%n", elem
, &len
) != 1) {
467 bus
= qbus_find_recursive(sysbus_get_default(), elem
, NULL
);
469 error_setg(errp
, "Bus '%s' not found", elem
);
476 assert(path
[pos
] == '/' || !path
[pos
]);
477 while (path
[pos
] == '/') {
480 if (path
[pos
] == '\0') {
485 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
486 g_assert_not_reached();
490 dev
= qbus_find_dev(bus
, elem
);
492 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
493 "Device '%s' not found", elem
);
494 qbus_list_dev(bus
, errp
);
498 assert(path
[pos
] == '/' || !path
[pos
]);
499 while (path
[pos
] == '/') {
502 if (path
[pos
] == '\0') {
503 /* last specified element is a device. If it has exactly
504 * one child bus accept it nevertheless */
505 if (dev
->num_child_bus
== 1) {
506 bus
= QLIST_FIRST(&dev
->child_bus
);
509 if (dev
->num_child_bus
) {
510 error_setg(errp
, "Device '%s' has multiple child buses",
512 qbus_list_bus(dev
, errp
);
514 error_setg(errp
, "Device '%s' has no child bus", elem
);
520 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
521 g_assert_not_reached();
525 bus
= qbus_find_bus(dev
, elem
);
527 error_setg(errp
, "Bus '%s' not found", elem
);
528 qbus_list_bus(dev
, errp
);
533 if (qbus_is_full(bus
)) {
534 error_setg(errp
, "Bus '%s' is full", path
);
540 DeviceState
*qdev_device_add(QemuOpts
*opts
, Error
**errp
)
543 const char *driver
, *path
, *id
;
545 BusState
*bus
= NULL
;
548 driver
= qemu_opt_get(opts
, "driver");
550 error_setg(errp
, QERR_MISSING_PARAMETER
, "driver");
555 dc
= qdev_get_device_class(&driver
, errp
);
561 path
= qemu_opt_get(opts
, "bus");
563 bus
= qbus_find(path
, errp
);
567 if (!object_dynamic_cast(OBJECT(bus
), dc
->bus_type
)) {
568 error_setg(errp
, "Device '%s' can't go on %s bus",
569 driver
, object_get_typename(OBJECT(bus
)));
572 } else if (dc
->bus_type
!= NULL
) {
573 bus
= qbus_find_recursive(sysbus_get_default(), NULL
, dc
->bus_type
);
574 if (!bus
|| qbus_is_full(bus
)) {
575 error_setg(errp
, "No '%s' bus found for device '%s'",
576 dc
->bus_type
, driver
);
580 if (qdev_hotplug
&& bus
&& !qbus_is_hotpluggable(bus
)) {
581 error_setg(errp
, QERR_BUS_NO_HOTPLUG
, bus
->name
);
586 dev
= DEVICE(object_new(driver
));
589 qdev_set_parent_bus(dev
, bus
);
592 id
= qemu_opts_id(opts
);
598 object_property_add_child(qdev_get_peripheral(), dev
->id
,
601 static int anon_count
;
602 gchar
*name
= g_strdup_printf("device[%d]", anon_count
++);
603 object_property_add_child(qdev_get_peripheral_anon(), name
,
609 if (qemu_opt_foreach(opts
, set_property
, dev
, &err
)) {
610 error_propagate(errp
, err
);
611 object_unparent(OBJECT(dev
));
612 object_unref(OBJECT(dev
));
617 object_property_set_bool(OBJECT(dev
), true, "realized", &err
);
619 error_propagate(errp
, err
);
621 object_unparent(OBJECT(dev
));
622 object_unref(OBJECT(dev
));
629 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
630 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
);
632 static void qdev_print_props(Monitor
*mon
, DeviceState
*dev
, Property
*props
,
637 for (; props
->name
; props
++) {
640 char *legacy_name
= g_strdup_printf("legacy-%s", props
->name
);
641 if (object_property_get_type(OBJECT(dev
), legacy_name
, NULL
)) {
642 value
= object_property_get_str(OBJECT(dev
), legacy_name
, &err
);
644 value
= object_property_print(OBJECT(dev
), props
->name
, true, &err
);
652 qdev_printf("%s = %s\n", props
->name
,
653 value
&& *value
? value
: "<null>");
658 static void bus_print_dev(BusState
*bus
, Monitor
*mon
, DeviceState
*dev
, int indent
)
660 BusClass
*bc
= BUS_GET_CLASS(bus
);
663 bc
->print_dev(mon
, dev
, indent
);
667 static void qdev_print(Monitor
*mon
, DeviceState
*dev
, int indent
)
673 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev
)),
674 dev
->id
? dev
->id
: "");
676 QLIST_FOREACH(ngl
, &dev
->gpios
, node
) {
678 qdev_printf("gpio-in \"%s\" %d\n", ngl
->name
? ngl
->name
: "",
682 qdev_printf("gpio-out \"%s\" %d\n", ngl
->name
? ngl
->name
: "",
686 class = object_get_class(OBJECT(dev
));
688 qdev_print_props(mon
, dev
, DEVICE_CLASS(class)->props
, indent
);
689 class = object_class_get_parent(class);
690 } while (class != object_class_by_name(TYPE_DEVICE
));
691 bus_print_dev(dev
->parent_bus
, mon
, dev
, indent
);
692 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
693 qbus_print(mon
, child
, indent
);
697 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
)
701 qdev_printf("bus: %s\n", bus
->name
);
703 qdev_printf("type %s\n", object_get_typename(OBJECT(bus
)));
704 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
705 DeviceState
*dev
= kid
->child
;
706 qdev_print(mon
, dev
, indent
);
711 void hmp_info_qtree(Monitor
*mon
, const QDict
*qdict
)
713 if (sysbus_get_default())
714 qbus_print(mon
, sysbus_get_default(), 0);
717 void hmp_info_qdm(Monitor
*mon
, const QDict
*qdict
)
719 qdev_print_devinfos(true);
722 typedef struct QOMCompositionState
{
725 } QOMCompositionState
;
727 static void print_qom_composition(Monitor
*mon
, Object
*obj
, int indent
);
729 static int print_qom_composition_child(Object
*obj
, void *opaque
)
731 QOMCompositionState
*s
= opaque
;
733 print_qom_composition(s
->mon
, obj
, s
->indent
);
738 static void print_qom_composition(Monitor
*mon
, Object
*obj
, int indent
)
740 QOMCompositionState s
= {
742 .indent
= indent
+ 2,
746 if (obj
== object_get_root()) {
749 name
= object_get_canonical_path_component(obj
);
751 monitor_printf(mon
, "%*s/%s (%s)\n", indent
, "", name
,
752 object_get_typename(obj
));
754 object_child_foreach(obj
, print_qom_composition_child
, &s
);
757 void hmp_info_qom_tree(Monitor
*mon
, const QDict
*dict
)
759 const char *path
= qdict_get_try_str(dict
, "path");
761 bool ambiguous
= false;
764 obj
= object_resolve_path(path
, &ambiguous
);
766 monitor_printf(mon
, "Path '%s' could not be resolved.\n", path
);
770 monitor_printf(mon
, "Warning: Path '%s' is ambiguous.\n", path
);
774 obj
= qdev_get_machine();
776 print_qom_composition(mon
, obj
, 0);
779 void qmp_device_add(QDict
*qdict
, QObject
**ret_data
, Error
**errp
)
781 Error
*local_err
= NULL
;
785 opts
= qemu_opts_from_qdict(qemu_find_opts("device"), qdict
, &local_err
);
787 error_propagate(errp
, local_err
);
790 if (!monitor_cur_is_qmp() && qdev_device_help(opts
)) {
794 dev
= qdev_device_add(opts
, &local_err
);
796 error_propagate(errp
, local_err
);
800 object_unref(OBJECT(dev
));
803 void qmp_device_del(const char *id
, Error
**errp
)
808 obj
= object_resolve_path(id
, NULL
);
810 char *root_path
= object_get_canonical_path(qdev_get_peripheral());
811 char *path
= g_strdup_printf("%s/%s", root_path
, id
);
814 obj
= object_resolve_path_type(path
, TYPE_DEVICE
, NULL
);
819 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
820 "Device '%s' not found", id
);
824 if (!object_dynamic_cast(obj
, TYPE_DEVICE
)) {
825 error_setg(errp
, "%s is not a hotpluggable device", id
);
829 qdev_unplug(DEVICE(obj
), errp
);
832 void qdev_machine_init(void)
834 qdev_get_peripheral_anon();
835 qdev_get_peripheral();
838 QemuOptsList qemu_device_opts
= {
840 .implied_opt_name
= "driver",
841 .head
= QTAILQ_HEAD_INITIALIZER(qemu_device_opts
.head
),
844 * no elements => accept any
845 * sanity checking will happen later
846 * when setting device properties
848 { /* end of list */ }
852 QemuOptsList qemu_global_opts
= {
854 .head
= QTAILQ_HEAD_INITIALIZER(qemu_global_opts
.head
),
858 .type
= QEMU_OPT_STRING
,
861 .type
= QEMU_OPT_STRING
,
864 .type
= QEMU_OPT_STRING
,
866 { /* end of list */ }
870 int qemu_global_option(const char *str
)
872 char driver
[64], property
[64];
876 rc
= sscanf(str
, "%63[^.=].%63[^=]%n", driver
, property
, &offset
);
877 if (rc
== 2 && str
[offset
] == '=') {
878 opts
= qemu_opts_create(&qemu_global_opts
, NULL
, 0, &error_abort
);
879 qemu_opt_set(opts
, "driver", driver
, &error_abort
);
880 qemu_opt_set(opts
, "property", property
, &error_abort
);
881 qemu_opt_set(opts
, "value", str
+ offset
+ 1, &error_abort
);
885 opts
= qemu_opts_parse_noisily(&qemu_global_opts
, str
, false);