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 "qapi/qmp/qerror.h"
27 #include "qemu/config-file.h"
28 #include "qemu/error-report.h"
31 * Aliases were a bad idea from the start. Let's keep them
32 * from spreading further.
34 typedef struct QDevAlias
41 static const QDevAlias qdev_alias_table
[] = {
42 { "virtio-blk-pci", "virtio-blk", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
43 { "virtio-net-pci", "virtio-net", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
44 { "virtio-serial-pci", "virtio-serial", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
45 { "virtio-balloon-pci", "virtio-balloon",
46 QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
47 { "virtio-blk-ccw", "virtio-blk", QEMU_ARCH_S390X
},
48 { "virtio-net-ccw", "virtio-net", QEMU_ARCH_S390X
},
49 { "virtio-serial-ccw", "virtio-serial", QEMU_ARCH_S390X
},
50 { "lsi53c895a", "lsi" },
51 { "ich9-ahci", "ahci" },
52 { "kvm-pci-assign", "pci-assign" },
53 { "e1000", "e1000-82540em" },
57 static const char *qdev_class_get_alias(DeviceClass
*dc
)
59 const char *typename
= object_class_get_name(OBJECT_CLASS(dc
));
62 for (i
= 0; qdev_alias_table
[i
].typename
; i
++) {
63 if (qdev_alias_table
[i
].arch_mask
&&
64 !(qdev_alias_table
[i
].arch_mask
& arch_type
)) {
68 if (strcmp(qdev_alias_table
[i
].typename
, typename
) == 0) {
69 return qdev_alias_table
[i
].alias
;
76 static bool qdev_class_has_alias(DeviceClass
*dc
)
78 return (qdev_class_get_alias(dc
) != NULL
);
81 static void qdev_print_devinfo(DeviceClass
*dc
)
83 error_printf("name \"%s\"", object_class_get_name(OBJECT_CLASS(dc
)));
85 error_printf(", bus %s", dc
->bus_type
);
87 if (qdev_class_has_alias(dc
)) {
88 error_printf(", alias \"%s\"", qdev_class_get_alias(dc
));
91 error_printf(", desc \"%s\"", dc
->desc
);
93 if (dc
->cannot_instantiate_with_device_add_yet
) {
94 error_printf(", no-user");
99 static gint
devinfo_cmp(gconstpointer a
, gconstpointer b
)
101 return strcasecmp(object_class_get_name((ObjectClass
*)a
),
102 object_class_get_name((ObjectClass
*)b
));
105 static void qdev_print_devinfos(bool show_no_user
)
107 static const char *cat_name
[DEVICE_CATEGORY_MAX
+ 1] = {
108 [DEVICE_CATEGORY_BRIDGE
] = "Controller/Bridge/Hub",
109 [DEVICE_CATEGORY_USB
] = "USB",
110 [DEVICE_CATEGORY_STORAGE
] = "Storage",
111 [DEVICE_CATEGORY_NETWORK
] = "Network",
112 [DEVICE_CATEGORY_INPUT
] = "Input",
113 [DEVICE_CATEGORY_DISPLAY
] = "Display",
114 [DEVICE_CATEGORY_SOUND
] = "Sound",
115 [DEVICE_CATEGORY_MISC
] = "Misc",
116 [DEVICE_CATEGORY_MAX
] = "Uncategorized",
122 list
= g_slist_sort(object_class_get_list(TYPE_DEVICE
, false),
125 for (i
= 0; i
<= DEVICE_CATEGORY_MAX
; i
++) {
127 for (elt
= list
; elt
; elt
= elt
->next
) {
128 DeviceClass
*dc
= OBJECT_CLASS_CHECK(DeviceClass
, elt
->data
,
130 if ((i
< DEVICE_CATEGORY_MAX
131 ? !test_bit(i
, dc
->categories
)
132 : !bitmap_empty(dc
->categories
, DEVICE_CATEGORY_MAX
))
134 && dc
->cannot_instantiate_with_device_add_yet
)) {
138 error_printf("%s%s devices:\n", i
? "\n" : "",
142 qdev_print_devinfo(dc
);
149 static int set_property(void *opaque
, const char *name
, const char *value
,
152 Object
*obj
= opaque
;
155 if (strcmp(name
, "driver") == 0)
157 if (strcmp(name
, "bus") == 0)
160 object_property_parse(obj
, value
, name
, &err
);
162 error_propagate(errp
, err
);
168 static const char *find_typename_by_alias(const char *alias
)
172 for (i
= 0; qdev_alias_table
[i
].alias
; i
++) {
173 if (qdev_alias_table
[i
].arch_mask
&&
174 !(qdev_alias_table
[i
].arch_mask
& arch_type
)) {
178 if (strcmp(qdev_alias_table
[i
].alias
, alias
) == 0) {
179 return qdev_alias_table
[i
].typename
;
186 static DeviceClass
*qdev_get_device_class(const char **driver
, Error
**errp
)
191 oc
= object_class_by_name(*driver
);
193 const char *typename
= find_typename_by_alias(*driver
);
197 oc
= object_class_by_name(*driver
);
201 if (!object_class_dynamic_cast(oc
, TYPE_DEVICE
)) {
202 error_setg(errp
, "'%s' is not a valid device model name", *driver
);
206 if (object_class_is_abstract(oc
)) {
207 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "driver",
208 "non-abstract device type");
212 dc
= DEVICE_CLASS(oc
);
213 if (dc
->cannot_instantiate_with_device_add_yet
||
214 (qdev_hotplug
&& !dc
->hotpluggable
)) {
215 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "driver",
216 "pluggable device type");
224 int qdev_device_help(QemuOpts
*opts
)
226 Error
*local_err
= NULL
;
228 DevicePropertyInfoList
*prop_list
;
229 DevicePropertyInfoList
*prop
;
231 driver
= qemu_opt_get(opts
, "driver");
232 if (driver
&& is_help_option(driver
)) {
233 qdev_print_devinfos(false);
237 if (!driver
|| !qemu_opt_has_help_opt(opts
)) {
241 qdev_get_device_class(&driver
, &local_err
);
246 prop_list
= qmp_device_list_properties(driver
, &local_err
);
251 for (prop
= prop_list
; prop
; prop
= prop
->next
) {
252 error_printf("%s.%s=%s", driver
,
255 if (prop
->value
->has_description
) {
256 error_printf(" (%s)\n", prop
->value
->description
);
262 qapi_free_DevicePropertyInfoList(prop_list
);
266 error_printf("%s\n", error_get_pretty(local_err
));
267 error_free(local_err
);
271 static Object
*qdev_get_peripheral(void)
276 dev
= container_get(qdev_get_machine(), "/peripheral");
282 static Object
*qdev_get_peripheral_anon(void)
287 dev
= container_get(qdev_get_machine(), "/peripheral-anon");
293 static void qbus_list_bus(DeviceState
*dev
, Error
**errp
)
296 const char *sep
= " ";
298 error_append_hint(errp
, "child buses at \"%s\":",
299 dev
->id
? dev
->id
: object_get_typename(OBJECT(dev
)));
300 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
301 error_append_hint(errp
, "%s\"%s\"", sep
, child
->name
);
306 static void qbus_list_dev(BusState
*bus
, Error
**errp
)
309 const char *sep
= " ";
311 error_append_hint(errp
, "devices at \"%s\":", bus
->name
);
312 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
313 DeviceState
*dev
= kid
->child
;
314 error_append_hint(errp
, "%s\"%s\"", sep
,
315 object_get_typename(OBJECT(dev
)));
317 error_append_hint(errp
, "/\"%s\"", dev
->id
);
323 static BusState
*qbus_find_bus(DeviceState
*dev
, char *elem
)
327 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
328 if (strcmp(child
->name
, elem
) == 0) {
335 static DeviceState
*qbus_find_dev(BusState
*bus
, char *elem
)
340 * try to match in order:
341 * (1) instance id, if present
343 * (3) driver alias, if present
345 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
346 DeviceState
*dev
= kid
->child
;
347 if (dev
->id
&& strcmp(dev
->id
, elem
) == 0) {
351 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
352 DeviceState
*dev
= kid
->child
;
353 if (strcmp(object_get_typename(OBJECT(dev
)), elem
) == 0) {
357 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
358 DeviceState
*dev
= kid
->child
;
359 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
361 if (qdev_class_has_alias(dc
) &&
362 strcmp(qdev_class_get_alias(dc
), elem
) == 0) {
369 static inline bool qbus_is_full(BusState
*bus
)
371 BusClass
*bus_class
= BUS_GET_CLASS(bus
);
372 return bus_class
->max_dev
&& bus
->max_index
>= bus_class
->max_dev
;
376 * Search the tree rooted at @bus for a bus.
377 * If @name, search for a bus with that name. Note that bus names
378 * need not be unique. Yes, that's screwed up.
379 * Else search for a bus that is a subtype of @bus_typename.
380 * If more than one exists, prefer one that can take another device.
381 * Return the bus if found, else %NULL.
383 static BusState
*qbus_find_recursive(BusState
*bus
, const char *name
,
384 const char *bus_typename
)
387 BusState
*pick
, *child
, *ret
;
390 assert(name
|| bus_typename
);
392 match
= !strcmp(bus
->name
, name
);
394 match
= !!object_dynamic_cast(OBJECT(bus
), bus_typename
);
397 if (match
&& !qbus_is_full(bus
)) {
398 return bus
; /* root matches and isn't full */
401 pick
= match
? bus
: NULL
;
403 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
404 DeviceState
*dev
= kid
->child
;
405 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
406 ret
= qbus_find_recursive(child
, name
, bus_typename
);
407 if (ret
&& !qbus_is_full(ret
)) {
408 return ret
; /* a descendant matches and isn't full */
416 /* root or a descendant matches, but is full */
420 static BusState
*qbus_find(const char *path
, Error
**errp
)
427 /* find start element */
428 if (path
[0] == '/') {
429 bus
= sysbus_get_default();
432 if (sscanf(path
, "%127[^/]%n", elem
, &len
) != 1) {
436 bus
= qbus_find_recursive(sysbus_get_default(), elem
, NULL
);
438 error_setg(errp
, "Bus '%s' not found", elem
);
445 assert(path
[pos
] == '/' || !path
[pos
]);
446 while (path
[pos
] == '/') {
449 if (path
[pos
] == '\0') {
454 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
455 g_assert_not_reached();
459 dev
= qbus_find_dev(bus
, elem
);
461 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
462 "Device '%s' not found", elem
);
463 qbus_list_dev(bus
, errp
);
467 assert(path
[pos
] == '/' || !path
[pos
]);
468 while (path
[pos
] == '/') {
471 if (path
[pos
] == '\0') {
472 /* last specified element is a device. If it has exactly
473 * one child bus accept it nevertheless */
474 if (dev
->num_child_bus
== 1) {
475 bus
= QLIST_FIRST(&dev
->child_bus
);
478 if (dev
->num_child_bus
) {
479 error_setg(errp
, "Device '%s' has multiple child buses",
481 qbus_list_bus(dev
, errp
);
483 error_setg(errp
, "Device '%s' has no child bus", elem
);
489 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
490 g_assert_not_reached();
494 bus
= qbus_find_bus(dev
, elem
);
496 error_setg(errp
, "Bus '%s' not found", elem
);
497 qbus_list_bus(dev
, errp
);
502 if (qbus_is_full(bus
)) {
503 error_setg(errp
, "Bus '%s' is full", path
);
509 DeviceState
*qdev_device_add(QemuOpts
*opts
, Error
**errp
)
512 const char *driver
, *path
, *id
;
514 BusState
*bus
= NULL
;
517 driver
= qemu_opt_get(opts
, "driver");
519 error_setg(errp
, QERR_MISSING_PARAMETER
, "driver");
524 dc
= qdev_get_device_class(&driver
, errp
);
530 path
= qemu_opt_get(opts
, "bus");
532 bus
= qbus_find(path
, errp
);
536 if (!object_dynamic_cast(OBJECT(bus
), dc
->bus_type
)) {
537 error_setg(errp
, "Device '%s' can't go on %s bus",
538 driver
, object_get_typename(OBJECT(bus
)));
541 } else if (dc
->bus_type
!= NULL
) {
542 bus
= qbus_find_recursive(sysbus_get_default(), NULL
, dc
->bus_type
);
543 if (!bus
|| qbus_is_full(bus
)) {
544 error_setg(errp
, "No '%s' bus found for device '%s'",
545 dc
->bus_type
, driver
);
549 if (qdev_hotplug
&& bus
&& !qbus_is_hotpluggable(bus
)) {
550 error_setg(errp
, QERR_BUS_NO_HOTPLUG
, bus
->name
);
555 dev
= DEVICE(object_new(driver
));
558 qdev_set_parent_bus(dev
, bus
);
561 id
= qemu_opts_id(opts
);
567 object_property_add_child(qdev_get_peripheral(), dev
->id
,
570 static int anon_count
;
571 gchar
*name
= g_strdup_printf("device[%d]", anon_count
++);
572 object_property_add_child(qdev_get_peripheral_anon(), name
,
578 if (qemu_opt_foreach(opts
, set_property
, dev
, &err
)) {
579 error_propagate(errp
, err
);
580 object_unparent(OBJECT(dev
));
581 object_unref(OBJECT(dev
));
586 object_property_set_bool(OBJECT(dev
), true, "realized", &err
);
588 error_propagate(errp
, err
);
590 object_unparent(OBJECT(dev
));
591 object_unref(OBJECT(dev
));
598 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
599 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
);
601 static void qdev_print_props(Monitor
*mon
, DeviceState
*dev
, Property
*props
,
606 for (; props
->name
; props
++) {
609 char *legacy_name
= g_strdup_printf("legacy-%s", props
->name
);
610 if (object_property_get_type(OBJECT(dev
), legacy_name
, NULL
)) {
611 value
= object_property_get_str(OBJECT(dev
), legacy_name
, &err
);
613 value
= object_property_print(OBJECT(dev
), props
->name
, true, &err
);
621 qdev_printf("%s = %s\n", props
->name
,
622 value
&& *value
? value
: "<null>");
627 static void bus_print_dev(BusState
*bus
, Monitor
*mon
, DeviceState
*dev
, int indent
)
629 BusClass
*bc
= BUS_GET_CLASS(bus
);
632 bc
->print_dev(mon
, dev
, indent
);
636 static void qdev_print(Monitor
*mon
, DeviceState
*dev
, int indent
)
642 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev
)),
643 dev
->id
? dev
->id
: "");
645 QLIST_FOREACH(ngl
, &dev
->gpios
, node
) {
647 qdev_printf("gpio-in \"%s\" %d\n", ngl
->name
? ngl
->name
: "",
651 qdev_printf("gpio-out \"%s\" %d\n", ngl
->name
? ngl
->name
: "",
655 class = object_get_class(OBJECT(dev
));
657 qdev_print_props(mon
, dev
, DEVICE_CLASS(class)->props
, indent
);
658 class = object_class_get_parent(class);
659 } while (class != object_class_by_name(TYPE_DEVICE
));
660 bus_print_dev(dev
->parent_bus
, mon
, dev
, indent
);
661 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
662 qbus_print(mon
, child
, indent
);
666 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
)
670 qdev_printf("bus: %s\n", bus
->name
);
672 qdev_printf("type %s\n", object_get_typename(OBJECT(bus
)));
673 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
674 DeviceState
*dev
= kid
->child
;
675 qdev_print(mon
, dev
, indent
);
680 void hmp_info_qtree(Monitor
*mon
, const QDict
*qdict
)
682 if (sysbus_get_default())
683 qbus_print(mon
, sysbus_get_default(), 0);
686 void hmp_info_qdm(Monitor
*mon
, const QDict
*qdict
)
688 qdev_print_devinfos(true);
691 typedef struct QOMCompositionState
{
694 } QOMCompositionState
;
696 static void print_qom_composition(Monitor
*mon
, Object
*obj
, int indent
);
698 static int print_qom_composition_child(Object
*obj
, void *opaque
)
700 QOMCompositionState
*s
= opaque
;
702 print_qom_composition(s
->mon
, obj
, s
->indent
);
707 static void print_qom_composition(Monitor
*mon
, Object
*obj
, int indent
)
709 QOMCompositionState s
= {
711 .indent
= indent
+ 2,
715 if (obj
== object_get_root()) {
718 name
= object_get_canonical_path_component(obj
);
720 monitor_printf(mon
, "%*s/%s (%s)\n", indent
, "", name
,
721 object_get_typename(obj
));
723 object_child_foreach(obj
, print_qom_composition_child
, &s
);
726 void hmp_info_qom_tree(Monitor
*mon
, const QDict
*dict
)
728 const char *path
= qdict_get_try_str(dict
, "path");
730 bool ambiguous
= false;
733 obj
= object_resolve_path(path
, &ambiguous
);
735 monitor_printf(mon
, "Path '%s' could not be resolved.\n", path
);
739 monitor_printf(mon
, "Warning: Path '%s' is ambiguous.\n", path
);
743 obj
= qdev_get_machine();
745 print_qom_composition(mon
, obj
, 0);
748 void qmp_device_add(QDict
*qdict
, QObject
**ret_data
, Error
**errp
)
750 Error
*local_err
= NULL
;
754 opts
= qemu_opts_from_qdict(qemu_find_opts("device"), qdict
, &local_err
);
756 error_propagate(errp
, local_err
);
759 if (!monitor_cur_is_qmp() && qdev_device_help(opts
)) {
763 dev
= qdev_device_add(opts
, &local_err
);
765 error_propagate(errp
, local_err
);
769 object_unref(OBJECT(dev
));
772 void qmp_device_del(const char *id
, Error
**errp
)
777 obj
= object_resolve_path(id
, NULL
);
779 char *root_path
= object_get_canonical_path(qdev_get_peripheral());
780 char *path
= g_strdup_printf("%s/%s", root_path
, id
);
783 obj
= object_resolve_path_type(path
, TYPE_DEVICE
, NULL
);
788 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
789 "Device '%s' not found", id
);
793 if (!object_dynamic_cast(obj
, TYPE_DEVICE
)) {
794 error_setg(errp
, "%s is not a hotpluggable device", id
);
798 qdev_unplug(DEVICE(obj
), errp
);
801 void qdev_machine_init(void)
803 qdev_get_peripheral_anon();
804 qdev_get_peripheral();
807 QemuOptsList qemu_device_opts
= {
809 .implied_opt_name
= "driver",
810 .head
= QTAILQ_HEAD_INITIALIZER(qemu_device_opts
.head
),
813 * no elements => accept any
814 * sanity checking will happen later
815 * when setting device properties
817 { /* end of list */ }
821 QemuOptsList qemu_global_opts
= {
823 .head
= QTAILQ_HEAD_INITIALIZER(qemu_global_opts
.head
),
827 .type
= QEMU_OPT_STRING
,
830 .type
= QEMU_OPT_STRING
,
833 .type
= QEMU_OPT_STRING
,
835 { /* end of list */ }
839 int qemu_global_option(const char *str
)
841 char driver
[64], property
[64];
845 rc
= sscanf(str
, "%63[^.=].%63[^=]%n", driver
, property
, &offset
);
846 if (rc
== 2 && str
[offset
] == '=') {
847 opts
= qemu_opts_create(&qemu_global_opts
, NULL
, 0, &error_abort
);
848 qemu_opt_set(opts
, "driver", driver
, &error_abort
);
849 qemu_opt_set(opts
, "property", property
, &error_abort
);
850 qemu_opt_set(opts
, "value", str
+ offset
+ 1, &error_abort
);
854 opts
= qemu_opts_parse_noisily(&qemu_global_opts
, str
, false);